(Quick Reference)
Service: List objectives
Description: This web service return the list of objectives in JSON format.
URL:
https://BASE_URL/api/VERSION/objectives
: GET
Parameters:
Pagination parameters:
| Name | Description | Type | Required | Possible values |
|---|
| offset | Tells where to start returning records from the entire set of results. | Integer | No | |
| max | Limits the number of resources requested to return. | Integer | No | |
| sort | Orders the results by the specified field. | String | No | |
| order | Orders ascending or descending | Integer | No | asc, desc |
Filters parameters:
| Name | Description | Type | Required | Example values |
|---|
| dateCreated_gt | Filters by the resource's creation date time and operator greater than | Date | no | 2016-08-15T14:52:48Z |
| dateCreated_gte | Filters by the resource's creation date time and operator greater than or equal | Date | no | |
| dateCreated_lt | Filters by the resource's creation date time and operator less than | Date | no | |
| dateCreated_lte | Filters by the resource's creation date time and operator less than or equal | Date | no | |
| lastUpdated_gt | Filters by the resource's last-modified date time and operator greater than | Date | no | |
| lastUpdated_gte | Filters by the resource's last-modified date time and operator greater than or equal | Date | no | |
| lastUpdated_lt | Filters by the resource's last-modified date time and operator less than | Date | no | |
| lastUpdated_lte | Filters by the resource's last-modified date time and operator less than or equal | Date | no | |
| type | Filters by the type of objective | Integer | no | 2,3,4 |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Success case: response.status=200
{
"paging": {
"total": 4,
"max": 5,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"id": 2,
"employeeReference": "emp-04",
"employee": {
"id": 4,
"reference": "emp-04",
"href": "/api/v1.0/users/4"
},
"itemReference": "bracelet-GRP09062",
"item": {
"id": 497,
"reference": "bracelet-GRP09062",
"name": "Knot Band Bracelet",
"href": "/api/v1.0/items/497"
},
"year": 2016,
"type": "4",
"januaryValue": 40,
"februaryValue": 40,
"marchValue": 40,
"aprilValue": 45,
"mayValue": 45,
"juneValue": 45,
"julyValue": 50,
"augustValue": 50,
"septemberValue": 50,
"octoberValue": 50,
"novemberValue": 50,
"decemberValue": 55,
"organization": "entity1",
"dateCreated": "2016-02-01T13:39:01Z",
"lastUpdated": "2016-02-01T13:39:01Z"
},…
]
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
