POST api/workflows?id={id}&location={location}&workflow={workflow}&comment={comment}&creator={creator}&clone={clone}

Validates and initiates the creation of a new workflow for a specified item and location.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID of the item for which the workflow is being created.

integer

Required

location

The location (folder or container) where the workflow will be created.

integer

Required

workflow

The name or GUID of the workflow to be created.

string

Required

comment

An optional comment to associate with the workflow creation.

string

Default value is

creator

The username of the workflow creator. If not provided, the current user is used.

string

Default value is

clone

If true, the workflow will be cloned from an existing template.

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

On success: HTTP 200 OK with the ID of the newly created workflow. On failure: HTTP 400 Bad Request with a descriptive error message.

WorkflowResponse
NameDescriptionTypeAdditional information
i_node

integer

None.

Response Formats

application/json, text/json, application/scim+json

Sample:
{
  "i_node": 1
}