Skip to main content

Create discussion

POST 

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

The discussion can be left only 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

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

Body

    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

    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

  • ]

  • ]

Responses

The request was successful

Schema

    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

  • ]

  • ]

Loading...