List discussions

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

The list of the discussions that left in the Fill Form and Form Approval

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 Task instances discussions
Example: discussion_instances.author.profile
filter objectrequired

Discussions can be filtered by the field instance

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

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

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

]

Example (from schema)

{
  "data": {
    "type": "field_instances",
    "id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
    "attributes": {
      "title": "Simple Field Name",
      "type": "text",
      "reference": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
      "after": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
      "printable": true,
      "invisible": true,
      "created_at": "2016-01-01 12:00:00",
      "updated_at": "2016-01-01 12:00:00"
    },
    "relationships": {
      "discussion_instances": {
        "data": [
          {
            "type": "form_instances_section_instances_field_instances_discussion_instances",
            "id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
            "attributes": {
              "author_id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
              "author_type": "users",
              "text": "Discussion text",
              "resolvable": true,
              "resolved": true,
              "created_at": "2016-01-01 12:00:00",
              "updated_at": "2016-01-01 12:00:00"
            },
            "relationships": {
              "author": {
                "data": {
                  "type": "authors",
                  "id": "t318a31a-0bcf-48d1-9350-a6ae499007c0",
                  "attributes": {
                    "type": "users",
                    "scope": "string",
                    "email": "example@example.com",
                    "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...