Workflow Run - Get

Serviço:

Purview

Versão da API:

2023-10-01-preview

Obtenha uma execução de fluxo de trabalho.

GET {endpoint}/workflow/workflowruns/{workflowRunId}?api-version=2023-10-01-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string (url)	O ponto de extremidade da conta da sua conta Purview. Exemplo: https://{accountName}.purview.azure.com/
workflowRunId	path	True	string (uuid)	A id de execução do fluxo de trabalho.
api-version	query	True	string	Versão das APIs Purview

Respostas

Name	Tipo	Description
200 OK	WorkflowRun	OK
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
https://purview.azure.net/.default	Escopo de autorização padrão.

Exemplos

WorkflowRun_Get

Pedido de amostra

HTTP

GET {endpoint}/workflow/workflowruns/04334a74-3400-11ed-a261-0242ac120002?api-version=2023-10-01-preview

Resposta da amostra

Código de estado:

200

{
  "id": "4f8d70c3-c09b-4e56-bfd1-8b86c79bd4d9",
  "workflowId": "3fb9ba13-bf35-4f29-ab63-70b5234923c2",
  "startTime": "2023-01-12T09:36:11.533263721Z",
  "requestor": "eece94d9-0619-4669-bb8a-d6ecec5220bc",
  "runPayload": {
    "type": "CreateTerm",
    "targetValue": "term123",
    "payload": {
      "glossaryTerm": {
        "name": "term123",
        "anchor": {
          "glossaryGuid": "20031e20-b4df-4a66-a61d-1b0716f3fa48"
        },
        "status": "Approved",
        "nickName": "term123",
        "attributes": {}
      }
    }
  },
  "status": "InProgress",
  "actionDag": {
    "actions": {
      "Start and wait for an approval": {
        "type": "Approval",
        "inputs": {
          "parameters": {
            "approvalType": "PendingOnAll",
            "title": "Approval Request for Create Glossary Term",
            "assignedTo": [
              "eece94d9-0619-4669-bb8a-d6ecec5220bc"
            ],
            "reminderSettings": {
              "interval": "1 day"
            },
            "expirySettings": {
              "expireAfter": "1 month",
              "notifyOnExpiration": []
            }
          }
        },
        "runAfter": {}
      },
      "Condition": {
        "type": "If",
        "expression": {
          "and": [
            {
              "equals": [
                "@outputs('Start and wait for an approval')['body/outcome']",
                "Approved"
              ]
            }
          ]
        },
        "actions": {
          "Create glossary term": {
            "type": "CreateTerm",
            "runAfter": {}
          },
          "Send email notification": {
            "type": "EmailNotification",
            "inputs": {
              "parameters": {
                "emailSubject": "Glossary Term Create - APPROVED",
                "emailMessage": "Your request for Glossary Term @{triggerBody()['request']['term']['name']} is approved.",
                "emailRecipients": [
                  "@{triggerBody()['request']['requestor']}"
                ]
              }
            },
            "runAfter": {
              "Create glossary term": [
                "Succeeded"
              ]
            },
            "runtimeConfiguration": {
              "secureInput": false,
              "secureOutput": false
            }
          }
        },
        "else": {
          "actions": {
            "Send reject email notification": {
              "type": "EmailNotification",
              "inputs": {
                "parameters": {
                  "emailSubject": "Glossary Term Create - REJECTED",
                  "emailMessage": "Your request for Glossary Term @{triggerBody()['request']['term']['name']} is rejected.",
                  "emailRecipients": [
                    "@{triggerBody()['request']['requestor']}"
                  ]
                }
              },
              "runAfter": {},
              "runtimeConfiguration": {
                "secureInput": false,
                "secureOutput": false
              }
            }
          }
        },
        "runAfter": {
          "Start and wait for an approval": [
            "Succeeded"
          ]
        }
      }
    }
  },
  "detail": {
    "runInput": {
      "request": {
        "requestor": "eece94d9-0619-4669-bb8a-d6ecec5220bc",
        "term": {
          "name": "term123",
          "formalName": "term123",
          "definition": null,
          "experts": [],
          "stewards": [],
          "parent": null
        }
      }
    },
    "actions": {
      "Start and wait for an approval": {
        "startTime": "2023-01-12T09:36:12.347229300Z",
        "status": "Running",
        "input": {
          "type": "inlined",
          "parameters": {
            "approvalType": "PendingOnAll",
            "title": "Approval Request for Create Glossary Term",
            "assignedTo": [
              "eece94d9-0619-4669-bb8a-d6ecec5220bc"
            ],
            "reminderSettings": {
              "interval": "1 day"
            },
            "expirySettings": {
              "expireAfter": "1 month",
              "notifyOnExpiration": []
            }
          }
        }
      }
    }
  }
}

Definições

Name	Description
ErrorModel	Modelo de erro padrão
ErrorResponse	Modelo de resposta de erro padrão
RunPayload	A entrada de uma execução de fluxo de trabalho. Alinhe-se com a operação na solicitação do usuário.
UserRequestStatus	O status.
WorkflowRun	A execução de um fluxo de trabalho. Ele inclui a ação de fluxo de trabalho DAG em tempo de execução (ação DAG snapshot), carga útil de execução, status de toda a execução e outras propriedades de uma execução.
WorkflowRunDetail	Ele se refere à propriedade "detail" de um objeto de execução de fluxo de trabalho, que contém informações de contexto de execução e tempo de execução de ações.
WorkflowRunPayloadType	O fluxo de trabalho executa o tipo de carga útil.

ErrorModel

Object

Modelo de erro padrão

Name	Tipo	Description
code	string	Obtém ou define o código.
details	ErrorModel[]	Obtém ou define os detalhes.
message	string	Obtém ou define as mensagens.
target	string	Obtém ou define o alvo.

ErrorResponse

Object

Modelo de resposta de erro padrão

Name	Tipo	Description
error	ErrorModel	Modelo de erro padrão

RunPayload

Object

A entrada de uma execução de fluxo de trabalho. Alinhe-se com a operação na solicitação do usuário.

Name	Tipo	Description
payload	object	A carga útil de cada operação que o usuário deseja enviar.
targetValue	string	O valor de destino que precisa envolver fluxo de trabalho para atualizar.
type	WorkflowRunPayloadType	O fluxo de trabalho executa o tipo de carga útil.

UserRequestStatus

Enumeração

O status.

Valor	Description
NotStarted
InProgress
Failed
Completed
Canceling
CancellationFailed
Canceled

WorkflowRun

Object

A execução de um fluxo de trabalho. Ele inclui a ação de fluxo de trabalho DAG em tempo de execução (ação DAG snapshot), carga útil de execução, status de toda a execução e outras propriedades de uma execução.

Name	Tipo	Description
actionDag	object	A ação DAG (Directed Acyclic Graph), define o fluxo real.
cancelComment	string	O comentário ao cancelar uma execução de fluxo de trabalho.
cancelTime	string (date-time)	O tempo de execução do fluxo de trabalho será cancelado.
detail	WorkflowRunDetail	Ele se refere à propriedade "detail" de um objeto de execução de fluxo de trabalho, que contém informações de contexto de execução e tempo de execução de ações.
endTime	string (date-time)	O tempo de execução do fluxo de trabalho concluído.
id	string (uuid)	A id de execução do fluxo de trabalho.
requestor	string (uuid)	A pessoa que enviou a solicitação do usuário.
runPayload	RunPayload	A entrada de uma execução de fluxo de trabalho. Alinhe-se com a operação na solicitação do usuário.
startTime	string (date-time)	Hora de início da execução do fluxo de trabalho.
status	UserRequestStatus	O status.
userRequestId	string (uuid)	A ID de solicitação do usuário.
workflowId	string (uuid)	A ID do fluxo de trabalho.

WorkflowRunDetail

Object

Ele se refere à propriedade "detail" de um objeto de execução de fluxo de trabalho, que contém informações de contexto de execução e tempo de execução de ações.

Name	Tipo	Description
actions	object
runInput	object	As variáveis incorporadas começam com @runInput. Suas propriedades são determinadas pelo tipo de gatilho no tempo de execução do fluxo de trabalho.

WorkflowRunPayloadType

Enumeração

O fluxo de trabalho executa o tipo de carga útil.

Valor	Description
CreateTerm
UpdateTerm
DeleteTerm
ImportTerms
UpdateAsset
GrantDataAccess