Add Tasks
  • 16 Oct 2020
  • 2 Minutes To Read
  • Contributors
  • Print
  • Share
  • Dark
    Light

Add Tasks

  • Print
  • Share
  • Dark
    Light

Create Task (by conv_id)

Method for creatin or adding Tasks to processes and state diagrams.

URL

https://api.corezoid.com/api/2/json/{API_LOGIN}/{GMT_UNIXTIME}/{SIGNATURE}

Request Body

{
    "ops": [
        {
            "type": "create",
            "obj": "task",
            "conv_id": {{CONV_ID}},
            "ref": {{REFERENCE}}
            "data": {
                "param": 1
            }
        }
    ]
}
parameter accept type description required possible value
ops JSON Object The list of operations to proceed via Corezoid API. A parameter keeping JSON objects with operations + * The number is user-limited by RPS limit.
type string A type for creating a Task + create
obj string An object type + task
conv_id number / number as string An ID of a Process for which the Task is created + An ID of an existing Process
ref number / string - An external identifier of the task Any characters can be used, the length is limited to the range from 1 to 255 characters and the "ref" parameter must be unique within all active objects of this type
data JSON Object An object with key-value pairs describing necessary parameters + ** The quantity of parameters is not limited

Response Body

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "proc": "ok",
            "obj": "task",
            "ref": "783230_1",
            "obj_id": "5f4d39e0513aa0094458adc9"
        }
    ]
}
Parameter Type Description Possible value
request_proc string The overall processing status of all transactions from the request ok, error
ops array The list of request results
id string A request id empty
proc string The processing status of a specific operation ok, error
obj string An object of request task
ref number An external identifier of the task
obj_id number An internal ID of Task

Create Task (by alias)

Method for creatin or adding Tasks to processes and state diaagrams.

URL

https://api.corezoid.com/api/2/json/{API_LOGIN}/{GMT_UNIXTIME}/{SIGNATURE}

Request Body

{
    "ops": [
        {
            "type": "create",
            "obj": "task",
            "obj_alias": {{ALIAS_SHORT_NAME}},
            "ref": {{REFERENCE}}
            "data": {
                "param": 1
            },
            "company_id": {{COMPANY_ID}}
        }
    ]
}
parameter accept type description required possible value
ops JSON Object The list of operations to proceed via Corezoid API. A parameter keeping JSON objects with operations + * The number is user-limited by RPS limit.
type string A type for creating a Task + create
obj string An object type + task
obj_alias string An ID of a Process for which the Task is created + An ID of an existing Process
ref number / string - An external identifier of the task Any characters can be used, the length is limited to the range from 1 to 255 characters and the "ref" parameter must be unique within all active objects of this type
data JSON Object + An object with key-value pairs describing necessary parameters The quantity of parameters is not limited
company_id string + An ID of a Company An ID of an existing Company

Response Body

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "proc": "ok",
            "obj": "task",
            "ref": "1598950142_2",
            "obj_id": "5f4e0ed556167c5fdb000268"
        }
    ]
}
Parameter Type Description Possible value
request_proc string The overall processing status of all transactions from the request ok, error
ops array The list of request results
id string A request id empty
proc string The processing status of a specific operation ok, error
obj string An object of request task
ref number An external identifier of the task
obj_id number An internal ID of Task
Was This Article Helpful?