Workflow Endpoints

file (file): Required. Select the actual file you want to upload to the system. The media type must be a YXZP file.

name (string): Required. Enter a workflow name. This is the name of the workflow to display in Server UI.

ownerId (string): Required. Enter the ID of the owner.

workerTag (string): Optional. Specify the worker tag defined in the workers to help assign jobs to certain worker nodes. For more information, visit the Worker help page.

districtTags (string): Optional. Submit as JSON formatted array, for example, ["id1", "id2"]. Use districts to group shared, public workflows by tags so that users can easily find them. For more information, visit the Districts help page.

comments (string): Optional. Enter your comments.

isPublic (boolean): Required. Select "true" to make the workflow publicly available. Select "false" to make the workflow private and publicly unavailable.

isReadyForMigration (boolean): Required. Select whether the workflow is ready to be migrated. For more information about the migration from one Server environment to another, see the Enable Workflows for Migration help page.

sourceAppId (string): Optional. Sets the source app id of a workflow. You can use it as the "sourceId" reference for the POST admin/v1/workflows endpoint. Providing a pre-existing sourceAppId will result in an invalid request.

othersMayDownload (boolean): Required. Specify whether other users may download this workflow.

othersCanExecute (boolean): Required. Specify whether other users can execute this workflow.

executionMode (string): Required. Accepted values are "Safe", "SemiSafe", and "Standard". For more information about the execution mode, see the Safe and Semi-safe Run Modes: Blocked Tools, Events, and Data Connectors help page.

hasPrivateDataExemption (boolean): Optional. Give an exemption to allow a workflow with private data to run. Select "true" to allow an exemption or "false" to deny an exemption. For more information, visit the Workflow Options in Admin page.

workflowCredentialType (string): Required. Accepted values are "Default", "Required", and "Specific".

credentialId (string): Optional. Specify the credentialId for this workflow.

collectionIds (string): Optional. Enter the collectionId(s) where this workflow should be added. Submit as JSON formatted array, for example: ["id1", "id2"].

workflowId (string): Required. Enter the workflow ID for which you want to upload a new version.

file (file): Required. Select the actual file you want to upload to the system as a new version. The media type must be a YXZP file.

name (string): Required. Enter the workflow name. This is the name of the workflow to display in Server UI.

ownerId (string): Required. Enter the ID of the owner.

othersMayDownload (boolean): Required. The default is set to "true".

othersCanExecute (boolean): Required. The default is set to "true".

executionMode (string): Required. Accepted values are "Safe", "SemiSafe", and "Standard". For more information about the execution mode, see the Safe and Semi-safe Run Modes: Blocked Tools, Events, and Data Connectors help page.

hasPrivateDataExemption (boolean): Optional. Give an exemption to allow a workflow with private data to run. Select "true" to allow an exemption or "false" to deny an exemption. For more information, visit the Workflow Options in Admin page.

comments (string): Optional. Enter your comments.

makePublished (boolean): Required. The default is set to "true". The makePublished parameter is a way to control whether the new version of a workflow that you push to Server should be the published version or not. You can set the value to "false" when you push the workflow to Server, and then only you will have the ability to run it.

workflowCredentialType (string): Required. Enter the credential type to be used for this workflow. Accepted values are "Default", "Required", and "Specific".

credentialId (string): Optional. Specify the credentialId for this workflow. For more information about credential endpoints, go to Credential Endpoints.

view (string): Optional. Select how you want to display workflow information. Can be left without a value. You can select from the following values: ‘Default’ and ‘Full’. If this parameter is set to 'Default’, then a reduced view object will be returned. When not specified, the ‘Default’ value is used.

name (string): Optional. Enter the name of the workflow in case you want to filter the workflows by name. This is the name of the workflow displayed in Server UI.

ownerId (string): Optional. Enter the ID of the owner in case you want to filter the workflows by their owner.

createdAfter (string): Optional. Enter the date and time after which the workflow was created. Enter the date and time in ISO8601 format.

createdBefore (string): Optional. Enter the date and time before which the workflow was created. Enter the date and time in ISO8601 format.

workflowId (string): Required. Enter the workflow ID to get information about this workflow.

workflowId (string): Required. Enter the ID of the workflow you want to update.

updateWorkflowContract (body): Required. Enter the workflow information you want to update.

Example value of updateWorkflowContract:

{
  "name": "string",
  "versionId": "string",
  "makePublished": true,
  "ownerId": "string",
  "workerTag": "string",
  "districtTags": [
    "string"
  ],
  "comments": "string",
  "isPublic": true,
  "isReadyForMigration": true,
  "othersMayDownload": true,
  "othersCanExecute": true,
  "executionMode": "Safe",
  "hasPrivateDataExemption": true,
  "workflowCredentialType": "Default",
  "credentialId": "string"
}

workflowId (string): Required. Enter the workflow ID for which you want to download the package.

versionId (string): Optional. Enter the specific version ID of a workflow. If no version is provided, then the published version is downloaded.

workflowId (string): Required. Enter the workflow ID for which you want to retrieve the information.

versionId (string): Optional. Enter the specific version ID of a workflow. If no version is provided, then the published version is used.

workflowId (string): Required. Enter the workflow ID for which you want to retrieve the information.

sortField (string): Optional. Enter the field name that you want to sort your results by.

direction (string): Optional. Specify the sorting order here. Accepted values are “asc” (ascending) and “desc” (descending). If no sorting is specified, the default will be ascending.

offset (string): Optional. Refers to the record you want your results to start with.

limit (string): Optional. Refers to the last record you want your results to end with.

status (string): Optional. The overall status of the job execution. A completed job might still have failed. Accepted values are: "Complete", "Error", "Running", and "Queued".

resultCode (string): Optional. The result code of the execution of a workflow. This indicates a failed workflow, but a successful job. Accepted values are: "Success", "Warning", and "Error".

workflowId (string): Required. Enter the workflow ID to delete.

force (boolean): Optional. When not selected, the default value is "false". If a workflow is scheduled, the parameter set to "true" will delete all schedules before deleting it.