Create an attachment for the calculation card
post
/hcmRestApi/resources/11.13.18.05/calculationEntries/{DirCardId}/child/CIRComponent/{CIRComponentUniqID}/child/CIRComponentAttachments
Request
Path Parameters
-
CIRComponentUniqID(required): string
This is the hash key of the attributes which make up the composite key--- EffectiveStartDate, EffectiveEndDate and DirCardCompId ---for the Calculation Card Component resource and used to uniquely identify an instance of Calculation Card Component. The client should not generate the hash key value. Instead, the client should query on the Calculation Card Component collection resource with a filter on the primary key values in order to navigate to a specific instance of Calculation Card Component.
For example: CIRComponent?q=EffectiveStartDate=<value1>;EffectiveEndDate=<value2>;DirCardCompId=<value3> -
DirCardId(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=
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.
-
Upsert-Mode: string
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 IdThe identifier used to track asynchronous background uploads of file contents. This field can only be used when the DatatypeCode="FILE". When queried it will only show when the ErrorCode="Pending" which signifies that a background upload has been registered but not yet completed. The async tracker id can only be set upon creation of an attachment. If the FileContents and tracker id are set then the tracker will be ignored. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id -
CategoryName: string
Title:
CategoryMaximum Length:30 - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILE -
Description: string
Title:
DescriptionMaximum Length:255 -
DmDocumentId: string
Maximum Length:
255 -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000 -
DmVersionNumber: string
Maximum Length:
255 -
DownloadInfo: string
Title:
DownloadInfo -
ErrorStatusCode: string
Title:
Error Status Code -
ErrorStatusMessage: string
Title:
Error Status Message -
ExpirationDate: string
(date-time)
Title:
Expiration Date -
FileContents: string
(byte)
Title:
File Contents -
FileName: string
Title:
File NameMaximum Length:2048 -
FileUrl: string
Title:
File Url -
PostProcessingAction: string
Title:
PostProcessingAction -
Title: string
Title:
Title -
UploadedFileContentType: string
Title:
Uploaded File Content Type -
UploadedFileLength: integer
Title:
File Size -
UploadedFileName: string
Title:
Uploaded File Name -
UploadedText: string
Title:
Uploaded Text -
Uri: string
Title:
UriMaximum Length:4000 -
Url: string
Title:
UrlMaximum Length:4000
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 : calculationEntries-CIRComponent-CIRComponentAttachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdThe identifier used to track asynchronous background uploads of file contents. This field can only be used when the DatatypeCode="FILE". When queried it will only show when the ErrorCode="Pending" which signifies that a background upload has been registered but not yet completed. The async tracker id can only be set upon creation of an attachment. If the FileContents and tracker id are set then the tracker will be ignored. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id -
CategoryName: string
Title:
CategoryMaximum Length:30 - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255 -
CreatedByUserName: string
Title:
Created By User NameRead Only:true -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:true -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILE -
Description: string
Title:
DescriptionMaximum Length:255 -
DmDocumentId: string
Maximum Length:
255 -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000 -
DmVersionNumber: string
Maximum Length:
255 -
DownloadInfo: string
Title:
DownloadInfo -
ErrorStatusCode: string
Title:
Error Status Code -
ErrorStatusMessage: string
Title:
Error Status Message -
ExpirationDate: string
(date-time)
Title:
Expiration Date -
FileContents: string
(byte)
Title:
File Contents -
FileName: string
Title:
File NameMaximum Length:2048 -
FileUrl: string
Title:
File Url -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:true -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:true -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255 -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:true -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction -
Title: string
Title:
Title -
UploadedFileContentType: string
Title:
Uploaded File Content Type -
UploadedFileLength: integer
Title:
File Size -
UploadedFileName: string
Title:
Uploaded File Name -
UploadedText: string
Title:
Uploaded Text -
Uri: string
Title:
UriMaximum Length:4000 -
Url: string
Title:
UrlMaximum Length:4000 -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255
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.