Get enrichment workflow definition by ID

Request

Security

OAuth2(Required scopes: enrichment-workflows.read)

Path

workflowIdstring, (uuid)required

ID of the workflow to be read

curl -i -X GET \
  'https://api.cloud.hypatos.ai/v2/enrichment-workflows/{workflowId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json

idstringrequired

Unique ID of the workflow definition

namestringrequired

Name of the workflow

descriptionstring

companyIdstring

createdAtstring, (date-time)

updatedAtstring, (date-time)

definitionstringrequired

YAML definition of the workflow

projectIdsArray of strings

versioninteger

versionStringstring

updatedBystring

createdByIdstring

updatedByIdstring

Response

{
  "id": "string",
  "name": "string",
  "description": "string",
  "companyId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "definition": "string",
  "projectIds": [
    "string"
  ],
  "version": 0,
  "versionString": "string",
  "updatedBy": "string",
  "createdById": "string",
  "updatedById": "string"
}