Workflow Tasks

Cancel workflow task.

post

Cancels the workflow task with the specified ID with a reason. If the given workflow is a subprocess, this method makes sure everything is cancelled from the root process instance. If the given task is not found, this method will assume it already was cancelled without throwing any error.

Authorizations

AuthorizationstringRequired

Path parameters

workflowTaskIdstring · uuidRequired

The ID of the workflow task.

Body

stringOptional

Responses

204

Task successfully canceled.

No content

404

Task not found.

post/workflowTasks/{workflowTaskId}/canceled

POST /rest/2.0/workflowTasks/{workflowTaskId}/canceled HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

No content

Complete workflow tasks.

post

Completes tasks based on the provided request and returns the following tasks, if the same user is assigned to them.

Authorizations

AuthorizationstringRequired

Body

Parameters of the workflow tasks to be completed.

taskIdsstring · uuid[] · min: 1 · max: 2147483647Required

The list of IDs for tasks that should be completed.

guestUserIdstring · uuidOptionalDeprecated

The ID of the guest user. This property is ignored and will be removed without a replacement.

Responses

200

The following tasks, if the calling user is assigned to them. Empty response otherwise.

application/json

Represents a workflow task.

idstring · uuidRequired

The id of the represented object (entity).

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. To stay backwards compatible while still allowing new types of resources to be introduced, a resource discriminator property (of type String) has been added to the subtypes of Resource where it adds value, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. A discriminator is only added on subtypes whose declared return type can represent more than one kind of resource; it is omitted where the return type can only ever be a single kind, as it would then always hold the same value and carry no additional information. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

workflowInstanceIdstring · uuidOptional

The UUID of the workflow instance.

keystringOptional

The key.

typestringOptional

The type.

aggregationKeystringOptional

The key for aggregation purposes.

priorityinteger · int32Optional

The priority.

ownerstringOptional

The owner.

createTimeinteger · int64Optional

The create time.

dueDateinteger · int64Optional

The due date.

cancelablebooleanOptional

Whether this workflow task is cancelable or not.

reassignablebooleanOptional

Whether this workflow task is reassignable or not.

formRequiredbooleanOptional

Whether this task requires a form or not.

formKeyAvailablebooleanOptional

Whether this task has form key available or not.

containsActivityStreambooleanOptional

Whether this task contains an activity stream or not.

inErrorbooleanOptional

Whether this task is in error or not.

errorMessagestringOptional

The error message in case this task is in error.

descriptionstringOptional

The description of the workflow task.

titlestringOptional

The title of the task.

404

Requested workflow task does not exist.

500

Current user is not candidate user for workflow task.

post/workflowTasks/completed

POST /rest/2.0/workflowTasks/completed HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "taskIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "taskFormProperties": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "system": true,
    "workflowDefinition": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text",
      "processId": "text"
    },
    "workflowInstanceId": "123e4567-e89b-12d3-a456-426614174000",
    "key": "text",
    "type": "text",
    "aggregationKey": "text",
    "priority": 1,
    "owner": "text",
    "candidateUsers": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "userName": "text",
        "firstName": "text",
        "lastName": "text",
        "title": "text",
        "department": "text",
        "emailAddress": "text",
        "gender": "MALE",
        "language": "text",
        "additionalEmailAddresses": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
            "createdOn": 1475503010320,
            "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
            "lastModifiedOn": 1476703764163,
            "system": true,
            "emailAddress": "text"
          }
        ],
        "phoneNumbers": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
            "createdOn": 1475503010320,
            "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
            "lastModifiedOn": 1476703764163,
            "system": true,
            "type": "FAX",
            "phoneNumber": "text"
          }
        ],
        "instantMessagingAccounts": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
            "createdOn": 1475503010320,
            "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
            "lastModifiedOn": 1476703764163,
            "system": true,
            "account": "text",
            "type": "AOL"
          }
        ],
        "websites": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
            "createdOn": 1475503010320,
            "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
            "lastModifiedOn": 1476703764163,
            "system": true,
            "url": "text",
            "type": "FACEBOOK"
          }
        ],
        "addresses": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
            "createdOn": 1475503010320,
            "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
            "lastModifiedOn": 1476703764163,
            "system": true,
            "city": "text",
            "street": "text",
            "number": "text",
            "state": "text",
            "country": "text",
            "postalCode": "text",
            "type": "HOME"
          }
        ],
        "activated": true,
        "enabled": true,
        "userSource": "INTERNAL",
        "userSourceString": "text",
        "guestUser": true
      }
    ],
    "createTime": 1,
    "dueDate": 1,
    "cancelable": true,
    "reassignable": true,
    "formRequired": true,
    "formKeyAvailable": true,
    "containsActivityStream": true,
    "inError": true,
    "errorMessage": "text",
    "customButtons": [
      {
        "id": "text",
        "name": "text",
        "type": "text",
        "value": "text",
        "writable": true,
        "required": true,
        "enumValues": [
          {
            "parents": [
              "text"
            ],
            "relationTypeDirection": "TO_SOURCE",
            "idAsString": "text",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "text": "text"
          }
        ],
        "checkButtons": [
          {
            "label": "text",
            "value": "text"
          }
        ],
        "radioButtons": [
          {
            "label": "text",
            "value": "text"
          }
        ],
        "defaultDropdownValues": [
          {
            "parents": [
              "text"
            ],
            "relationTypeDirection": "TO_SOURCE",
            "idAsString": "text",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "text": "text"
          }
        ],
        "proposedDropdownValues": [
          {
            "parents": [
              "text"
            ],
            "relationTypeDirection": "TO_SOURCE",
            "idAsString": "text",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "text": "text"
          }
        ],
        "dateTimeType": "text",
        "multiValue": true,
        "proposedFixed": true,
        "defaultFromResource": true,
        "multiDefaultDropdownValues": {
          "ANY_ADDITIONAL_PROPERTY": [
            {
              "parents": [
                "text"
              ],
              "relationTypeDirection": "TO_SOURCE",
              "idAsString": "text",
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "text": "text"
            }
          ]
        },
        "multiProposedDropdownValues": {
          "ANY_ADDITIONAL_PROPERTY": [
            {
              "parents": [
                "text"
              ],
              "relationTypeDirection": "TO_SOURCE",
              "idAsString": "text",
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "text": "text"
            }
          ]
        },
        "assetType": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community"
        },
        "assetTypeIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "communityIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "domainIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "statusIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "userSourceFilter": "text",
        "helpText": "text"
      }
    ],
    "description": "text",
    "title": "text",
    "businessItem": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community"
    },
    "businessItemReference": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    }
  }
]

Find workflow tasks.

get

Returns the workflow tasks matching given search criteria.

Authorizations

AuthorizationstringRequired

Query parameters

offsetinteger · int32Optional

The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0.

Default: 0

limitinteger · int32Optional

The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.

Default: 0

countLimitinteger · int32Optional

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

Default: -1

businessItemIdstring · uuidOptional

The ID of the business item

businessItemTypestring · enumOptional

The type of the business item

Possible values:

taskIdPhrasestringOptional

The part of the id of the task

workflowTaskUserRelationstring · enumOptional

The type of relation between user and searched tasks. This could be either set to search for all the tasks the user is permitted to view or just those assigned to the user.

Default: ALLPossible values:

businessItemNamestringOptional

The part of the name of the business item.

descriptionstringOptional

The part of the task description.

userIdstring · uuidOptional

The ID of the user for which the tasks need to be returned. If empty, the current logged in user will be used

createDateinteger · int64Optional

The creation date of the task. It is the timestamp (in UTC time standard)

dueDateinteger · int64Optional

The due date of the task. It is the timestamp (in UTC time standard)

titlestringOptional

The title/name of the task.

typestringOptional

The task type.

sortFieldstring · enumOptional

The field on which the results are sorted. On due date by default.

Default: DUE_DATEPossible values:

sortOrderstring · enumOptional

The sorting order.

Default: DESCPossible values:

Responses

200

The paged response with found workflow tasks

application/json

totalinteger · int64Optional

The total number of results.

Example: 1000

offsetinteger · int64Optional

The offset for the results.

Example: 10

limitinteger · int64Optional

The maximum number of results to be returned.

Example: 100

get/workflowTasks

GET /rest/2.0/workflowTasks HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

The paged response with found workflow tasks

{
  "total": 1000,
  "offset": 10,
  "limit": 100,
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "system": true,
      "workflowDefinition": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text",
        "processId": "text"
      },
      "workflowInstanceId": "123e4567-e89b-12d3-a456-426614174000",
      "key": "text",
      "type": "text",
      "aggregationKey": "text",
      "priority": 1,
      "owner": "text",
      "candidateUsers": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
          "createdOn": 1475503010320,
          "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
          "lastModifiedOn": 1476703764163,
          "system": true,
          "userName": "text",
          "firstName": "text",
          "lastName": "text",
          "title": "text",
          "department": "text",
          "emailAddress": "text",
          "gender": "MALE",
          "language": "text",
          "additionalEmailAddresses": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
              "createdOn": 1475503010320,
              "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
              "lastModifiedOn": 1476703764163,
              "system": true,
              "emailAddress": "text"
            }
          ],
          "phoneNumbers": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
              "createdOn": 1475503010320,
              "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
              "lastModifiedOn": 1476703764163,
              "system": true,
              "type": "FAX",
              "phoneNumber": "text"
            }
          ],
          "instantMessagingAccounts": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
              "createdOn": 1475503010320,
              "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
              "lastModifiedOn": 1476703764163,
              "system": true,
              "account": "text",
              "type": "AOL"
            }
          ],
          "websites": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
              "createdOn": 1475503010320,
              "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
              "lastModifiedOn": 1476703764163,
              "system": true,
              "url": "text",
              "type": "FACEBOOK"
            }
          ],
          "addresses": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
              "createdOn": 1475503010320,
              "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
              "lastModifiedOn": 1476703764163,
              "system": true,
              "city": "text",
              "street": "text",
              "number": "text",
              "state": "text",
              "country": "text",
              "postalCode": "text",
              "type": "HOME"
            }
          ],
          "activated": true,
          "enabled": true,
          "userSource": "INTERNAL",
          "userSourceString": "text",
          "guestUser": true
        }
      ],
      "createTime": 1,
      "dueDate": 1,
      "cancelable": true,
      "reassignable": true,
      "formRequired": true,
      "formKeyAvailable": true,
      "containsActivityStream": true,
      "inError": true,
      "errorMessage": "text",
      "customButtons": [
        {
          "id": "text",
          "name": "text",
          "type": "text",
          "value": "text",
          "writable": true,
          "required": true,
          "enumValues": [
            {
              "parents": [
                "text"
              ],
              "relationTypeDirection": "TO_SOURCE",
              "idAsString": "text",
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "text": "text"
            }
          ],
          "checkButtons": [
            {
              "label": "text",
              "value": "text"
            }
          ],
          "radioButtons": [
            {
              "label": "text",
              "value": "text"
            }
          ],
          "defaultDropdownValues": [
            {
              "parents": [
                "text"
              ],
              "relationTypeDirection": "TO_SOURCE",
              "idAsString": "text",
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "text": "text"
            }
          ],
          "proposedDropdownValues": [
            {
              "parents": [
                "text"
              ],
              "relationTypeDirection": "TO_SOURCE",
              "idAsString": "text",
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "text": "text"
            }
          ],
          "dateTimeType": "text",
          "multiValue": true,
          "proposedFixed": true,
          "defaultFromResource": true,
          "multiDefaultDropdownValues": {
            "ANY_ADDITIONAL_PROPERTY": [
              {
                "parents": [
                  "text"
                ],
                "relationTypeDirection": "TO_SOURCE",
                "idAsString": "text",
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "text": "text"
              }
            ]
          },
          "multiProposedDropdownValues": {
            "ANY_ADDITIONAL_PROPERTY": [
              {
                "parents": [
                  "text"
                ],
                "relationTypeDirection": "TO_SOURCE",
                "idAsString": "text",
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "text": "text"
              }
            ]
          },
          "assetType": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community"
          },
          "assetTypeIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "communityIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "domainIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "statusIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "userSourceFilter": "text",
          "helpText": "text"
        }
      ],
      "description": "text",
      "title": "text",
      "businessItem": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community"
      },
      "businessItemReference": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    }
  ]
}

Get task form data.

get

Returns the task form data of the workflow task with the specified ID and form property type.

Authorizations

AuthorizationstringRequired

Path parameters

workflowTaskIdstring · uuidRequired

Workflow task ID.

Query parameters

formPropertyTypestringOptional

Form property type.

Responses

200

Workflow task form data successfully found.

application/json

Represents all task related form data.

formKeystringOptional

The form key.

taskIdstringOptional

The id of the task.

containsActivityStreambooleanOptional

Whether the task form contains a activity stream.

subtitlestringOptional

The subtitle of the task if any.

401

User don't have permission for given task

404

Workflow task form data could not be found.

get/workflowTasks/{workflowTaskId}/taskFormData

GET /rest/2.0/workflowTasks/{workflowTaskId}/taskFormData HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "formKey": "text",
  "formProperties": [
    {
      "id": "text",
      "name": "text",
      "type": "text",
      "value": "text",
      "writable": true,
      "required": true,
      "enumValues": [
        {
          "parents": [
            "text"
          ],
          "relationTypeDirection": "TO_SOURCE",
          "idAsString": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "text": "text"
        }
      ],
      "checkButtons": [
        {
          "label": "text",
          "value": "text"
        }
      ],
      "radioButtons": [
        {
          "label": "text",
          "value": "text"
        }
      ],
      "defaultDropdownValues": [
        {
          "parents": [
            "text"
          ],
          "relationTypeDirection": "TO_SOURCE",
          "idAsString": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "text": "text"
        }
      ],
      "proposedDropdownValues": [
        {
          "parents": [
            "text"
          ],
          "relationTypeDirection": "TO_SOURCE",
          "idAsString": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "text": "text"
        }
      ],
      "dateTimeType": "text",
      "multiValue": true,
      "proposedFixed": true,
      "defaultFromResource": true,
      "multiDefaultDropdownValues": {
        "ANY_ADDITIONAL_PROPERTY": [
          {
            "parents": [
              "text"
            ],
            "relationTypeDirection": "TO_SOURCE",
            "idAsString": "text",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "text": "text"
          }
        ]
      },
      "multiProposedDropdownValues": {
        "ANY_ADDITIONAL_PROPERTY": [
          {
            "parents": [
              "text"
            ],
            "relationTypeDirection": "TO_SOURCE",
            "idAsString": "text",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "text": "text"
          }
        ]
      },
      "assetType": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community"
      },
      "assetTypeIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "communityIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "domainIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "statusIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "userSourceFilter": "text",
      "helpText": "text"
    }
  ],
  "taskId": "text",
  "containsActivityStream": true,
  "subtitle": "text"
}

Get workflow task.

get

Returns the workflow task with the specified ID. A task will only be returned when the user has the correct permission to view it.

Authorizations

AuthorizationstringRequired

Path parameters

workflowTaskIdstring · uuidRequired

The ID of the workflow task to return.

Responses

200

Workflow task successfully found.

application/json

Represents a workflow task.

idstring · uuidRequired

The id of the represented object (entity).

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. To stay backwards compatible while still allowing new types of resources to be introduced, a resource discriminator property (of type String) has been added to the subtypes of Resource where it adds value, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. A discriminator is only added on subtypes whose declared return type can represent more than one kind of resource; it is omitted where the return type can only ever be a single kind, as it would then always hold the same value and carry no additional information. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

workflowInstanceIdstring · uuidOptional

The UUID of the workflow instance.

keystringOptional

The key.

typestringOptional

The type.

aggregationKeystringOptional

The key for aggregation purposes.

priorityinteger · int32Optional

The priority.

ownerstringOptional

The owner.

createTimeinteger · int64Optional

The create time.

dueDateinteger · int64Optional

The due date.

cancelablebooleanOptional

Whether this workflow task is cancelable or not.

reassignablebooleanOptional

Whether this workflow task is reassignable or not.

formRequiredbooleanOptional

Whether this task requires a form or not.

formKeyAvailablebooleanOptional

Whether this task has form key available or not.

containsActivityStreambooleanOptional

Whether this task contains an activity stream or not.

inErrorbooleanOptional

Whether this task is in error or not.

errorMessagestringOptional

The error message in case this task is in error.

descriptionstringOptional

The description of the workflow task.

titlestringOptional

The title of the task.

401

User don't have permission for given task

404

Workflow task could not be found.

get/workflowTasks/{workflowTaskId}

GET /rest/2.0/workflowTasks/{workflowTaskId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "system": true,
  "workflowDefinition": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text",
    "processId": "text"
  },
  "workflowInstanceId": "123e4567-e89b-12d3-a456-426614174000",
  "key": "text",
  "type": "text",
  "aggregationKey": "text",
  "priority": 1,
  "owner": "text",
  "candidateUsers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "userName": "text",
      "firstName": "text",
      "lastName": "text",
      "title": "text",
      "department": "text",
      "emailAddress": "text",
      "gender": "MALE",
      "language": "text",
      "additionalEmailAddresses": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
          "createdOn": 1475503010320,
          "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
          "lastModifiedOn": 1476703764163,
          "system": true,
          "emailAddress": "text"
        }
      ],
      "phoneNumbers": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
          "createdOn": 1475503010320,
          "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
          "lastModifiedOn": 1476703764163,
          "system": true,
          "type": "FAX",
          "phoneNumber": "text"
        }
      ],
      "instantMessagingAccounts": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
          "createdOn": 1475503010320,
          "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
          "lastModifiedOn": 1476703764163,
          "system": true,
          "account": "text",
          "type": "AOL"
        }
      ],
      "websites": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
          "createdOn": 1475503010320,
          "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
          "lastModifiedOn": 1476703764163,
          "system": true,
          "url": "text",
          "type": "FACEBOOK"
        }
      ],
      "addresses": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
          "createdOn": 1475503010320,
          "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
          "lastModifiedOn": 1476703764163,
          "system": true,
          "city": "text",
          "street": "text",
          "number": "text",
          "state": "text",
          "country": "text",
          "postalCode": "text",
          "type": "HOME"
        }
      ],
      "activated": true,
      "enabled": true,
      "userSource": "INTERNAL",
      "userSourceString": "text",
      "guestUser": true
    }
  ],
  "createTime": 1,
  "dueDate": 1,
  "cancelable": true,
  "reassignable": true,
  "formRequired": true,
  "formKeyAvailable": true,
  "containsActivityStream": true,
  "inError": true,
  "errorMessage": "text",
  "customButtons": [
    {
      "id": "text",
      "name": "text",
      "type": "text",
      "value": "text",
      "writable": true,
      "required": true,
      "enumValues": [
        {
          "parents": [
            "text"
          ],
          "relationTypeDirection": "TO_SOURCE",
          "idAsString": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "text": "text"
        }
      ],
      "checkButtons": [
        {
          "label": "text",
          "value": "text"
        }
      ],
      "radioButtons": [
        {
          "label": "text",
          "value": "text"
        }
      ],
      "defaultDropdownValues": [
        {
          "parents": [
            "text"
          ],
          "relationTypeDirection": "TO_SOURCE",
          "idAsString": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "text": "text"
        }
      ],
      "proposedDropdownValues": [
        {
          "parents": [
            "text"
          ],
          "relationTypeDirection": "TO_SOURCE",
          "idAsString": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "text": "text"
        }
      ],
      "dateTimeType": "text",
      "multiValue": true,
      "proposedFixed": true,
      "defaultFromResource": true,
      "multiDefaultDropdownValues": {
        "ANY_ADDITIONAL_PROPERTY": [
          {
            "parents": [
              "text"
            ],
            "relationTypeDirection": "TO_SOURCE",
            "idAsString": "text",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "text": "text"
          }
        ]
      },
      "multiProposedDropdownValues": {
        "ANY_ADDITIONAL_PROPERTY": [
          {
            "parents": [
              "text"
            ],
            "relationTypeDirection": "TO_SOURCE",
            "idAsString": "text",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "text": "text"
          }
        ]
      },
      "assetType": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community"
      },
      "assetTypeIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "communityIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "domainIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "statusIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "userSourceFilter": "text",
      "helpText": "text"
    }
  ],
  "description": "text",
  "title": "text",
  "businessItem": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community"
  },
  "businessItemReference": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  }
}

Reassign task.

post

Reassigns the task with the specified ID to one or more users, groups or roles. Caller needs to provide at least one of the value list for users, groups or roles. If roles are provided then the same number of communities needs to be provided also.

Authorizations

AuthorizationstringRequired

Path parameters

workflowTaskIdstring · uuidRequired

The ID of the workflow task.

Query parameters

usersstring · uuid[]Optional

The user IDs to reassign to.

groupsstring · uuid[]Optional

The group IDs to reassign to.

rolesstring · uuid[]Optional

The role IDs to reassign to.

communitiesstring · uuid[]Optional

The Community IDs of the specified roles to reassign to.

Responses

200

Task successfully reassigned.

No content

404

Task not found.

post/workflowTasks/{workflowTaskId}/reassign

POST /rest/2.0/workflowTasks/{workflowTaskId}/reassign HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content