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

Get a document

get

/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Check-In Documents resource and used to uniquely identify an instance of Check-In Documents. The client should not generate the hash key value. Instead, the client should query on the Check-In Documents collection resource in order to navigate to a specific instance of Check-In Documents to get the hash key.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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-item-response
Type: object
Show Source
Nested Schema : Questionnaire Responses
Type: array
Title: Questionnaire Responses
The questionnaireResponses resource is child of the check-in documents resource. It includes the responses to questionnaires provided by a person on a specific subject. The parent resource is required and contains the complete context of the questionnaire.
Show Source
Nested Schema : checkInDocuments-questionnaireResponses-item-response
Type: object
Show Source
  • Title: Attempt Number
    Read Only: true
    Attempt number of the questionnaire response. If a questionnaire is submitted and the questionnaire is responded to again, the attempt number assigned to the new response will increment by one.
  • Read Only: true
    Maximum Length: 64
    User who created the questionnaire response.
  • Read Only: true
    Date and time when the questionnaire response was created.
  • Read Only: true
    Last updated date and time of the questionnaire response.
  • Read Only: true
    Maximum Length: 64
    User who last updated the questionnaire response.
  • Links
  • Title: Person Number
    Read Only: true
    Maximum Length: 30
    Person number assigned to the person responding to the questionnaire.
  • Title: Questionnaire Code
    Read Only: true
    Maximum Length: 240
    User-defined identifier of the questionnaire definition for which the response was provided.
  • Title: Questionnaire ID
    Read Only: true
    System-generated primary key for the definition of the questionnaire for which the response was provided.
  • Title: Questionnaire Response ID
    System-generated primary key for the response to a questionnaire.
  • Title: Questionnaire Version Number
    Version of the questionnaire definition against which responses were provided.
  • Question Responses
    Title: Question Responses
    The questionResponses resource is a child of the questionnaire responses resource. The Question Responses resource includes the responses to the questions from the respondents. A questionnaire may have one or more question responses.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Status of the response. A response can have a Submitted or In-Progress status.
  • Title: Submission Date
    Read Only: true
    Date and time when the response was submitted. Submission date and time is applicable to submitted responses only.
Nested Schema : Question Responses
Type: array
Title: Question Responses
The questionResponses resource is a child of the questionnaire responses resource. The Question Responses resource includes the responses to the questions from the respondents. A questionnaire may have one or more question responses.
Show Source
Nested Schema : checkInDocuments-questionnaireResponses-questionResponses-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The responseAttachments resource is a child of the question responses resource. The Response Attachments resource includes the attachments for the responses provided by the respondents to the questions in questionnaires. A question may have none or one or many response attachments.
Show Source
Nested Schema : checkInDocuments-questionnaireResponses-questionResponses-responseAttachments-item-response
Type: object
Show Source
Links
questionnaireResponses
Parameters:
  • checkInDocumentsUniqID: $request.path.checkInDocumentsUniqID
The questionnaireResponses resource is child of the check-in documents resource. It includes the responses to questionnaires provided by a person on a specific subject. The parent resource is required and contains the complete context of the questionnaire.
Back to Top

Examples

The following example shows how to retrieve a check-in document 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?q=CheckInDocumentId=300100170556979

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": 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": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [...]
}}
Back to Top