Versions Compared

Key

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

...

The term "data" is an alias for the name of the request resource. For example, if the a call was made to retrieve data on a timerecords resource, then the name of the returned "data" object would be "time recordstimerecords".  Below is a representation of what the data object may look like in the response for a collection of timerecords resources.

"timerecords" : [{

"id" : "533",
"startTimestamp" : "2014-07-23T15:09:46+12:00",
"notes" : null,
"actualHours" : "1.00",
"billableHours" : "1.00",
"links" : {

"owner" : "120"

}

} , {

"id" : "539",
"startTimestamp" : "2014-07-30T13:21:19+12:00",
"notes" : null,
 "actualHours" : "0.17",
"billableHours" : "10.00",
"links"  : {

"owner" : "14"

}

}]

Every resource return in the "data" object will include an "id" attribute which is the unique identifier for that resource object. Resource objects may also have a "links" attribute which catalogue the "ids" of related resources for which the top-level "links" object details URL templates for those resources.

Linked

The linked object is a collection of resource objects, grouped by type, that are linked to the primary resource and/or to each other. These objects appear in the response as defaults set by the primary resource or specifically requested using the "include" parameter. Below is a representation of what the linked object may look like in a response.

...