Workflow Task

An Object

Table of Contents
Note

Drop in one of our language drivers to accelerate your development.
Here are links to some of our popular Cookbooks to help you get started!

Parent

This Workflow Task is contained within a Platform.

Properties

The following properties are available:

Property Type Default Read-Only Description
_doc string No The primary ID
_system object No Metadata maintained by the system

Methods

The following methods are available:

Add

POST /workflow/tasks/{taskId}/resources/add

Parameters

Name Required Type Description
taskId true string
reference true string

Response

{}

Check Permission

Checks whether one or more authorities against the specified workflowTask are granted for a given set of users
POST /workflow/tasks/{taskId}/permissions/{permissionId}/check

Parameters

Name Required Type Description
taskId true string
permissionId true string
id true string

Response

{
  "$ref": "#/components/schemas/checkPermission"
}

Check Single Authority

Checks whether a single authority is granted against the specified workflowTask for the given user
POST /workflow/tasks/{taskId}/authorities/{authorityId}/check

Parameters

Name Required Type Description
taskId true string
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Check",
  "extends": "status",
  "properties": {
    "check": {
      "type": "boolean"
    },
    "ok": null
  }
}

Check multiple Authorities

Checks whether one or more authorities against the specified workflowTask are granted for a given set of users
POST /workflow/tasks/authorities/check

Parameters

This function has no parameters.

Response

{
  "type": "object",
  "description": "Check Multiple Authorities Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "authorityId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Check multiple Permissions

Checks whether one or more permissions against the specified workflowTask are granted for a given set of users
POST /workflow/tasks/permissions/check

Parameters

This function has no parameters.

Response

{
  "type": "object",
  "description": "Check Multiple Permissions Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "permissionId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Claim

POST /workflow/tasks/{taskId}/claim

Parameters

Name Required Type Description
taskId true string

Response

{}

Comments

POST /workflow/tasks/{taskId}/comments

Parameters

Name Required Type Description
taskId true string

Response

{}

Complete

POST /workflow/tasks/{taskId}/complete

Parameters

Name Required Type Description
taskId true string
routeId true string

Response

{}

Data

GET /workflow/tasks/{taskId}/data

Parameters

Name Required Type Description
taskId true string

Response

{}

Data

POST /workflow/tasks/{taskId}/data

Parameters

Name Required Type Description
taskId true string

Response

{}

Delegate

POST /workflow/tasks/{taskId}/delegate

Parameters

Name Required Type Description
taskId true string
userId true string The ID of the user

Response

{}

Delegates

GET /workflow/tasks/{taskId}/delegates

Parameters

Name Required Type Description
taskId true string

Response

{}

Delete Workflow Task

Deletes an existing Workflow Task
DELETE /workflow/tasks/{taskId}

Parameters

Name Required Type Description
taskId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Workflow Task

Deletes an existing Workflow Task
POST /workflow/tasks/{taskId}/delete

Parameters

Name Required Type Description
taskId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Form

GET /workflow/tasks/{taskId}/form

Parameters

Name Required Type Description
taskId true string

Response

{}

Grant Authority

Grants an authority against the specified workflowTask to a given user
POST /workflow/tasks/{taskId}/authorities/{authorityId}/grant

Parameters

Name Required Type Description
taskId true string
authorityId true string
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Lists Workflow Task

Retrieves a list of Workflow Task instances
GET /workflow/tasks

Parameters

Name Required Type Description
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_workflowTask"
      }
    }
  }
}

Moves a workflow task to another node in the workflow model

Moves a workflow task to another node in the workflow model
POST /workflow/tasks/{taskId}/move

Parameters

Name Required Type Description
taskId true string
id true string

Response

{
  "$ref": "#/components/schemas/"
}

Queries for Workflow Task

Queries for instances of type Workflow Task
POST /workflow/tasks/query

Parameters

Name Required Type Description
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_workflowTask"
      }
    }
  }
}

Query

Queries for matches
POST /workflow/user/tasks/query

Parameters

Name Required Type Description
filter false string
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap"
      }
    }
  }
}

Read ACL

Read the Access Control List for the specified workflowTask
GET /workflow/tasks/{taskId}/acl/list

Parameters

Name Required Type Description
taskId true string

Response

{
  "type": "object",
  "description": "Result Map of ACL entries",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "_doc": {
            "type": "string",
            "title": "Principal ID"
          },
          "name": {
            "type": "string",
            "title": "Principal Name"
          },
          "type": {
            "type": "string",
            "title": "Principal Type"
          },
          "domainId": {
            "type": "string"
          },
          "domainQualifiedId": {
            "type": "string"
          },
          "domainQualifiedName": {
            "type": "string"
          },
          "principalId": {
            "type": "string",
            "title": "Principal ID"
          },
          "userEmail": {
            "type": "string"
          },
          "userFirstName": {
            "type": "string"
          },
          "userLastName": {
            "type": "string"
          },
          "authorities": {
            "type": "array",
            "title": "Authorities",
            "items": {
              "type": "string",
              "title": "Authority Key"
            }
          }
        }
      }
    }
  }
}

Read ACL for Principal

Reads the ACL for a workflow task and specific actor
GET /workflow/tasks/{taskId}/acl

Parameters

Name Required Type Description
taskId true string
id true string

Response

{
  "type": "object",
  "description": "Result Map of Authority Keys",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Authority Key"
      }
    }
  }
}

Read Authorities Report

Read the Authorities Report for the specified workflowTask
POST /workflow/tasks/{taskId}/authorities

Parameters

Name Required Type Description
taskId true string

Response

{
  "type": "object",
  "description": "Authority Report",
  "properties": {
    "principalId": {
      "type": "object",
      "properties": {
        "id": {
          "type": "object",
          "properties": {
            "role-key": {
              "type": "string"
            },
            "principal": {
              "type": "string"
            },
            "permissioned": {
              "type": "string"
            },
            "inheritsFrom": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "principal": {
                  "type": "string"
                },
                "permissioned": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Read Workflow Task

Reads an instance of a Workflow Task
GET /workflow/tasks/{taskId}

Parameters

Name Required Type Description
taskId true string

Response

{
  "type": "object",
  "extends": "document",
  "description": "Workflow Task",
  "container": "platform",
  "properties": {
    "_doc": null,
    "_system": null
  }
}

Remove

POST /workflow/tasks/{taskId}/resources/{resourceId}/remove

Parameters

Name Required Type Description
taskId true string
resourceId true string

Response

{}

Removeall

POST /workflow/tasks/{taskId}/resources/removeall

Parameters

Name Required Type Description
taskId true string

Response

{}

Resources

GET /workflow/tasks/{taskId}/resources

Parameters

Name Required Type Description
taskId true string

Response

{}

Revoke Authority

Revokes an authority against the specified workflowTask from a given user
POST /workflow/tasks/{taskId}/authorities/{authorityId}/revoke

Parameters

Name Required Type Description
taskId true string
authorityId true string
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Routes

GET /workflow/tasks/{taskId}/routes

Parameters

Name Required Type Description
taskId true string

Response

{}

Starts an export job for this resource

Starts an export job for this resource
POST /workflow/tasks/{taskId}/export

Parameters

Name Required Type Description
taskId true string
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Export Configuration",
  "properties": {
    "startDate": {
      "type": "object"
    },
    "endDate": {
      "type": "object"
    },
    "startChangeset": {
      "type": "string"
    },
    "endChangeset": {
      "type": "string"
    },
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  }
}

Starts an import job for this resource

Starts an import job for this resource
POST /workflow/tasks/{taskId}/import

Parameters

Name Required Type Description
taskId true string
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Import Configuration",
  "properties": {
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "strategy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "substitutions": {
      "type": "string"
    }
  }
}

Tasks

GET /workflow/user/tasks

Parameters

Name Required Type Description
filter false string

Response

{}

Unclaim

POST /workflow/tasks/{taskId}/unclaim

Parameters

Name Required Type Description
taskId true string

Response

{}

Update Workflow Task

Updates an existing Workflow Task
PUT /workflow/tasks/{taskId}

Parameters

Name Required Type Description
taskId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update Workflow Task

Updates an existing Workflow Task
POST /workflow/tasks/{taskId}/update

Parameters

Name Required Type Description
taskId true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

{resourceId}

GET /workflow/tasks/{taskId}/resources/{resourceId}

Parameters

Name Required Type Description
taskId true string
resourceId true string

Response

{}

Schema


{
  "type": "object",
  "extends": "document",
  "description": "Workflow Task",
  "container": "platform",
  "properties": {
    "_doc": null,
    "_system": null
  },
  "id": "workflowTask"
}