Get all absence certifications records
get
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryCertifications
Request
Path Parameters
-
absencesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Absences resource and used to uniquely identify an instance of Absences. The client should not generate the hash key value. Instead, the client should query on the Absences collection resource in order to navigate to a specific instance of Absences to get the hash key.
Query Parameters
-
dependency: string
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> -
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 all the certifications that match the primary key criteria specified.
Finder Variables- PersonCertificationId; integer; Person certification identifier for the certification.
- PrimaryKey Finds all the certifications that match the primary key criteria specified.
-
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:- AbsenceCertificationId; integer; Unique identifier of a certification associated with an absence.
- CertificationCreationModeMeaning; string; Description of the mode of certification creation.
- ClassificationCode; string; Classification of the certification, which could be either Entitlement or Documentation.
- ClassificationCodeMeaning; string; Description of the classification code.
- CompleteFlag; boolean; Indicates whether the certification is completed.
- ConfirmActionFlag; boolean; Indicates whether the certification is confirmed or not.
- ConfirmationReasonMeaning; string; Description of the certification confirmation reason.
- LastUpdateTypeMeaning; string; Description of the last update type of the certification. The values for this field are Certification evaluation, Absence evaluation process, User Updated
- LateReason; string; Reason for late certification.
- Name; string; Name of the certification.
- PersonAbsenceEntryId; integer; Absence entry identifier associated with a person.
- PersonCertificationId; integer; Certification identifier associated with a person.
- PersonId; integer; Unique identifier of a person.
- ReceivedLateFlag; boolean; Indicates whether the certification is past its due date.
- RequiredByDate; string; Date when the certification is required.
- ReviseDateActionFlag; boolean; Indicates whether the certification payment percentage dates can be revised.
- Status; string; Status of the certification.
- StatusMeaning; string; Description of the status of the certification.
- TargetPlanAllFlag; boolean; Indicates whether the certification is associated to all qualified plans in the absence of that worker.
- TargetPlanId; integer; Unique identifier of the target plan associated with the certification.
- TargetPlanName; string; Target plan name where the revised payment percentage will be applied by the certification.
- UpdateDueDateActionFlag; boolean; Indicates whether the certification due date can be updated.
- UpdateExpirationDateActionFlag; boolean; Indicates whether the certification expiration date can be updated.
- VoidActionFlag; boolean; Indicates whether the certification can be voided.
- VoidFlag; boolean; Indicates whether the certification is voided.
- VoidReasonMeaning; string; Description of the reason for the certification to be voided.
-
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:
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 : absences-absenceEntryCertifications
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 : absences-absenceEntryCertifications-item-response
Type:
Show Source
object
-
AbsenceAggregationId: integer
(int64)
Read Only:
true
Unique identifier for a group of assignments associated to a single set of entitlements. -
AbsenceCertificationId: integer
(int64)
Title:
Name
Unique identifier of a certification associated with an absence. -
AcceptedBy: string
Maximum Length:
64
Certification accepted by the user. -
AcceptedDate: string
(date)
Date of acceptance of the certification.
-
AcceptedFlag: boolean
Maximum Length:
1
Indicates whether the certification has been accepted or confirmed. -
CaseId: integer
(int64)
Absence case identifier associated with the certification.
-
certificationAttachments: array
Absence Certification Attachments
Title:
Absence Certification Attachments
The absence certification attachments resource provides all the certification attachments of an absence. -
CertificationCreationDate: string
(date)
Date when the certification was created
-
CertificationCreationMode: string
Maximum Length:
30
Mode of certification creation. It could either be on demand or system triggered. -
CertificationCreationModeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of the mode of certification creation. -
ClassificationCode: string
Title:
Classification
Maximum Length:30
Classification of the certification, which could be either Entitlement or Documentation. -
ClassificationCodeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of the classification code. -
Comments: string
Maximum Length:
250
Comments when entering a certification. -
CompleteFlag: boolean
Title:
Complete
Maximum Length:30
Indicates whether the certification is completed. -
ConfirmActionFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the certification is confirmed or not. -
ConfirmationDate: string
(date)
Title:
Completed Date
Date of certificate confirmation. -
ConfirmationReasonCode: string
Maximum Length:
30
Reason code for the certification confirmation. -
ConfirmationReasonMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of the certification confirmation reason. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Creator of the certification. -
CreationDate: string
(date-time)
Title:
Created
Read Only:true
Creation date of the certification. -
Description: string
Maximum Length:
200
Description of the certification. -
EvidenceSource: string
Maximum Length:
30
Evidence attached to the certification. -
LastUpdateDate: string
(date-time)
Read Only:
true
Last update date of the certification record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the certification. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Last update login date for the certification record. -
LastUpdateType: string
Maximum Length:
64
Last update type of the certification. -
LastUpdateTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of the last update type of the certification. The values for this field are Certification evaluation, Absence evaluation process, User Updated -
LateReason: string
Maximum Length:
100
Reason for late certification. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the certification. -
PersonAbsenceEntryId: integer
(int64)
Absence entry identifier associated with a person.
-
PersonCertificationId: integer
(int64)
Read Only:
true
Certification identifier associated with a person. -
PersonId: integer
(int64)
Unique identifier of a person.
-
ReceivedDate: string
(date)
Received date on the certification.
-
ReceivedFlag: boolean
Maximum Length:
1
Indicates whether the certification was received. -
ReceivedLateFlag: boolean
Maximum Length:
1
Indicates whether the certification is past its due date. -
RequiredByDate: string
(date)
Title:
Due Date
Date when the certification is required. -
ReviseDateActionFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the certification payment percentage dates can be revised. -
RevisedPayEndDate: string
(date)
Revised payment end date for the worker's entitlement.
-
RevisedPayPercentage: integer
(int64)
Revised payment percentage for the worker's entitlement.
-
RevisedPayStartDate: string
(date)
Revised payment start date for the worker's entitlement.
-
Status: string
Title:
Status
Maximum Length:30
Default Value:P
Status of the certification. -
StatusMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of the status of the certification. -
TargetPlanAllFlag: boolean
Maximum Length:
30
Indicates whether the certification is associated to all qualified plans in the absence of that worker. -
TargetPlanId: integer
(int64)
Unique identifier of the target plan associated with the certification.
-
TargetPlanName: string
Read Only:
true
Maximum Length:240
Target plan name where the revised payment percentage will be applied by the certification. -
UpdateDueDateActionFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the certification due date can be updated. -
UpdateExpirationDateActionFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the certification expiration date can be updated. -
ValidUptoDate: string
(date)
Date of certification validity.
-
VoidActionFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the certification can be voided. -
VoidedDate: string
(date)
Title:
Voided
Date when the certification was voided. -
VoidFlag: boolean
Title:
Voided
Maximum Length:30
Indicates whether the certification is voided. -
VoidReasonCode: string
Maximum Length:
30
Reason for the certification to be voided. -
VoidReasonMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of the reason for the certification to be voided.
Nested Schema : Absence Certification Attachments
Type:
array
Title:
Absence Certification Attachments
The absence certification attachments resource provides all the certification attachments of an absence.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : absences-absenceEntryCertifications-certificationAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Unique identifier for the Asynchronous API calls. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the certification. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
Certification attachment created by name. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Certification attachment created by the user. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date of creation of the certification attachment. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Data type code of the attached certification file. -
DatatypeCodeMeaning: string
Read Only:
true
Data type of the attachment file in the certification. -
Description: string
Title:
Description
Maximum Length:255
Data type code description of the attached certification file. -
DmDocumentId: string
Maximum Length:
255
Unique identifier of the document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path where the attached document is stored. -
DmVersionNumber: string
Maximum Length:
255
Document version number that's uploaded as attachment in the certification. -
DownloadInfo: string
Title:
DownloadInfo
Downloaded document information of the attachment in the certification. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code of the file upload as certification attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message of file upload as certification attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attached document. -
FileContents: string
(byte)
Title:
File Contents
Contents of the uploaded file attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the uploaded file attachment. -
FileUrl: string
Title:
File Url
Uniform Resource Locator (URL) of the file related to the attachment in the certification. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
Image of the uploaded file. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Last updated date of the attached file in the certification. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Last updated by date of the attached file in the certification. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the person who last updated the attached file in the certification. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
Postprocessing action of the attached file. -
Title: string
Title:
Title
Title of the uploaded file attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
File content type of the uploaded file as attachment in the certification. -
UploadedFileLength: integer
Title:
File Size
File length of the uploaded file as attachment in the certification. -
UploadedFileName: string
Title:
Uploaded File Name
File name of the uploaded file as attachment in the certification. -
UploadedText: string
Title:
Uploaded Text
Uploaded text of the file as attachment in the certification. -
Uri: string
Title:
Uri
Maximum Length:4000
Uniform Resource Identifier (URI) of the attachment in the certification. -
Url: string
Title:
Url
Maximum Length:4000
Uniform Resource Locator (URL) of the attachment in the certification. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Name of the user.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Links
- performCertificateAction
-
Parameters:
- absencesUniqID:
$request.path.absencesUniqID
Performs an action on the certificate such as Confirm, Void, Update Due Date, Update Expiration Date or Revise Dates. - absencesUniqID: