Workflow Run - Get

Usługa:

Purview

Wersja interfejsu API:

2023-10-01-preview

Pobierz przebieg przepływu pracy.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (url)	Punkt końcowy konta konta usługi Purview. Przykład: https://{accountName}.purview.azure.com/
workflowRunId	path	True	string (uuid)	Identyfikator przebiegu przepływu pracy.
api-version	query	True	string	Wersja interfejsów API usługi Purview

Odpowiedzi

Nazwa	Typ	Opis
200 OK	WorkflowRun	OK
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://purview.azure.net/.default	Domyślny zakres autoryzacji.

Przykłady

WorkflowRun_Get

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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": []
            }
          }
        }
      }
    }
  }
}

Definicje

Nazwa	Opis
ErrorModel	Domyślny model błędów
ErrorResponse	Domyślny model odpowiedzi na błędy
RunPayload	Dane wejściowe przebiegu przepływu pracy. Wyrównaj do operacji w żądaniu użytkownika.
UserRequestStatus	Stan.
WorkflowRun	Wykonywanie przepływu pracy. Obejmuje ona akcję przepływu pracy DAG w czasie wykonywania (migawka daG akcji), ładunek przebiegu, stan całego przebiegu i inne właściwości przebiegu.
WorkflowRunDetail	Odwołuje się on do właściwości "detail" obiektu przebiegu przepływu pracy, która zawiera informacje o kontekście przebiegu i czasie wykonywania akcji.
WorkflowRunPayloadType	Typ ładunku przebiegu przepływu pracy.

ErrorModel

Objekt

Domyślny model błędów

Nazwa	Typ	Opis
code	string	Pobiera lub ustawia kod.
details	ErrorModel[]	Pobiera lub ustawia szczegóły.
message	string	Pobiera lub ustawia komunikaty.
target	string	Pobiera lub ustawia element docelowy.

ErrorResponse

Objekt

Domyślny model odpowiedzi na błędy

Nazwa	Typ	Opis
error	ErrorModel	Domyślny model błędów

RunPayload

Objekt

Dane wejściowe przebiegu przepływu pracy. Wyrównaj do operacji w żądaniu użytkownika.

Nazwa	Typ	Opis
payload	object	Ładunek każdej operacji, którą użytkownik chce przesłać.
targetValue	string	Wartość docelowa, która wymaga aktualizacji przepływu pracy.
type	WorkflowRunPayloadType	Typ ładunku przebiegu przepływu pracy.

UserRequestStatus

Wyliczanie

Stan.

Wartość	Opis
NotStarted
InProgress
Failed
Completed
Canceling
CancellationFailed
Canceled

WorkflowRun

Objekt

Wykonywanie przepływu pracy. Obejmuje ona akcję przepływu pracy DAG w czasie wykonywania (migawka daG akcji), ładunek przebiegu, stan całego przebiegu i inne właściwości przebiegu.

Nazwa	Typ	Opis
actionDag	object	Akcja DAG (Skierowany wykres Acykliczny) definiuje rzeczywisty przepływ.
cancelComment	string	Komentarz po anulowaniu uruchomienia przepływu pracy.
cancelTime	string (date-time)	Czas uruchomienia przepływu pracy zostanie anulowany.
detail	WorkflowRunDetail	Odwołuje się on do właściwości "detail" obiektu przebiegu przepływu pracy, która zawiera informacje o kontekście przebiegu i czasie wykonywania akcji.
endTime	string (date-time)	Godzina uruchomienia przepływu pracy została ukończona.
id	string (uuid)	Identyfikator przebiegu przepływu pracy.
requestor	string (uuid)	Osoba, która przesłała żądanie użytkownika.
runPayload	RunPayload	Dane wejściowe przebiegu przepływu pracy. Wyrównaj do operacji w żądaniu użytkownika.
startTime	string (date-time)	Czas rozpoczęcia przebiegu przepływu pracy.
status	UserRequestStatus	Stan.
userRequestId	string (uuid)	Identyfikator żądania użytkownika.
workflowId	string (uuid)	Identyfikator przepływu pracy.

WorkflowRunDetail

Objekt

Odwołuje się on do właściwości "detail" obiektu przebiegu przepływu pracy, która zawiera informacje o kontekście przebiegu i czasie wykonywania akcji.

Nazwa	Typ	Opis
actions	object
runInput	object	Wbudowane zmienne zaczynają się od @runInput. Jego właściwości są określane przez typ wyzwalacza w czasie wykonywania przepływu pracy.

WorkflowRunPayloadType

Wyliczanie

Typ ładunku przebiegu przepływu pracy.

Wartość	Opis
CreateTerm
UpdateTerm
DeleteTerm
ImportTerms
UpdateAsset
GrantDataAccess