Update Workflow

PUT 
/workflows/:id

Perform a full update of a workflow. The updated workflow object is returned in the response.

Request

Path Parameters

id stringrequired

Id of the Workflow

application/json

Body

required

name string

The name of the workflow

owner

object

The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request.

type string

Possible values: [IDENTITY]

The type of object that is referenced

id string

The unique ID of the object

name string

The name of the object

description string

Description of what the workflow accomplishes

definition

object

The map of steps that the workflow will execute.

start string

The name of the starting step.

steps

object

One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.

property name* any

One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.

enabled boolean

Enable or disable the workflow. Workflows cannot be created in an enabled state.

trigger

object

Workflow Trigger.

type stringrequired

Possible values: [EVENT, EXTERNAL, SCHEDULED]

The trigger type

displayName stringnullable

attributes

object

required

Workflow Trigger Attributes.

oneOf

Event Trigger Attributes

id stringrequired

The unique ID of the trigger

filter.$ string

JSON path expression that will limit which events the trigger will fire on

description string

Description of the event trigger

External Trigger Attributes

name string

A unique name for the external trigger

description string

Additional context about the external trigger

clientId string

OAuth Client ID to authenticate with this trigger

url string

URL to invoke this workflow

Scheduled Trigger Attributes

frequency stringrequired

Possible values: [daily, weekly, monthly, yearly, cronSchedule]

Frequency of execution

timeZone string

Time zone identifier

cronString string

weeklyDays string[]

Scheduled days of the week for execution

weeklyTimes string[]

Scheduled execution times

Responses

200

The Workflow object

application/json

Schema

Schema

id string

Workflow ID. This is a UUID generated upon creation.

modified date-time

The date and time the workflow was modified.

modifiedBy

object

type string

Possible values: [IDENTITY]

id string

Identity ID

name string

Human-readable display name of identity.

executionCount int32

The number of times this workflow has been executed.

failureCount int32

The number of times this workflow has failed during execution.

created date-time

The date and time the workflow was created.

creator

object

Workflow creator's identity.

type string

Possible values: [IDENTITY]

Workflow creator's DTO type.

id string

Workflow creator's identity ID.

name string

Workflow creator's display name.

name string

The name of the workflow

owner

object

The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request.

type string

Possible values: [IDENTITY]

The type of object that is referenced

id string

The unique ID of the object

name string

The name of the object

description string

Description of what the workflow accomplishes

definition

object

The map of steps that the workflow will execute.

start string

The name of the starting step.

steps

object

One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.

property name* any

One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.

enabled boolean

Enable or disable the workflow. Workflows cannot be created in an enabled state.

trigger

object

Workflow Trigger.

type stringrequired

Possible values: [EVENT, EXTERNAL, SCHEDULED]

The trigger type

displayName stringnullable

attributes

object

required

Workflow Trigger Attributes.

oneOf

Event Trigger Attributes

id stringrequired

The unique ID of the trigger

filter.$ string

JSON path expression that will limit which events the trigger will fire on

description string

Description of the event trigger

External Trigger Attributes

name string

A unique name for the external trigger

description string

Additional context about the external trigger

clientId string

OAuth Client ID to authenticate with this trigger

url string

URL to invoke this workflow

Scheduled Trigger Attributes

frequency stringrequired

Possible values: [daily, weekly, monthly, yearly, cronSchedule]

Frequency of execution

timeZone string

Time zone identifier

cronString string

weeklyDays string[]

Scheduled days of the week for execution

weeklyTimes string[]

Scheduled execution times

Example (from schema)

{
  "id": "d201c5e9-d37b-4aff-af14-66414f39d569",
  "modified": "2023-12-05T15:18:27.699132301Z",
  "modifiedBy": {
    "type": "IDENTITY",
    "id": "2c9180a46faadee4016fb4e018c20639",
    "name": "Thomas Edison"
  },
  "executionCount": 2,
  "failureCount": 0,
  "created": "2022-01-10T16:06:16.636381447Z",
  "creator": {
    "type": "IDENTITY",
    "id": "2c7180a46faadee4016fb4e018c20642",
    "name": "Michael Michaels"
  },
  "name": "Send Email",
  "owner": {
    "type": "IDENTITY",
    "id": "2c91808568c529c60168cca6f90c1313",
    "name": "William Wilson"
  },
  "description": "Send an email to the identity who's attributes changed.",
  "definition": {
    "start": "Send Email Test",
    "steps": {
      "Send Email": {
        "actionId": "sp:send-email",
        "attributes": {
          "body": "This is a test",
          "from": "[email protected]",
          "recipientId.$": "$.identity.id",
          "subject": "test"
        },
        "nextStep": "success",
        "selectResult": null,
        "type": "ACTION"
      },
      "success": {
        "type": "success"
      }
    }
  },
  "enabled": false,
  "trigger": {
    "type": "EVENT",
    "displayName": "string",
    "attributes": {
      "id": "idn:identity-attributes-changed",
      "filter.$": "$.changes[?(@.attribute == 'manager')]",
      "description": "string"
    }
  }
}

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...