Get an absence attachment
get
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}
Request
Path Parameters
-
absenceAttachmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Absence Attachments resource and used to uniquely identify an instance of Absence Attachments. The client should not generate the hash key value. Instead, the client should query on the Absence Attachments collection resource in order to navigate to a specific instance of Absence Attachments to get the hash key.
-
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 -
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:
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-absenceAttachments-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 attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Document of records category name. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
Name of the user who created the attachment for the absence. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
User name of the person who created the attachment for the absence. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Attachment on absence creation date. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Data type of the attachment for the absence. -
DatatypeCodeMeaning: string
Read Only:
true
Data type code description of the attachment for an absence. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment for the absence. -
DmDocumentId: string
Maximum Length:
255
Unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path where the attached document is stored. -
DmVersionNumber: string
Maximum Length:
255
Version number for the attached document. -
DownloadInfo: string
Title:
DownloadInfo
Download information of the attached document. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code of the attachment document. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attached document. -
FileContents: string
(byte)
Title:
File Contents
File content of the attached document related to an absence. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attached document. -
FileUrl: string
Title:
File Url
Uniform Resource Locator (URL) of the file related to an absence. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
Web image of the file. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Last updated date of absence. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Name of the person who last updated the absence request. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Title of the attachment to an absence. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
Name of the action that can be performed after an attachment is uploaded for the absence. -
Title: string
Title:
Title
Content type of the attachment uploaded file. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Length of the uploaded file attached to an absence. -
UploadedFileLength: integer
Title:
File Size
Length of the uploaded file attached to an absence. -
UploadedFileName: string
Title:
Uploaded File Name
File name of the uploaded file attached to an absence. -
UploadedText: string
Title:
Uploaded Text
Uploaded file of text type attached to an absence. -
Uri: string
Title:
Uri
Maximum Length:4000
URL of the file attachment attached to an absence. -
Url: string
Title:
Url
Maximum Length:4000
URL of the file document attachment attached to an absence. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
User name of the person who attached the file to an absence.
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.