(Quick Reference) Service: List objectives

Description: This web service return the list of objectives in JSON format.

URL:

https://BASE_URL/api/VERSION/objectives

Method: GET

Parameters:

Pagination parameters:

NameDescriptionTypeRequiredPossible values
offsetTells where to start returning records from the entire set of results.IntegerNo 
maxLimits the number of resources requested to return.IntegerNo 
sortOrders the results by the specified field.StringNo 
orderOrders ascending or descendingIntegerNoasc, desc

Filters parameters:

NameDescriptionTypeRequiredExample values
dateCreated_gtFilters by the resource's creation date time and operator greater thanDateno2016-08-15T14:52:48Z
dateCreated_gteFilters by the resource's creation date time and operator greater than or equalDateno 
dateCreated_ltFilters by the resource's creation date time and operator less thanDateno 
dateCreated_lteFilters by the resource's creation date time and operator less than or equalDateno 
lastUpdated_gtFilters by the resource's last-modified date time and operator greater thanDateno 
lastUpdated_gteFilters by the resource's last-modified date time and operator greater than or equalDateno 
lastUpdated_ltFilters by the resource's last-modified date time and operator less thanDateno 
lastUpdated_lteFilters by the resource's last-modified date time and operator less than or equalDateno 
typeFilters by the type of objectiveIntegerno2,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..."
}