Get list of task instances
GET/flow_instances/task_instances
Get list of task instances
Request
Query Parameters
The attributes that will be returned together with the task instance
The term to the search
The task instance list can be filtered
The task instance list can be sorted
Header Parameters
Every request should has X-Domain Header, in the UUIDv4 format. The X-Domain can be get from the Tenant Integrations page
An X-API-KEY key is a token that a client provides with a X-API-SECRET when making API calls, used instead of the JWT
An X-API-SECRET key is a token that a client provides with a X-API-KEY when making API calls, used instead of the JWT
Responses
- 200
- 401
- 500
The request was successful
- application/vnd.api+json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
Array [
]
Array [
Array [
]
Array [
]
]
Array [
Array [
]
Array [
]
]
- TaskInstance.Artifact.FillForm
- TaskInstance.Artifact.FormApprove
- TaskInstance.Artifact.SmartContract
Array [
]
Array [
]
- FormInstance
- Blockchain.SmartContractInstance
Array [
]
- MOD1
- MOD2
Array [
Array [
]
]
Array [
]
Array [
]
]
data
object[]
The type of the task instance
The task instances id in the UUIDv4 format
attributes
object
The task reference in the UUIDv4 format
Task instance name
Task instance description
Id of the user who selected as assignee
Possible values: [users, external_users]
The type of the user who selected as assignee
The flag that show is it task instance in the active status
The flag that show is current user has permission to reopen this task instance
The flag that show is current user has permission to reject this task instance
The flag that show is current user has permission to reassign this task instance
The flag that show is current user has permission to execute this task instance
The flag that show is it task instance completed or not
properties
object
buttons
object
forward
object
The text that will be shown on the task instance button. As example: the "Submit" text on the button that submit task instance
backward
object
The text that will be shown on the task instance button. As example: the "Submit" text on the button that submit task instance
webhook
object
In current moment relates only to the Export task instance type
Type of the events that will trigger a webhook. In current moment available only task instance completed event available
Your unique URL where is a webhook listener
transitions
object
The flag that show is this task instance the last task in the workflow
Shows id of which task instance will be run after current completed. If the task instance is last in the workflow it will be empty
The flag that show is this task instance the first task in the workflow
Shows id of which task instance will be run if this task instance will be rejected. Relates only to the Form Approval task instance. If the task instance is first in the workflow it will be empty
access_roles
object
Shows id of the roles which users can view current task instance
Shows id of the roles which users can change current task instance
The id of the user who is a assignee of the current task instance
Shows id of the roles which users can complete/execute current task instance
capabilities
object
wizard
object
Deprecated capability
history
object
The flag shows that a history capability enabled for current task instance. Relates only to the Fill Form task type
notices
object[]
Notice after the due dates reached
Days after the due date
comments
object
level
object
artifact
object
Possible values: [private, public]
In the Trisk available two types of the comments, private and public.
coworking
object
The flag shows that a co-working capability enabled for current task instance. Relates only to the Fill Form and Form Approval task instance types
reminders
object[]
Reminder before the due dates reached
Days in advance to the due date
data_transfers
object[]
Deprecated capability
due_date_settings
object
Days to the due date
Possible values: [absolute, relative, actual, immediately]
Types of the due dates: absolute - due date calculated based on the start date of the workflow; relative - due date calculated based on the previous step; actual - due date specified manually as date/month; immediately - relates only to the Notification step. Will be sent when the previous task will be completed or when workflow started, if it is the first task in the flow
The month when the due date reached if selected actual type of the due date
due_dates_managing
object
The flag that show is due dates can be changed from the task instance, relates only to Document Management task type
access_tokens
object
The guest users who used in the multiple workflow launch
additional_data
object
The data used for a tutorials
notifications_templates
object
The id of the notification template that will be send when the task instance will be assigned to the user
The id of the notification template that will be send when the multiple task instances will be assigned to the user
access_tokens_instructions
object[]
The instructions how to launch related workflows
instructions
object[]
launched_task_instances
object[]
related_launch_instructions
object[]
instructions
object[]
processed
object[]
artifact
object
oneOf
For the Fill Form task instance this is a id of the Form template, for the Form Approve task instance - id of the Fill Form task instance that will be approved
For a Fill Form type of the artifact is a form
parameters
object
The id of the Form version
The id of the Fill Form task
For a Form Approve type of the artifact is a task_approve
The id of the Smart Contract that saved in our system
Type of the artifact
parameters
object
The method of the Smart Contract that was selected on task creation step
inputs
object[]
Inputs of the selected method
Name of the input
The id of the selected target type
Possible values: [form, data_dictionary, smart_contract]
The Smart Contract supported Fill Form, Data Dictionary, and other Smart contract as target type
If the selected Smart Contract as a target type, in the input_argument should be selected Parameter Argument from the selected Smart Contract
The reference of the task instance
outputs
object[]
Outputs of the Smart Contract
The method of the Smart Contract
The id of the selected target type
Possible values: [form, data_dictionary, smart_contract]
The Smart Contract supported Fill Form, Data Dictionary, and other Smart contract as target type
If the selected Smart Contract as a target type, in the output_argument should be selected Parameter Argument from the selected Smart Contract
The reference of the task instance
Possible values: [past_due, this_week, on_schedule]
The indication in the which scope will task instance due date reached
The flag that show is this task instance has not completed reopen requests
The date and time when the task instance due date will be reached
The date and time when the task instance was completed
The date and time when the task instance was changed
The date and time when the task instance was completed
relationships
object
artifact
object
data
object
oneOf
The instance of the form template
The id of the form instance
attributes
object
The form instance name
Possible values: [task_instance]
The type of the owner for a form instance. Only task instance can be an owner
The id of the task instance
The date and time when the form instance was created
The date and time when the form instance was last time updated
The id of the smart contract in the Trisk
attributes
object
Possible values: [pending, in_progress, failed, resolved]
The smart contract instance has a following statuses: pending - when the smart contract task instance was created; in_progress - when the smart contract task instance executing on the blockchain; failed - if the smart contract task instance failed in the blockchain execution; resolved - when the smart contract task instance successfully executed on the blockchain
The task instance id who launch the smart contract
Possible values: [task]
The type of the owner
input
object[]
output
object
oneOf
Transaction hash
Smart contract address
Wallet address
Transaction hash
events
object[]
args
object[]
Event name
relationships
object
errors
object
data
object[]
The id of the blockchain smart contract instance error
attributes
object
The message of the blockchain smart contract instance error
The date and time when the blockchain smart contract instance error was created
assignee
object
data
object
An assignee is a user who responsible for a task execution
The id of the user who is a assignee
attributes
object
Possible values: [users, external_users]
In the system we have a two types of the users, internal - users registered in the system and external_users - Trisk allows you to assign tasks to guest users who are not registered in the platform
Possible values: [tenant, client]
In the system we have a two scope of the users, tenant users - This is your Company users; the originator of processes/workflows and the client users - this is the individual on the other side, the provider of information, the respondent
The user email
The date and time when the user was archived
relationships
object
profile
object
data
object
The id of the profile registered user
attributes
object
The user first name
The user last name
The user avatar in the JPG, PNG, and max size of 5Mb
The international phone code
The phone number of the user
This field is a string and can be used as a position of the user in the company or some other information
The date and time of the user creation
The date and time when the info in the user profile was changed
process_instances
object
data
object
The id of the process instance
attributes
object
The reference of the process instance
The name of the process
The description of the process
properties
object
capabilities
object[]
conditional_run
object
Its essence is that by filling in specific fields, the system launches separate, previously created, forms.
seeds
object
artifact
object
The artifact is what the task executes, for different types of tasks, artifact structures different
For the Fill Form task instance this is a id of the Form template, for the Form Approve task instance - id of the Fill Form task instance that will be approved
For a Fill Form type of the artifact is a form
parameters
object
The id of the Form version
source
object
nested
object
nested
object
nested
object
nested
object
target
object
target
object
The flag that show that the process instance was started
The flag that show that the process instance was completed
The date and time when the process instance was created
The date and time when the process instance was last time updated
relationships
object
container_instances
object
data
object
The id of the container instance
attributes
object
The reference of the container instance
The name of the container instance
Possible values: [default, todo]
The container instance has a two types, default and todo. The todo type used only for ToDo task instance type
The flag that show that the container instance was started
The flag that show that the container instance was completed
The date and time when the container instance was created
The date and time when the container instance was last time updated
The date and time when the container instance was completed
relationships
object
flow_instances
object
data
object
The id of the workflow instance
attributes
object
The name of the workflow instance
The identifier is a simple string that helps to clarify what the workflow instance do
This is an aggregated name with workflow name and identifier
Possible values: [0, 10, 20, 30, 40]
The workflow instance has following statuses: 0 - th workflow instance is not started; 10 - the workflow was started and in the active status; 20 - the workflow instance was completed; 30 - the workflow instance was canceled; 40 - the workflow instance was terminated
The flag that show that the workflow instance was started
The flag that show that the workflow instance was completed
The flag that show that the workflow instance was terminated
The id of the workflow template
The id of the workflow template version
The workflow version index
Possible values: [default, system, tutorial]
The workflow instance has three groups: default - the regular workflow instance that is launched by a tenant user; system - the workflow instance that the system launched when the client user tries to launch workflow to the tenant users; tutorial - the workflow that is created by a Trisk for launch a tutorial for a user
Possible values: [clients, tenants]
The workflow instance always has an owner, for default and system group it is a client, for tutorial - tenant
If the owner of the workflow instance is a client - client id, if the tenant - tenant id
The date and time when the workflow instance was created
The date and time when the workflow instance was last time updated
The date and time when the workflow instance was completed
The date and time when the workflow instance was terminated
The date and time of the workflow instance due date
relationships
object
owner
object
data
object
The type of the client
The client id in the UUIDv4 format
attributes
object
The client name
The mode when the tenant can be as a client
Indicate if the client has a members
The date and time when the client was created
The date and time when the client was last time changed
The date and time when the client was archived
The date and time when the client will be fully removed from a system
{
"data": [
{
"type": "task_instances",
"id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
"attributes": {
"reference": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
"name": "Simple Task Name",
"description": "Simple Task Description",
"assignee_id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
"assignee_type": "users",
"assignee_types_allowed": [
"users"
],
"active": true,
"reopenable": true,
"rejectable": true,
"reassignable": true,
"executable": true,
"completed": true,
"properties": {
"buttons": {
"forward": {
"label": "Submit"
},
"backward": {
"label": "Submit"
}
},
"webhook": {
"events": [
"string"
],
"endpoint": "string"
},
"transitions": {
"finish": true,
"forward": "d89bfd4b-61df-479a-84c1-614e4440865a",
"initial": true,
"backward": "t318a31a-0bcf-48d1-9350-a6ae499007c0"
},
"access_roles": {
"read": [
"80ff61b8-4f08-4f8f-a7ea-63c6b41d42e5"
],
"write": [
"80ff61b8-4f08-4f8f-a7ea-63c6b41d42e5"
],
"assign": "80ff61b8-4f08-4f8f-a7ea-63c6b41d42e5",
"execute": [
"80ff61b8-4f08-4f8f-a7ea-63c6b41d42e5"
]
},
"capabilities": {
"wizard": {
"enabled": true
},
"history": {
"enabled": true
},
"notices": [
{
"interval": "PT30M"
}
],
"comments": {
"level": {
"artifact": {
"visibility": "private"
}
}
},
"coworking": {
"enabled": true
},
"reminders": [
{
"interval": "PT30M"
}
],
"data_transfers": [
{
"id": "string"
}
],
"due_date_settings": {
"days": "1",
"type": "absolute",
"month": "string"
},
"due_dates_managing": {
"enabled": true
}
},
"access_tokens": {
"data_source": [
"string"
]
},
"additional_data": {},
"notifications_templates": {
"assign_task": "defde76c-3f1d-4b24-8929-87ed70ea23d6",
"assign_task_batch": "3415f91d-a54c-455b-8ee3-51227dbe4f40"
},
"access_tokens_instructions": [
{
"task_reference": "3415f91d-a54c-455b-8ee3-51227dbe4f40",
"instructions": [
{
"source_identity": "3415f91d-a54c-455b-8ee3-51227dbe4f40",
"identifier": "string"
}
],
"artifact_name": "string",
"container_name": "string",
"field_references": [
"string"
],
"field_identifier_reference": "string",
"launched_task_instances": [
{
"container_instance_id": "3415f91d-a54c-455b-8ee3-51227dbe4f40",
"process_instance_id": "3415f91d-a54c-455b-8ee3-51227dbe4f40"
}
]
}
],
"related_launch_instructions": [
{
"type": "string",
"task_reference": "string",
"instructions": [
{
"source_identity": "string",
"identifier": "string"
}
],
"artifact_name": "string",
"container_name": "string",
"field_references": [
"string"
],
"field_identifier_reference": "string",
"processed": [
{
"email": "string",
"flow_instance_id": "string",
"container_instance_id": "string",
"process_instance_id": "string",
"task_instance_id": "string",
"identifier": "string"
}
]
}
]
},
"artifact": {},
"scope": "past_due",
"has_pending_reopen_request": true,
"due_date": "2018-08-13T14:07:32+00:00",
"created_at": "2016-01-01 12:00:00",
"updated_at": "2016-01-01 12:00:00",
"completed_at": "2016-01-01 12:00:00"
},
"relationships": {
"artifact": {
"data": {}
},
"assignee": {
"data": {
"type": "assignees",
"id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
"attributes": {
"type": "users",
"scope": "tenant",
"email": "string",
"archived_at": "2016-01-01 12:00:00"
},
"relationships": {
"profile": {
"data": {
"type": "users_profile",
"id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
"attributes": {
"first_name": "John",
"last_name": "Doe",
"avatar": "string",
"phone_code": "1",
"phone_number": "(111) 111-11-11",
"position": "string",
"created_at": "2016-01-01 12:00:00",
"updated_at": "2016-01-01 12:00:00"
}
}
}
}
}
},
"process_instances": {
"data": {
"type": "process_instances",
"id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
"attributes": {
"reference": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
"name": "Simple process instance",
"description": "Simple process instance description",
"properties": {
"capabilities": [
{
"conditional_run": {
"seeds": {
"artifact": {
"id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
"type": "form",
"parameters": {
"version_id": "aa18a31a-0bcf-48d1-9350-a6ae49900111"
}
}
},
"source": {
"node": "containerInstanceService",
"nested": {
"node": "processInstanceService",
"nested": {
"node": "taskInstanceService",
"nested": {
"node": "artifactService",
"nested": {
"node": "formulaInstanceService",
"reference": "55a894bd-ac4a-4f26-bbd2-b7a549d921c"
},
"reference": "55a894bd-ac4a-4f26-bbd2-b7a549d921c"
},
"reference": "55a894bd-ac4a-4f26-bbd2-b7a549d921c"
},
"reference": "55a894bd-ac4a-4f26-bbd2-b7a549d921c"
},
"reference": "55a894bd-ac4a-4f26-bbd2-b7a549d921c"
},
"target": {
"task_reference": "edf2456e-e3db-449f-9613-a6938adb3417"
},
"weight": 1,
"source_id": "string"
},
"target": {
"type": "string",
"flow_id": "string",
"version_id": "string",
"container_reference": "string",
"definition_reference": "string"
}
}
]
},
"started": true,
"completed": true,
"created_at": "2016-01-01 12:00:00",
"updated_at": "2016-01-01 12:00:00"
},
"relationships": {
"container_instances": {
"data": {
"type": "container_instances",
"id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
"attributes": {
"reference": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
"name": "Simple container instance",
"type": "default",
"started": true,
"completed": true,
"created_at": "2016-01-01 12:00:00",
"updated_at": "2016-01-01 12:00:00",
"completed_at": "2016-01-01 12:00:00"
},
"relationships": {
"flow_instances": {
"data": {
"type": "flow_instances",
"id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
"attributes": {
"name": "Simple flow instance",
"identifier": "flow-instance-identifier",
"display_name": "Simple flow instance",
"status": 10,
"started": true,
"completed": true,
"terminated": true,
"reference": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
"version_reference": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
"version_index": "1",
"group": "default",
"owner_type": "clients",
"owner_id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
"created_at": "2016-01-01 12:00:00",
"updated_at": "2016-01-01 12:00:00",
"completed_at": "2016-01-01 12:00:00",
"concluded_at": "2016-01-01 12:00:00",
"due_date": "2016-01-01 12:00:00"
},
"relationships": {
"owner": {
"data": {
"type": "clients",
"id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
"attributes": {
"name": "Simple client",
"is_simulation": true,
"has_members": true,
"created_at": "2016-01-01 12:00:00",
"updated_at": "2016-01-01 12:00:00",
"archive_at": "2016-01-01 12:00:00",
"remove_at": "2016-01-01 12:00:00"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
]
}
Unauthorized exception
- application/vnd.api+json
- Schema
- Example (from schema)
Schema
The response status code of the error
The title of the error
{
"status": 401,
"code": 0,
"title": "Unauthorized"
}
That means something has gone wrong on the server, and the server returns more specific about what the exact problem is
- application/vnd.api+json
- Schema
- Example (from schema)
Schema
The type of the error
The status of the error
The title of the error
The request body
The internal trace
{
"id": {},
"type": "errors",
"links": [
"string"
],
"status": 0,
"code": 0,
"title": "string",
"detail": "string",
"source": {},
"meta": {}
}