You can retrieve multiple types of includes by chaining the query parameter values:
?include=totalCount,embedded,links.About Embedded
When adding?include=embedded to your HTTP GET requests, the Lucca API will attempt to include the representations of related resource in the response. For example: you may retrieve the first and last name of the employee when retrieving his leaves.
Notes:
- Embedded resources may not actually be included in responses if you do not have access to them.
- The included representation may be partial, i.e. only give you a subset of the resource properties.
- It may also be stale from cache in the very short term.
- You cannot choose which resources to embed. The list of available resources is dictated by each API endpoint. Including embedded resource is a binary affair: do include them, or do not.
type (e.g. leave, employee, etc…) then by id.
About Links
Links are objects that represent navigational references to other resources and/or actions on the target resource. Examples are:- links to the previous and next pages of a collection.
- link to the approval process of a leave-request.
include query parameter.
Links come in three shapes, depending on what they lead to.
Links to Resources and Actions
Most links only hold anhref: the absolute URL of the related resource or action, to follow as is rather than build yourself. A null link means the resource or action is not available to you.
Paging Links
On a collection,links.prev and links.next lead to the previous and next pages. Besides href, they hold the cursor of that page. Read more in Paging.
File Links
A resource that references files, such as an employment’sdocument, an employee’s portrait or an employee-attribute whose value is a file, returns one download link per file under links.files, indexed by file id. The url of a file reference does not give access to the file: go through its link.
- Read the resource with
?include=links, and take the entry oflinks.fileswhose key is theidof the file reference. Every file reference has an entry, wherever it sits in the resource. - Follow its
hrefwith the sameAuthorizationheader. Your access token needs thefiles.readonlyscope: thetokeninhrefonly grants access to this one file, for your API client, and does not authenticate you on its own. - The response holds the file content whatever your
Acceptheader, with its name and content type in theContent-DispositionandContent-Typeheaders.