Jump to

• Request
• Response

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.
• 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 Top

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.

Body ()

Root Schema : absences-absenceEntryCertifications

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/absences-absenceEntryCertifications-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object absences-absenceEntryCertifications-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/absences-absenceEntryCertifications-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : absences-absenceEntryCertifications-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Created",
            "type":"string",
            "description":"Creation date of the certification.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "VoidFlag":{
            "title":"Voided",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the certification is voided.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ClassificationCodeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Description of the classification code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the certification.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ClassificationCode":{
            "title":"Classification",
            "maxLength":30,
            "type":"string",
            "description":"Classification of the certification, which could be either Entitlement or Documentation.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AcceptedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the certification has been accepted or confirmed.",
            "nullable":true,
            "x-queryable":false
        },
        "AbsenceCertificationId":{
            "title":"Name",
            "type":"integer",
            "description":"Unique identifier of a certification associated with an absence.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TargetPlanName":{
            "maxLength":240,
            "type":"string",
            "description":"Target plan name where the revised payment percentage will be applied by the certification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RevisedPayPercentage":{
            "type":"integer",
            "description":"Revised payment percentage for the worker's entitlement.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "AbsenceAggregationId":{
            "type":"integer",
            "description":"Unique identifier for a group of assignments associated to a single set of entitlements.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the certification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the certification.",
            "nullable":false,
            "default":"P",
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Creator of the certification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateDueDateActionFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the certification due date can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VoidActionFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the certification can be voided.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivedLateFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the certification is past its due date.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CompleteFlag":{
            "title":"Complete",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the certification is completed.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ReceivedDate":{
            "type":"string",
            "description":"Received date on the certification.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LastUpdateTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Description of the last update type of the certification. The values for this field are Certification evaluation, Absence evaluation process, User Updated",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier of a person.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequiredByDate":{
            "title":"Due Date",
            "type":"string",
            "description":"Date when the certification is required.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RevisedPayStartDate":{
            "type":"string",
            "description":"Revised payment start date for the worker's entitlement.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "VoidedDate":{
            "title":"Voided",
            "type":"string",
            "description":"Date when the certification was voided.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last update login date for the certification record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RevisedPayEndDate":{
            "type":"string",
            "description":"Revised payment end date for the worker's entitlement.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ConfirmActionFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the certification is confirmed or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":200,
            "type":"string",
            "description":"Description of the certification.",
            "nullable":true,
            "x-queryable":false
        },
        "VoidReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Reason for the certification to be voided.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PersonCertificationId":{
            "type":"integer",
            "description":"Certification identifier associated with a person.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "TargetPlanAllFlag":{
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the certification is associated to all qualified plans in the absence of that worker.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AcceptedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Certification accepted by the user.",
            "nullable":true,
            "x-queryable":false
        },
        "CertificationCreationDate":{
            "type":"string",
            "description":"Date when the certification was created",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PersonAbsenceEntryId":{
            "type":"integer",
            "description":"Absence entry identifier associated with a person.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "ReviseDateActionFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the certification payment percentage dates can be revised.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetPlanId":{
            "type":"integer",
            "description":"Unique identifier of the target plan associated with the certification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "ConfirmationReasonMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Description of the certification confirmation reason.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcceptedDate":{
            "type":"string",
            "description":"Date of acceptance of the certification.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "UpdateExpirationDateActionFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the certification expiration date can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConfirmationReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Reason code for the certification confirmation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LastUpdateType":{
            "maxLength":64,
            "type":"string",
            "description":"Last update type of the certification.",
            "nullable":true,
            "x-queryable":false
        },
        "Comments":{
            "maxLength":250,
            "type":"string",
            "description":"Comments when entering a certification.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CertificationCreationModeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Description of the mode of certification creation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LateReason":{
            "maxLength":100,
            "type":"string",
            "description":"Reason for late certification.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CaseId":{
            "type":"integer",
            "description":"Absence case identifier associated with the certification.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ConfirmationDate":{
            "title":"Completed Date",
            "type":"string",
            "description":"Date of certificate confirmation.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "certificationAttachments":{
            "title":"Absence Certification Attachments",
            "type":"array",
            "description":"The absence certification attachments resource provides all the certification attachments of an absence.",
            "items":{
                "$ref":"#/components/schemas/absences-absenceEntryCertifications-certificationAttachments-item-response"
            }
        },
        "CertificationCreationMode":{
            "maxLength":30,
            "type":"string",
            "description":"Mode of certification creation. It could either be on demand or system triggered.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EvidenceSource":{
            "maxLength":30,
            "type":"string",
            "description":"Evidence attached to the certification.",
            "nullable":true,
            "x-queryable":false
        },
        "StatusMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Description of the status of the certification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VoidReasonMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Description of the reason for the certification to be voided.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the certification was received.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ValidUptoDate":{
            "type":"string",
            "description":"Date of certification validity.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last update date of the certification record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

• Array of: object absences-absenceEntryCertifications-certificationAttachments-item-response

{
    "title":"Absence Certification Attachments",
    "type":"array",
    "description":"The absence certification attachments resource provides all the certification attachments of an absence.",
    "items":{
        "$ref":"#/components/schemas/absences-absenceEntryCertifications-certificationAttachments-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : absences-absenceEntryCertifications-certificationAttachments-item-response

Type: object

Show Source

• 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
  Title: Shared

  Content repository where the certification attachment file is uploaded.
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date of creation of the certification attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Data type code description of the attached certification file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Name of the uploaded file attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Image of the uploaded file.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"Uniform Resource Identifier (URI) of the attachment in the certification.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"Uniform Resource Locator (URL) of the attachment in the certification.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"File content type of the uploaded file as attachment in the certification.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"Downloaded document information of the attachment in the certification.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Certification attachment created by the user.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"File length of the uploaded file as attachment in the certification.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Document version number that's uploaded as attachment in the certification.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"Last updated by date of the attached file in the certification.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error status message of file upload as certification attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the user.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"Certification attachment created by name.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Data type code of the attached certification file.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"Postprocessing action of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the uploaded file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Name of the person who last updated the attached file in the certification.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"File name of the uploaded file as attachment in the certification.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"Uniform Resource Locator (URL) of the file related to the attachment in the certification.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Content repository where the certification attachment file is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the uploaded file attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "DatatypeCodeMeaning":{
            "type":"string",
            "description":"Data type of the attachment file in the certification.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the attached document.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code of the file upload as certification attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path where the attached document is stored.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Uploaded text of the file as attachment in the certification.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the certification.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Last updated date of the attached file in the certification.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Unique identifier for the Asynchronous API calls.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

performCertificateAction

Operation: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryCertifications/action/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.

Back to Top