Update task instance

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

Update task instance

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

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

application/vnd.api+json

Body

data

object

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

data_instances

object

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

]

]

Responses

200

The "true" value of the acknowledge means that the request is correct and the "false" is incorrect

application/vnd.api+json

Schema

Schema

acknowledge boolean

The value of the acknowledge

Example (from schema)

{
  "acknowledge": true
}

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...