Common request records
These records are reused across different API calls.
Address
Field | Type | JSON Type | Required | Can be null |
Description |
---|---|---|---|---|---|
|
String |
String |
No |
No |
Full address string. Limited to 5000 characters |
|
Object |
No |
No |
Full address as one string |
|
|
String |
String |
No |
Yes |
Apartment. Limited to 50 characters |
|
String |
String |
No |
Yes |
Floor. Limited to 50 characters |
|
String |
String |
No |
Yes |
Entrance. Limited to 50 characters |
|
String |
String |
Yes |
Yes |
Optional string description. It usually contains some information helping locating the site. Limited to 500 characters |
Client
Reference a client by uuid
or external_id
. These fields are mutually exclusive.
Field | Type | JSON Type | Required | Can be null |
Description |
---|---|---|---|---|---|
|
UUID |
String |
No |
No |
Client identifier |
|
String |
String |
No |
No |
Client identifier in an external system |
Site
Reference a site by uuid
or external_id
. These fields are mutually exclusive.
Field | Type | JSON Type | Required | Can be null |
Description |
---|---|---|---|---|---|
|
UUID |
String |
No |
No |
Site identifier |
|
String |
String |
No |
No |
Site identifier in an external system |
Assignee
Job assignee is either a single worker or a team. worker
and team
keys are mutually exclusive.
Field | Type | JSON Type | Required | Can be null |
Description |
---|---|---|---|---|---|
|
Record |
Object |
No |
No |
|
|
UUID |
String |
No |
No |
Worker identifier |
|
String |
No |
No |
Emails are unique, it is possible to use them for referencing workers |
|
|
Record |
Object |
No |
No |
|
|
UUID |
String |
No |
No |
Team identifier |
|
String |
String |
No |
No |
Team names are unique |
Job template
Field | Type | JSON Type | Required | Can be null |
Description |
---|---|---|---|---|---|
|
UUID |
String |
No |
No |
Template identifier |
Job type
Field | Type | JSON Type | Required | Can be null |
Description |
---|---|---|---|---|---|
|
UUID |
String |
No |
No |
Job type identifier |
|
String |
String |
No |
No |
Job type name |
Contact
Field | Type | JSON Type | Required | Can be null |
Description |
---|---|---|---|---|---|
|
String |
String |
No |
Yes |
Contact name. Limited to 50 characters |
|
String |
String |
No |
Yes |
Contact string. Limited to 50 characters. |
|
String |
String |
Yes |
No |
Only |
Resolution
Field | Type | JSON Type | Required | Can be null |
Description |
---|---|---|---|---|---|
|
UUID |
String |
No |
No |
Resolution identifier |
|
String |
String |
No |
No |
Resolution name |
Territory
Field | Type | JSON Type | Required | Can be null |
Description |
---|---|---|---|---|---|
|
UUID |
String |
No |
No |
Territory identifier |
|
String |
String |
No |
No |
Territory name |
Skill
Field | Type | JSON Type | Required | Can be null |
Description |
---|---|---|---|---|---|
|
UUID |
String |
No |
No |
Skill identifier |
|
String |
String |
No |
No |
Skill name |
Dictionary value
Field | Type | JSON Type | Required | Can be null |
Description |
---|---|---|---|---|---|
|
UUID |
String |
No |
No |
Dictionary item identifier |
|
String |
String |
No |
No |
Name of dictionary item |
Custom field
To set a value of a custom field, pass either its uuid
or name
. You can get these values from the job template response.
Field | Type | JSON Type | Required | Can be null |
Description |
---|---|---|---|---|---|
|
UUID |
String |
No |
No |
Field identifier |
|
String |
String |
No |
No |
Field name |
|
Mixed |
Mixed |
Yes |
No |
|
data_type |
JSON type of value |
Can be null |
Description |
---|---|---|---|
|
String |
Yes |
|
|
Yes |
Dictionary value referenced by |
|
|
Yes |
File value
Field | Type | JSON Type | Required | Can be null |
Description |
---|---|---|---|---|---|
|
String |
String |
Yes |
No |
File name |
|
String |
String |
Yes |
No |
Base64-encoded file content |