Update a check-in document
patch
/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}
Request
Path Parameters
-
checkInDocumentsUniqID(required): string
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.
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CheckInDate: string
(date)
Title:
Date
Date when the check-in document was created. -
CheckInTemplateId: integer
(int64)
Title:
Template
System-generated primary key for a check-in template. -
CheckInTemplateName: string
Maximum Length:
400
Name of a check-in template. -
DocumentName: string
Title:
Document Name
Maximum Length:240
Name of a check-in document. -
ManagerPersonId: integer
(int64)
Title:
Manager
System-generated primary key of the manager in a check-in document. -
ManagerPersonNumber: string
Title:
Person Number
Maximum Length:30
Unique person identifier of the manager in a check-in document. -
questionnaireResponses: array
Questionnaire Responses
Title:
Questionnaire Responses
The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire.
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-patch-request
Type:
Show Source
object
-
questionResponses: array
Question Responses
Title:
Question Responses
The questionResponses resource provides the responses provided by the participant to a specific question in a questionnaire.
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-patch-request
Type:
Show Source
object
-
AnswerCLOB: string
(byte)
Title:
Answer Text
Attachment provided by the participant to respond to the question. -
AnswerList: string
Title:
Answer List
Maximum Length:2000
Concatenated list of answer identifiers (separated by a delimiter) selected by the participant when responding to a multiple choice question. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer ID
Surrogate identifier of the answer that a participant chose when responding to a single choice question. -
responseAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
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-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : checkInDocuments-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
System-generated identifier of the job assignment of the worker in a check-in document.
-
AssignmentNumber: string
Title:
Assignment Number
Maximum Length:30
Unique assignment identifier of the worker in a check-in document. -
CheckInDate: string
(date)
Title:
Date
Date when the check-in document was created. -
CheckInDocumentId: integer
(int64)
System-generated primary key for a check-in document.
-
CheckInTemplateId: integer
(int64)
Title:
Template
System-generated primary key for a check-in template. -
CheckInTemplateName: string
Maximum Length:
400
Name of a check-in template. -
DocumentName: string
Title:
Document Name
Maximum Length:240
Name of a check-in document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManagerPersonId: integer
(int64)
Title:
Manager
System-generated primary key of the manager in a check-in document. -
ManagerPersonNumber: string
Title:
Person Number
Maximum Length:30
Unique person identifier of the manager in a check-in document. -
PersonId: integer
(int64)
System-generated primary key of the worker in a check-in document.
-
PersonNumber: string
Title:
Person Number
Maximum Length:30
Unique person identifier of the worker in a check-in document. -
questionnaireResponses: array
Questionnaire Responses
Title:
Questionnaire Responses
The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire. -
ReviewPeriodId: integer
System-generated primary key of the review period associated with a check-in document.
-
ReviewPeriodName: string
Maximum Length:
400
Name of the review period associated with a check-in document.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : checkInDocuments-questionnaireResponses-item-response
Type:
Show Source
object
-
AttemptNumber: integer
(int64)
Title:
Attempt Number
Read Only:true
Attempt number by the participant in responding to a questionnaire. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who created the questionnaire response. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the questionnaire response was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the questionnaire response was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who last updated the questionnaire response. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParticipantPersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number of the participant responding to the questionnaire. -
QuestionnaireCode: string
Title:
Questionnaire Code
Read Only:true
Maximum Length:240
Alphanumeric value which uniquely identifies a questionnaire defined for a subscriber. -
QuestionnaireId: integer
(int64)
Title:
Questionnaire ID
Read Only:true
Surrogate identifier for the questionnaire that's assigned to the participant. -
QuestionnaireResponseId: integer
(int64)
Title:
Questionnaire Response ID
Surrogate identifier for the questionnaire response. -
QuestionnaireVersionNumber: integer
(int64)
Title:
Questionnaire Version Number
Version number of the questionnaire that the participant responds to. -
questionResponses: array
Question Responses
Title:
Question Responses
The questionResponses resource provides the responses provided by the participant to a specific question in a questionnaire. -
Status: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of the questionnaire response. I denotes the response is In progress and isn't submitted yet, while S denotes a submitted response. -
SubmittedDateTime: string
(date)
Title:
Submission Date
Read Only:true
Date on which the questionnaire response was submitted.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
AnswerCLOB: string
(byte)
Title:
Answer Text
Attachment provided by the participant to respond to the question. -
AnswerList: string
Title:
Answer List
Maximum Length:2000
Concatenated list of answer identifiers (separated by a delimiter) selected by the participant when responding to a multiple choice question. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who created the question response. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the question response was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the question response was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Name of the user who last updated the question response. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer ID
Surrogate identifier of the answer that a participant chose when responding to a single choice question. -
QuestionCode: string
Title:
Question Code
Read Only:true
Maximum Length:240
Alphanumeric value that uniquely identifies a question defined for a subscriber. -
QuestionnaireQuestionId: integer
(int64)
Title:
Questionnaire Question ID
Surrogate identifier for the question in a questionnaire. -
QuestionResponseId: integer
(int64)
Title:
Question Response ID
Surrogate identifier for the question response. -
responseAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- questionnaireResponses
-
Parameters:
- checkInDocumentsUniqID:
$request.path.checkInDocumentsUniqID
The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire. - checkInDocumentsUniqID:
Examples
The following example shows how to update a check-in document by submitting a PATCH request on the REST resource using cURL.
curl -u "<user>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X PATCH -d <payload> http://<host>:<port>/hcmRestApi/resources/11.13.18.05/checkInDocuments/00100000000EACED00057708000110F084CF513C0000000EACED0005770800000000000000CA0000000EACED0005770800005B0A5B28FC190000000EACED00057708000110F083E844E00000000EACED0005770800000000000000CA0000000EACED0005770800005AF310F6AA9C0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000000E7F1AB9800780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED0005770800005AF310F6ABCC0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000000E7F1AB9800780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000AACED000577040000000100000001590000000EACED0005770800005AF310F6AAC70000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000000E8CF1D0C00780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD140078
Example of Payload
The following is an example of the payload.
"{ ""DocumentName"": ""Performance Discussion for quarter 1"" }"
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.
{ "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": [...] }