Atoka API User Reference
CIGS measures package "Base"
API tokens are configured to access only the packages each user needs; this means you might not have access to the content of this package. Ask your sales contact!
Available fields | Description | Data | Used by filters | Facet | Match | Stats |
|---|---|---|---|---|---|---|
| company.id | The id of the company; it can be used to retrieve information from the Companies endpoint | "string" | companies | |||
| reason.code | code of the CIGS reason | "string" | - | |||
| reason.description | description of the CIGS reason | "string" | - | |||
| sites[] | sites involved in the CIGS | "string" | - | |||
| states[].endDate | in this state up to this date | date | - | |||
| states[].label | state label (english) | "string" | - | |||
| states[].startDate | in this state starting from this date | date | - | |||
| states[].state | state code | "string" | - |
Example JSON fragment for package
{"company": {"id": "foo" },"sites": ["foo",...],"reason": {"code": "foo", "description": "foo" },"states": [{"state": "foo", "label": "foo", "startDate": "2015-12-24", "endDate": "2015-12-24" },...]}