Read

You can read a collection by accessing the collection resource URL of a parent or a child resource. You can read a singular resource by accessing the individual resource URL of a parent or a child resource.

Read a Parent Resource

To read a parent resource of a collection, access the collection resource.

GET /hcmRestApi/resources/11.13.18.05/workers

To read a parent resource of a singular resource, access the individual resource URL of the parent with the unique identifier.

GET /hcmRestApi/resources/11.13.18.05/workers/00020000000EACED0005

Retrieve Specific Attributes of a Parent Resource

To retrieve specific attributes of a parent resource, use the fields parameter.

GET /hcmRestApi/resources/11.13.18.05/workers?fields=PersonNumber,DateOfBirth

Read a Collection at a Point in Time

To read a date effective resource at a given point in time, access the resource URL with the effectiveDate parameter.

GET /hcmRestApi/resources/11.13.18.05/workers?effectiveDate=2016-02-02

Read a Child Resource

To read a child resource, access the collection resource of the child with the unique identifier.

GET /hcmRestApi/resources/11.13.18.05/workers/00020000000EACED0005/child/nationalIdentifiers

Retrieve Specific Attributes of a Child Resource

To retrieve specific attributes of a child resource, use the fields parameter.

GET /hcmRestApi/resources/11.13.18.05/workers?fields=PersonNumber,DateOfBirth;names:FirstName;names:LastName;workRelationships:LegalEmployerName;workRelationships.assignments:AssignmentNumber

Add or Remove Attributes from a Child Resource

To add specific attributes, in the fields parameter, prefix the resource attributes with %2B. To remove specific attributes, prefix the resource attributes with -.

GET /hcmRestApi/resources/11.13.18.05/areasOfResponsibility?fields=%2BBusinessUnitName,%2BLocationName,-ResponsibilityId,-LocationId

Expand Child Resources

To reduce the number of API calls, you can retrieve child resources in-line for resources.. Use the expand parameter and specify the child resources.

GET /hcmRestApi/resources/11.13.18.05/workers?expand=names,workRelationships.assignments

To expand all the child resources, use the keyword all. You can retrieve nested child resources across multiple levels.

GET /hcmRestApi/resources/11.13.18.05/workers?expand=all

Limit Links Returned

To exclude all the links in the response and thereby reduce the size of the response, use the onlyData parameter.

GET /hcmRestApi/resources/11.13.18.05/workers?fields=PersonNumber,DateOfBirth;names:FirstName;names:LastName;workRelationships:LegalEmployerName;workRelationships.assignments:AssignmentNumber&onlyData=true

To retrieve specific links, provide the links parameter and specify the links (relation types) to be returned.

GET /hcmRestApi/resources/11.13.18.05/workers?fields=PersonNumber,DateOfBirth&links=self,child