Get an absence certification attachment
get
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryCertifications/{PersonCertificationId}/child/certificationAttachments/{certificationAttachmentsUniqID}
Request
Path Parameters
-
PersonCertificationId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
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.
-
certificationAttachmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Absence Certification Attachments resource and used to uniquely identify an instance of Absence Certification Attachments. The client should not generate the hash key value. Instead, the client should query on the Absence Certification Attachments collection resource in order to navigate to a specific instance of Absence Certification Attachments 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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context: string
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: string
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-certificationAttachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdUnique identifier for the Asynchronous API calls. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category name of the certification. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255Certification attachment created by name. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueCertification attachment created by the user. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate of creation of the certification attachment. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEData type code of the attached certification file. -
DatatypeCodeMeaning: string
Read Only:
trueData type of the attachment file in the certification. -
Description: string
Title:
DescriptionMaximum Length:255Data type code description of the attached certification file. -
DmDocumentId: string
Maximum Length:
255Unique identifier of the document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path where the attached document is stored. -
DmVersionNumber: string
Maximum Length:
255Document version number that's uploaded as attachment in the certification. -
DownloadInfo: string
Title:
DownloadInfoDownloaded document information of the attachment in the certification. -
ErrorStatusCode: string
Title:
Error Status CodeError status code of the file upload as certification attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageError status message of file upload as certification attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the attached document. -
FileContents: string
(byte)
Title:
File ContentsContents of the uploaded file attachment. -
FileName: string
Title:
File NameMaximum Length:2048Name of the uploaded file attachment. -
FileUrl: string
Title:
File UrlUniform Resource Locator (URL) of the file related to the attachment in the certification. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueImage of the uploaded file. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueLast updated date of the attached file in the certification. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255Last updated by date of the attached file in the certification. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueName of the person who last updated the attached file in the certification. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionPostprocessing action of the attached file. -
Title: string
Title:
TitleTitle of the uploaded file attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeFile content type of the uploaded file as attachment in the certification. -
UploadedFileLength: integer
Title:
File SizeFile length of the uploaded file as attachment in the certification. -
UploadedFileName: string
Title:
Uploaded File NameFile name of the uploaded file as attachment in the certification. -
UploadedText: string
Title:
Uploaded TextUploaded text of the file as attachment in the certification. -
Uri: string
Title:
UriMaximum Length:4000Uniform Resource Identifier (URI) of the attachment in the certification. -
Url: string
Title:
UrlMaximum Length:4000Uniform Resource Locator (URL) of the attachment in the certification. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Name of the user.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.