Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

token

The token obtained on connection

Required

companyid

The id of the company to modify.

Required

command

A json containing the task information (see below)

Required

 

JSON format of "data"

...

parameter

Add only the fields you want to change to a json object:

Example to update these 3 fields: { "customfields": …, "labels": …, "status": … }

 

statusSee ApiCodytTask for possible values.Optional
deadlineThe job deadline.Optional
labels

Set a label: "labels": [ { "id": 10, "value": 1 }, … ]

Clear a label: "labels": [ { "id": 10, "value": null }, … ]

See chapter REF _Ref362347538 \r \h 12.5

See Custom labels to get the list of labels.

Optional
customfields

A json array containing a list of custom field ids and values. See below for details.

Example:

customfields: [ { "field": "CustomStr1", "value": "My field" }, { "field": "CustomStr5", "value": "A-2233" } ]

See chapter REF _Ref362517235 \r \h 12.4

See Custom fields to get the list of custom fields.

Optional
assignmentA json containing assignment details (assignment type, person, etc.).Optional

 

JSON format of field "CustomFields"

 

fieldThe custom string id such as 'CustomStr1', 'CustomStr2', etc. Use method settings/customfields to obtain all available ids.Required
valueThe value to set for the custom stringRequired

 

JSON format of field "assignment"

 

modeThe allocation mode. See ApiCodytTask for allocation mode values.Required
kickoffIf True, Always put the job in not started even if it should be inactive. Default value is False.optional
companyidThe company which will do the job. Can be null.optional
personidThe person which will do the job. Can be null.optional

 

RESULTS

None