Modify Task
  • 16 Oct 2020
  • 1 Minute To Read
  • Contributors
  • Print
  • Share
  • Dark
    Light

Modify Task

  • Print
  • Share
  • Dark
    Light

Modify Task

Method for modifing Task data.

Note : You can't modify tasks in final nodes (in processed status)

Note : The method searches for Task by identifier and reference, but the reference is more priority. If you pass the reference and the identifier of two different Tasks in the request body, then the response will contain the data of the Task to which the reference belongs.

URL

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

Request Body

{
  "ops": [
    {
      "type": "modify",
      "obj": "task",
      "ref": {{TASK_REFERENCE}},
      "obj_id": {{TASK_ID}},
      "conv_id": {{CONV_ID}},
      "data": {
        "foo": "bar"
      },
      "company_id": {{COMPANY_ID}}
    }
  ]
}
Parameter Type Required Description 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 request type modify
obj string + An object of request task
ref string one of ref or obj_id required --- ---
obj_id string one of ref or obj_id required An ID of task that you want to get data An ID of an existing Process or State diagram
conv_id number + An ID of a Process for which the Task is created An ID of an existing Process
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": "15989649323554",
            "obj_id": "5f4e44c682ba9635bf66e1d7"
        }
    ]
}
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 string An external identifier of the task
obj_id string An internal ID of Task
Was This Article Helpful?