Get all documents
get
/hcmRestApi/resources/11.13.18.05/checkInDocuments
Request
Query Parameters
-
expand: string
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).
-
fields: string
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 -
finder: string
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 the check-in document that matches the specified primary key criteria.
Finder Variables:- CheckInDocumentId; integer; System-generated primary key of the check-in document.
- PrimaryKey: Finds the check-in document that matches the specified primary key criteria.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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.
- AssignmentNumber; string; Unique assignment identifier of the worker.
- CheckInDate; string; Date when the check-in document was created.
- CheckInDocumentId; integer; System-generated primary key for the check-in document.
- CheckInTemplateId; integer; System-generated primary key for the check-in template.
- CheckInTemplateName; string; Name of the check-in template.
- DocumentName; string; Name of the check-in document.
- ManagerPersonId; integer; System-generated primary key of the manager in the check-in document.
- ManagerPersonNumber; string; Unique person identifier of the manager.
- PersonId; integer; System-generated primary key of the worker in the check-in document.
- PersonNumber; string; Unique person identifier of the worker.
- ReviewPeriodId; integer; System-generated primary key of the review period.
- ReviewPeriodName; string; Name of the review period.
-
totalResults: boolean
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
-
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : checkInDocuments-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
System-generated identifier of the job assignment of the worker.
-
AssignmentNumber: string
Title:
Assignment Number
Maximum Length:30
Unique assignment identifier of the worker. -
CheckInDate: string
(date)
Title:
Date
Date when the check-in document was created. -
CheckInDocumentId: integer
(int64)
System-generated primary key for the check-in document.
-
CheckInTemplateId: integer
(int64)
Title:
Template
System-generated primary key for the check-in template. -
CheckInTemplateName: string
Maximum Length:
400
Name of the check-in template. -
DocumentName: string
Title:
Document Name
Maximum Length:240
Name of the 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 the check-in document. -
ManagerPersonNumber: string
Title:
Person Number
Maximum Length:30
Unique person identifier of the manager. -
PersonId: integer
(int64)
System-generated primary key of the worker in the check-in document.
-
PersonNumber: string
Title:
Person Number
Maximum Length:30
Unique person identifier of the worker. -
questionnaireResponses: array
Questionnaire Responses
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. -
ReviewPeriodId: integer
System-generated primary key of the review period.
-
ReviewPeriodName: string
Maximum Length:
400
Name of the review period.
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 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 : 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 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. -
CreatedBy: string
Read Only:
true
Maximum Length:64
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
Last updated date and time of the questionnaire response. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
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 assigned to the person responding to the questionnaire. -
QuestionnaireCode: string
Title:
Questionnaire Code
Read Only:true
Maximum Length:240
User-defined identifier of the questionnaire definition for which the response was provided. -
QuestionnaireId: integer
(int64)
Title:
Questionnaire ID
Read Only:true
System-generated primary key for the definition of the questionnaire for which the response was provided. -
QuestionnaireResponseId: integer
(int64)
Title:
Questionnaire Response ID
System-generated primary key for the response to a questionnaire. -
QuestionnaireVersionNumber: integer
(int64)
Title:
Questionnaire Version Number
Version of the questionnaire definition against which responses were provided. -
questionResponses: array
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. -
Status: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of the response. A response can have a Submitted or In-Progress status. -
SubmittedDateTime: string
(date)
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 : 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 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:
Show Source
object
-
AnswerCLOB: string
(byte)
Title:
Answer Text
Text provided in the answer to a plain text or rich text type of question. -
AnswerList: string
Title:
Answer List
Maximum Length:2000
Comma separated list of identifiers of the choices selected in the answer to a multiple choice question. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the questionnaire response. -
CreationDate: string
(date-time)
Read Only:
true
Date and time that the questionnaire response was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
Last updated date and time to the questionnaire response. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the questionnaire response. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer ID
Identifier of the choice selected in the answer to a single choice type of question. -
QuestionCode: string
Title:
Question Code
Read Only:true
Maximum Length:240
User-defined identifier of the question for which the response was provided. -
QuestionnaireQuestionId: integer
(int64)
Title:
Questionnaire Question ID
System-generated primary key for the definition of the question within the questionnaire for which the response was provided. -
QuestionResponseId: integer
(int64)
Title:
Question Response ID
System-generated primary key for the response to a question. -
responseAttachments: array
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
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
Unique identifier of the attachment. It is a child of the question response. There can be zero to many attachments in a question response. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the attachment record is created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Data type code of the attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier for the document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The path of the folder where the attachment is stored. -
DmVersionNumber: string
Maximum Length:
255
Version number of the document attachment. -
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
Error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date and time of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL of the attachment. -
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
Date and time when the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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": [...] }