Get task instances

GET 
/flow_instances/:flowInstanceId/relationships/container_instances/:containerInstanceId/relationships/process_instances/:processInstanceId/relationships/task_instances/:taskInstanceId

Get task instances

Request

Path Parameters

flowInstanceId stringrequired
The workflow instance id
Example: aa18a31a-0bcf-48d1-9350-a6ae49900111
containerInstanceId stringrequired
The container instance id
Example: t318a31a-0bcf-48d1-9350-a6ae499007c0
processInstanceId stringrequired
The process instance id
Example: defde76c-3f1d-4b24-8929-87ed70ea23d6
taskInstanceId stringrequired
The task instance id
Example: 3415f91d-a54c-455b-8ee3-51227dbe4f40

Query Parameters

include string
The attributes that will be returned together with the task instance
Example: artifact,assignee.profile,process_instances.container_instances.flow_instances.owner.profile

Header Parameters

X-Domain stringrequired

Every request should has X-Domain Header, in the UUIDv4 format. The X-Domain can be get from the Tenant Integrations page

X-API-KEY stringrequired

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

X-API-SECRET stringrequired

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

The request was successful

application/vnd.api+json

Schema

Schema

data

object

type string

The type of the task instance

id string

The task instances id in the UUIDv4 format

attributes

object

reference string

The task reference in the UUIDv4 format

name string

Task instance name

description string

Task instance description

assignee_id string

Id of the user who selected as assignee

assignee_type string

Possible values: [users, external_users]

The type of the user who selected as assignee

active boolean

The flag that show is it task instance in the active status

reopenable boolean

The flag that show is current user has permission to reopen this task instance

rejectable boolean

The flag that show is current user has permission to reject this task instance

reassignable boolean

The flag that show is current user has permission to reassign this task instance

executable boolean

The flag that show is current user has permission to execute this task instance

completed boolean

The flag that show is it task instance completed or not

canceled boolean

The flag that show is current task instance canceled or not

read_only boolean

The flag that show is current task instance read only or can be changed

properties

object

buttons

object

forward

object

label string

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

label string

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

events string[]

Type of the events that will trigger a webhook. In current moment available only task instance completed event available

endpoint string

Your unique URL where is a webhook listener

transitions

object

finish boolean

The flag that show is this task instance the last task in the workflow

forward string

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

initial boolean

The flag that show is this task instance the first task in the workflow

backward string

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

read string[]

Shows id of the roles which users can view current task instance

write string[]

Shows id of the roles which users can change current task instance

assign string

The id of the user who is a assignee of the current task instance

execute string[]

Shows id of the roles which users can complete/execute current task instance

capabilities

object

wizard

object

Deprecated capability

enabled boolean

history

object

enabled boolean

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

Array [

interval string

Days after the due date

]

comments

object

level

object

artifact

object

visibility string

Possible values: [private, public]

In the Trisk available two types of the comments, private and public.

coworking

object

enabled boolean

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

Array [

interval string

Days in advance to the due date

]

data_transfers

object[]

Deprecated capability

Array [

id string

]

due_date_settings

object

days string

Days to the due date

type string

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

month string

The month when the due date reached if selected actual type of the due date

due_dates_managing

object

enabled boolean

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

data_source string[]

additional_data

object

The data used for a tutorials

notifications_templates

object

assign_task string

The id of the notification template that will be send when the task instance will be assigned to the user

assign_task_batch string

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

Array [

task_reference string

instructions

object[]

Array [

source_identity string

identifier string

]

artifact_name string

container_name string

field_references string[]

field_identifier_reference string

launched_task_instances

object[]

Array [

container_instance_id string

process_instance_id string

]

]

related_launch_instructions

object[]

Array [

type string

task_reference string

instructions

object[]

Array [

source_identity string

identifier string

]

artifact_name string

container_name string

field_references string[]

field_identifier_reference string

processed

object[]

Array [

email string

flow_instance_id string

container_instance_id string

process_instance_id string

task_instance_id string

identifier string

]

]

artifact

object

oneOf

TaskInstance.Artifact.FillForm

id string

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

type string

For a Fill Form type of the artifact is a form

parameters

object

version_id string

The id of the Form version

TaskInstance.Artifact.FormApprove

id string

The id of the Fill Form task

type string

For a Form Approve type of the artifact is a task_approve

TaskInstance.Artifact.SmartContract

id string

The id of the Smart Contract that saved in our system

type string

Type of the artifact

parameters

object

method string

The method of the Smart Contract that was selected on task creation step

inputs

object[]

Inputs of the selected method

Array [

input string

Name of the input

target_id string

The id of the selected target type

target_type string

Possible values: [form, data_dictionary, smart_contract]

The Smart Contract supported Fill Form, Data Dictionary, and other Smart contract as target type

input_argument string

If the selected Smart Contract as a target type, in the input_argument should be selected Parameter Argument from the selected Smart Contract

task_reference string

The reference of the task instance

]

outputs

object[]

Outputs of the Smart Contract

Array [

output string

The method of the Smart Contract

target_id string

The id of the selected target type

target_type string

Possible values: [form, data_dictionary, smart_contract]

The Smart Contract supported Fill Form, Data Dictionary, and other Smart contract as target type

output_argument string

If the selected Smart Contract as a target type, in the output_argument should be selected Parameter Argument from the selected Smart Contract

task_reference string

The reference of the task instance

]

scope string

Possible values: [past_due, this_week, on_schedule]

The indication in the which scope will task instance due date reached

has_pending_reopen_request boolean

The flag that show is this task instance has not completed reopen requests

due_date string

The date and time when the task instance due date will be reached

created_at string

The date and time when the task instance was completed

updated_at string

The date and time when the task instance was changed

completed_at string

The date and time when the task instance was completed

relationships

object

artifact

object

data

object

oneOf

FormInstance.Full

type string

The instance of the form template

id string

The id of the form instance

attributes

object

name string

The form instance name

owner_type string

Possible values: [task_instance]

The type of the owner for a form instance. Only task instance can be an owner

owner_id string

The id of the task instance

created_at string

The date and time when the form instance was created

updated_at string

The date and time when the form instance was last time updated

relationships

object

section_instances

object

The instance of the section

data

object[]

Array [

type string

id string

The id of the section instance

attributes

object

name string

The name of the section instance

after string

The id of the section instance after which the current section instance is placed in the form. If the section instance is first in the form instance, the value will be null

printable boolean

The flag that indicate that the section instance will not or will be shown in the print

reference string

The reference of the section

created_at string

The date and time when the form instance was created

updated_at string

The date and time when the form instance was last time updated

relationships

object

field_instances

object

The instance of the field

data

object[]

Array [

type string

id string

The id of the field instance

attributes

object

title string

The title of the field instance

type string

Possible values: [checkbox, date, file, html, label, radio, select, service_file, slider, text, textarea]

The system supported a few types of the fields

reference string

The reference of the field

after string

The id of the field instance after which the current filed instance is placed in the section instance. If the field instance is first in the section instance, the value will be null

printable boolean

The flag that indicate that the field instance will not or will be shown in the print

invisible boolean

The flag that indicates that the filed instance will not or will be shown in the Fill Form

created_at string

The date and time when the field instance was created

updated_at string

The date and time when the field instance was last time updated

relationships

object

parameter_instances

object

The parameter instance of the field instance, like description

data

object[]

Array [

type string

id string

The id of the filed instance parameter instance

attributes

object

attribute string

The supported attributes of the parameters for filed instance relate to the field instance type. Can be: description, help_message, required, etc

value string

The value related to the selected attribute

]

option_instances

object

The option instance of the field instance, like answers to the radio field

data

object[]

Array [

type string

id string

The id of the filed instance option instance

attributes

object

reference string

The reference of the filed attribute property

label string

The label of the filed instance option

weight integer

The weight used to sort the properties in the option instance

]

data_instances

object

The data that was filled to the field instance

data

object[]

Array [

type string

id string

Tbe if of the grouper instance

attributes

object

value string

The value of the data instance

value_reference string

The value reference of the data instance

weight integer

The weight used to sort the properties in the data instance

]

attachment_instances

object

The instance of the attached files to the field instance type file

data

object[]

Array [

type string

id string

The id of the data instance

attributes

object

name string

The name of the attached instance

url string

The URL where placed the attached instance

]

service_file_instances

object

The instance of the files attached to the field instance type service_file

data

object[]

Array [

type string

id string

The id of the attachment instance

attributes

object

name string

The name of the service instance file

url string

The URL where placed the service file instance

]

discussion_instances

object

The instance of the discussions that was left to the field instance

data

object[]

Array [

type string

id string

The id of the service instance file

attributes

object

author_id string

The id of the author of the discussion instance

author_type string

The type of the author of the discussion instance

text string

The text of the discussion instance

resolvable boolean

The flag that show that discussion can be resolved or not

resolved boolean

The flag that show that discussion resolved or not

created_at string

The date and time when the discussion instance was created

updated_at string

The date and time when the discussion instance was last time updated

relationships

object

author

object

The user who leaves the discussion

data

object

type string

Author it is a user who create entity

id string

The id of the user who create entity

attributes

object

type string

The type of the author of the discussion instance

scope string

The scope of the author of the discussion instance

email string

The email of the author of the discussion instance

archived_at string

The date and time when the author of the discussion instance was archived

relationships

object

profile

object

data

object

type string

id string

The id of the profile registered user

attributes

object

first_name string

The user first name

last_name string

The user last name

avatar string

The user avatar in the JPG, PNG, and max size of 5Mb

phone_code string

The international phone code

phone_number string

The phone number of the user

position string

This field is a string and can be used as a position of the user in the company or some other information

created_at string

The date and time of the user creation

updated_at string

The date and time when the info in the user profile was changed

]

comment_instances

object

The instance of the comments that was left to the field instance

data

object[]

Array [

type string

id string

The id of the discussion instance

attributes

object

text string

The text of the comment instance

public boolean

The flag that indicate that the comment is private or public

relationships

object

author

object

The user who leaves the comment

data

object

type string

Author it is a user who create entity

id string

The id of the user who create entity

attributes

object

type string

The type of the author of the discussion instance

scope string

The scope of the author of the discussion instance

email string

The email of the author of the discussion instance

archived_at string

The date and time when the author of the discussion instance was archived

relationships

object

profile

object

data

object

type string

id string

The id of the profile registered user

attributes

object

first_name string

The user first name

last_name string

The user last name

avatar string

The user avatar in the JPG, PNG, and max size of 5Mb

phone_code string

The international phone code

phone_number string

The phone number of the user

position string

This field is a string and can be used as a position of the user in the company or some other information

created_at string

The date and time of the user creation

updated_at string

The date and time when the info in the user profile was changed

]

representation_instance

object

The description of the how the field will be represented in the Form Approval task instance

data

object[]

Array [

type string

id string

The id of the comment instance

attributes

object

title string

The title representation for a field instance in the From Approve task instance

description string

The description representation for a field instance in the From Approve task instance

help_message string

The help message representation for a field instance in the From Approve task instance

]

]

grouper_instances

object

The instance of the table and active table

data

object[]

Array [

type string

id string

The id of the grouper instance

attributes

object

name string

The name of the grouper instance

type string

The type of the grouper instance: table or active_table

reference string

The reference of the grouper

after string

The id of the field instance after which the current grouper instance is placed in the form. If the grouper instance is first in the section instance, the value will be null

printable boolean

The flag that indicate that the grouper instance will not or will be shown in the print

created_at string

The date and time when the form instance was created

updated_at string

The date and time when the form instance was last time updated

relationships

object

type_parameter_instances

object

data

object[]

Array [

type string

id string

The id of the type parameter instance

attributes

object

attribute string

Described which attribute is describes: row or column

column string

size string

The size of the row or column

weight integer

The index number of the column or row

value string[]

]

parameter_instances

object

data

object[]

Array [

type string

id string

The id of the filed instance parameter instance

attributes

object

attribute string

The supported attributes of the parameters for filed instance relate to the field instance type. Can be: description, help_message, required, etc

value string

The value related to the selected attribute

]

field_instances

object

data

object[]

Array [

type string

id string

The id of the field instance

attributes

object

title string

The title of the field instance

type string

Possible values: [checkbox, date, file, html, label, radio, select, service_file, slider, text, textarea]

The system supported a few types of the fields

reference string

The reference of the field

after string

The id of the field instance after which the current filed instance is placed in the section instance. If the field instance is first in the section instance, the value will be null

printable boolean

The flag that indicate that the field instance will not or will be shown in the print

invisible boolean

The flag that indicates that the filed instance will not or will be shown in the Fill Form

created_at string

The date and time when the field instance was created

updated_at string

The date and time when the field instance was last time updated

]

discussion_instances

object

data

object[]

Array [

type string

id string

The id of the service instance file

attributes

object

author_id string

The id of the author of the discussion instance

author_type string

The type of the author of the discussion instance

text string

The text of the discussion instance

resolvable boolean

The flag that show that discussion can be resolved or not

resolved boolean

The flag that show that discussion resolved or not

created_at string

The date and time when the discussion instance was created

updated_at string

The date and time when the discussion instance was last time updated

relationships

object

author

object

The user who leaves the discussion

data

object

type string

Author it is a user who create entity

id string

The id of the user who create entity

attributes

object

type string

The type of the author of the discussion instance

scope string

The scope of the author of the discussion instance

email string

The email of the author of the discussion instance

archived_at string

The date and time when the author of the discussion instance was archived

relationships

object

profile

object

data

object

type string

id string

The id of the profile registered user

attributes

object

first_name string

The user first name

last_name string

The user last name

avatar string

The user avatar in the JPG, PNG, and max size of 5Mb

phone_code string

The international phone code

phone_number string

The phone number of the user

position string

This field is a string and can be used as a position of the user in the company or some other information

created_at string

The date and time of the user creation

updated_at string

The date and time when the info in the user profile was changed

]

comment_instances

object

data

object[]

Array [

type string

id string

The id of the discussion instance

attributes

object

text string

The text of the comment instance

public boolean

The flag that indicate that the comment is private or public

relationships

object

author

object

The user who leaves the comment

data

object

type string

Author it is a user who create entity

id string

The id of the user who create entity

attributes

object

type string

The type of the author of the discussion instance

scope string

The scope of the author of the discussion instance

email string

The email of the author of the discussion instance

archived_at string

The date and time when the author of the discussion instance was archived

relationships

object

profile

object

data

object

type string

id string

The id of the profile registered user

attributes

object

first_name string

The user first name

last_name string

The user last name

avatar string

The user avatar in the JPG, PNG, and max size of 5Mb

phone_code string

The international phone code

phone_number string

The phone number of the user

position string

This field is a string and can be used as a position of the user in the company or some other information

created_at string

The date and time of the user creation

updated_at string

The date and time when the info in the user profile was changed

]

representation_instance

object

data

object[]

Array [

type string

id string

The id of the comment instance

attributes

object

title string

The title representation for a field instance in the From Approve task instance

description string

The description representation for a field instance in the From Approve task instance

help_message string

The help message representation for a field instance in the From Approve task instance

]

]

]

Blockchain.SmartContractInstance

type string

id string

The id of the smart contract in the Trisk

attributes

object

status string

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

owner_id string

The task instance id who launch the smart contract

owner_type string

Possible values: [task]

The type of the owner

input

object[]

Array [

type string

value string

]

output

object

oneOf

MOD1

abi string

hash string

Transaction hash

networkId string

MOD2

to string

Smart contract address

from string

Wallet address

hash string

Transaction hash

events

object[]

Array [

args

object[]

Array [

name string

type string

value string

indexed boolean

]

name string

Event name

]

gasUsed integer

networkId integer

blockNumber integer

effectiveGasPrice integer

relationships

object

errors

object

data

object[]

Array [

type string

id string

The id of the blockchain smart contract instance error

attributes

object

message string

The message of the blockchain smart contract instance error

data string[]

created_at string

The date and time when the blockchain smart contract instance error was created

]

assignee

object

data

object

type string

An assignee is a user who responsible for a task execution

id string

The id of the user who is a assignee

attributes

object

type string

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

scope string

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

email string

The user email

archived_at string

The date and time when the user was archived

relationships

object

profile

object

data

object

type string

id string

The id of the profile registered user

attributes

object

first_name string

The user first name

last_name string

The user last name

avatar string

The user avatar in the JPG, PNG, and max size of 5Mb

phone_code string

The international phone code

phone_number string

The phone number of the user

position string

This field is a string and can be used as a position of the user in the company or some other information

created_at string

The date and time of the user creation

updated_at string

The date and time when the info in the user profile was changed

Example (from schema)

{
  "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",
      "active": true,
      "reopenable": true,
      "rejectable": true,
      "reassignable": true,
      "executable": true,
      "completed": true,
      "canceled": true,
      "read_only": 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": {},
      "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"
                }
              }
            }
          }
        }
      }
    }
  }
}

401

Unauthorized exception

application/vnd.api+json

Schema

Schema

status integer

The response status code of the error

code integer
title string

The title of the error

Example (from schema)

{
  "status": 401,
  "code": 0,
  "title": "Unauthorized"
}

404

The response body of the Not Found Error

application/vnd.api+json

Schema

Schema

status integer

The response status code of the error

code integer
title string

The title of the error

Example (from schema)

{
  "status": 404,
  "code": 404,
  "title": "Not Found"
}

500

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

Schema

id object
type string

The type of the error

links string[]
status integer

The status of the error

code integer
title string

The title of the error

detail string
source object

The request body

meta object

The internal trace

Example (from schema)

{
  "id": {},
  "type": "errors",
  "links": [
    "string"
  ],
  "status": 0,
  "code": 0,
  "title": "string",
  "detail": "string",
  "source": {},
  "meta": {}
}

Loading...