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

Create a document

post

/hcmRestApi/resources/11.13.18.05/checkInDocuments

Request

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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
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-post-request
Type: object
Show Source
Nested Schema : questionResponses
Type: array
Show Source
Nested Schema : checkInDocuments-questionnaireResponses-questionResponses-item-post-request
Type: object
Show Source
  • Title: Answer Text
    Text provided in the answer to a plain text or rich text type of question.
  • Title: Answer List
    Maximum Length: 2000
    Comma separated list of identifiers of the choices selected in the answer to a multiple choice question.
  • Title: Question Answer ID
    Identifier of the choice selected in the answer to a single choice type of question.
  • Title: Questionnaire Question ID
    System-generated primary key for the definition of the question within the questionnaire for which the response was provided.
  • Title: Question Response ID
    System-generated primary key for the response to a question.
  • Attachments
    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.
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 : schema
Type: object
Show Source
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 create a check-in document by submitting a POST request on the REST resource using CURL.

curl -i -u "<user>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json"  -X POST -d <payload> http://<host>:<port>/hcmRestApi/resources/11.13.18.05/checkInDocuments

Example of Payload

The following is an example of the payload.

{
            "CheckInTemplateName": "Check-In Meetings",
            "ReviewPeriodName": "Default Review Period - Vision Corporation Enterprise",
            "ManagerPersonNumber": "8153799",
            "PersonNumber": "8153756",
            "AssignmentNumber": "EEEE8153756",
            "DocumentName": "Performance Discussion",
            "CheckInDate": "2018-09-28"
}

Example of Response Header

The following shows an example of the response header.

Status: HTTP/1.1 201 Created
Created Content-Type : application/json

Example of Response Body

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

{
    "CheckInDocumentId": 300100183085372,
    "CheckInTemplateId": 300100167943392,
    "CheckInTemplateName": null,
    "ReviewPeriodId": 100100037213209,
    "ReviewPeriodName": null,
    "ManagerPersonId": 100000008153799,
    "ManagerPersonNumber": null,
    "PersonId": 100000008153756,
    "PersonNumber": null,
    "AssignmentId": 100000008154060,
    "AssignmentNumber": null,
    "DocumentName": "Performance Discussion",
    "CheckInDate": "2018-09-28",
    "links": [...]
}
Back to Top