1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Check-In Documents

Get all check-in documents

get

/hcmRestApi/resources/11.13.18.05/checkInDocuments

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds a check-in document that matches the specified primary key criteria.
      Finder Variables
      • CheckInDocumentId; integer; System-generated primary key of a check-in document.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AssignmentId; integer; System-generated identifier of the job assignment of the worker in a check-in document.
    • AssignmentNumber; string; Unique assignment identifier of the worker in a check-in document.
    • CheckInDate; string; Date when the check-in document was created.
    • CheckInDocumentId; integer; System-generated primary key for a check-in document.
    • CheckInTemplateId; integer; System-generated primary key for a check-in template.
    • CheckInTemplateName; string; Name of a check-in template.
    • DocumentName; string; Name of a check-in document.
    • ManagerPersonId; integer; System-generated primary key of the manager in a check-in document.
    • ManagerPersonNumber; string; Unique person identifier of the manager in a check-in document.
    • PersonId; integer; System-generated primary key of the worker in a check-in document.
    • PersonNumber; string; Unique person identifier of the worker in a check-in document.
    • ReviewPeriodId; integer; System-generated primary key of the review period associated with a check-in document.
    • ReviewPeriodName; string; Name of the review period associated with a check-in document.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : checkInDocuments
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : checkInDocuments-item-response
Type: object
Show Source
Nested Schema : Questionnaire Responses
Type: array
Title: Questionnaire Responses
The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire.
Show Source
Nested Schema : checkInDocuments-questionnaireResponses-item-response
Type: object
Show Source
Nested Schema : Question Responses
Type: array
Title: Question Responses
The questionResponses resource provides the responses provided by the participant to a specific question in a questionnaire.
Show Source
Nested Schema : checkInDocuments-questionnaireResponses-questionResponses-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : checkInDocuments-questionnaireResponses-questionResponses-responseAttachments-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to retrieve all the check-in documents by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -X GET https://<host>:<port>/hcmRestApi/resources/11.13.18.05/checkInDocuments

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type : application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "items": [
        {
            "CheckInDocumentId": 300100179334010,
            "CheckInTemplateId": 300100167943392,
            "CheckInTemplateName": "Check-In Meetings",
            "ReviewPeriodId": 100100037213209,
            "ReviewPeriodName": "Default Review Period - Vision Corporation Enterprise",
            "ManagerPersonId": 100000008153799,
            "ManagerPersonNumber": "8153799",
            "PersonId": 100000008153756,
            "PersonNumber": "8153756",
            "AssignmentId": 100000008154060,
            "AssignmentNumber": "EEEE8153756",
            "DocumentName": "Check-In Meetings 09/28/18_ Postman_updateddd",
            "CheckInDate": "2018-09-28",
            "links": [...]
        },
        {
            "CheckInDocumentId": 300100183085372,
            "CheckInTemplateId": 300100167943392,
            "CheckInTemplateName": "Check-In Meetings",
            "ReviewPeriodId": 100100037213209,
            "ReviewPeriodName": "Default Review Period - Vision Corporation Enterprise",
            "ManagerPersonId": 100000008153799,
            "ManagerPersonNumber": "8153799",
            "PersonId": 100000008153756,
            "PersonNumber": "8153756",
            "AssignmentId": 100000008154060,
            "AssignmentNumber": "EEEE8153756",
            "DocumentName": "Performance Discussion for quarter 1",
            "CheckInDate": "2018-09-28",
            "links": [...]
        },
        {
            "CheckInDocumentId": 300100170556979,
            "CheckInTemplateId": 300100167943392,
            "CheckInTemplateName": "Check-In Meetings",
            "ReviewPeriodId": 100100037213209,
            "ReviewPeriodName": "Default Review Period - Vision Corporation Enterprise",
            "ManagerPersonId": 100000008153799,
            "ManagerPersonNumber": "8153799",
            "PersonId": 100000008153756,
            "PersonNumber": "8153756",
            "AssignmentId": 100000008154060,
            "AssignmentNumber": "EEEE8153756",
            "DocumentName": "Check-In Meetings 09/28/18",
            "CheckInDate": "2018-09-28",
            "links": [...],
    "count": 3,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [...]
}
Back to Top