Create an attachment for an absence
post
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments
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.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Document of records category name. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEData type of the attachment for the absence. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment for the absence. -
DmDocumentId: string
Maximum Length:
255Unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path where the attached document is stored. -
DmVersionNumber: string
Maximum Length:
255Version number for the attached document. -
DownloadInfo: string
Title:
DownloadInfoDownload information of the attached document. -
ErrorStatusCode: string
Title:
Error Status CodeError status code of the attachment document. -
ErrorStatusMessage: string
Title:
Error Status MessageError status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the attached document. -
FileContents: string
(byte)
Title:
File ContentsFile content of the attached document related to an absence. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attached document. -
FileUrl: string
Title:
File UrlUniform Resource Locator (URL) of the file related to an absence. -
PostProcessingAction: string
Title:
PostProcessingActionName of the action that can be performed after an attachment is uploaded for the absence. -
Title: string
Title:
TitleContent type of the attachment uploaded file. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeLength of the uploaded file attached to an absence. -
UploadedFileLength: integer
Title:
File SizeLength of the uploaded file attached to an absence. -
UploadedFileName: string
Title:
Uploaded File NameFile name of the uploaded file attached to an absence. -
UploadedText: string
Title:
Uploaded TextUploaded file of text type attached to an absence. -
Uri: string
Title:
UriMaximum Length:4000URL of the file attachment attached to an absence. -
Url: string
Title:
UrlMaximum Length:4000URL of the file document attachment attached to an absence.
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.
Root Schema : absences-absenceAttachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Document of records category name. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255Name of the user who created the attachment for the absence. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueUser name of the person who created the attachment for the absence. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueAttachment on absence creation date. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEData type of the attachment for the absence. -
DatatypeCodeMeaning: string
Read Only:
trueData type code description of the attachment for an absence. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment for the absence. -
DmDocumentId: string
Maximum Length:
255Unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path where the attached document is stored. -
DmVersionNumber: string
Maximum Length:
255Version number for the attached document. -
DownloadInfo: string
Title:
DownloadInfoDownload information of the attached document. -
ErrorStatusCode: string
Title:
Error Status CodeError status code of the attachment document. -
ErrorStatusMessage: string
Title:
Error Status MessageError status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the attached document. -
FileContents: string
(byte)
Title:
File ContentsFile content of the attached document related to an absence. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attached document. -
FileUrl: string
Title:
File UrlUniform Resource Locator (URL) of the file related to an absence. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueWeb image of the file. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueLast updated date of absence. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255Name of the person who last updated the absence request. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueTitle of the attachment to an absence. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionName of the action that can be performed after an attachment is uploaded for the absence. -
Title: string
Title:
TitleContent type of the attachment uploaded file. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeLength of the uploaded file attached to an absence. -
UploadedFileLength: integer
Title:
File SizeLength of the uploaded file attached to an absence. -
UploadedFileName: string
Title:
Uploaded File NameFile name of the uploaded file attached to an absence. -
UploadedText: string
Title:
Uploaded TextUploaded file of text type attached to an absence. -
Uri: string
Title:
UriMaximum Length:4000URL of the file attachment attached to an absence. -
Url: string
Title:
UrlMaximum Length:4000URL of the file document attachment attached to an absence. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255User name of the person who attached the file to an absence.
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.