Create an attachment record for a specific attachment identifier
post
/fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Attachments
Request
Path Parameters
-
expenseReportsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Expense Reports resource and used to uniquely identify an instance of Expense Reports. The client should not generate the hash key value. Instead, the client should query on the Expense Reports collection resource in order to navigate to a specific instance of Expense Reports 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 IdValue that uniquely identifies the attachment associated with an expense. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attached file. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEData type code of the attachment. -
Description: string
Title:
DescriptionMaximum Length:255Description of an attachment. -
DmDocumentId: string
Maximum Length:
255The unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Address of the folder that contains attachments associated with an expense. -
DmVersionNumber: string
Maximum Length:
255The version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageError message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsContents of the file. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment. -
FileUrl: string
Title:
File UrlURL to which a file is attached. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the uploaded attachment. Possible values are JPG and PNG. -
UploadedFileLength: integer
Title:
File SizeLength of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attachment file. -
UploadedText: string
Title:
Uploaded TextText uploaded as an attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI where the attachment is present. The value is appended to the application to generate the final URL. -
Url: string
Title:
UrlMaximum Length:4000URL of the attached file.
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 : expenseReports-Attachments-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 IdValue that uniquely identifies the attachment associated with an expense. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attached file. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the row. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueName of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate and time when the row was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEData type code of the attachment. -
Description: string
Title:
DescriptionMaximum Length:255Description of an attachment. -
DmDocumentId: string
Maximum Length:
255The unique identifier of the attachment. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Address of the folder that contains attachments associated with an expense. -
DmVersionNumber: string
Maximum Length:
255The version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageError message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsContents of the file. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment. -
FileUrl: string
Title:
File UrlURL to which a file is attached. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who last updated the row. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueDate when the record was last updated by a specific user. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the uploaded attachment. Possible values are JPG and PNG. -
UploadedFileLength: integer
Title:
File SizeLength of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attachment file. -
UploadedText: string
Title:
Uploaded TextText uploaded as an attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI where the attachment is present. The value is appended to the application to generate the final URL. -
Url: string
Title:
UrlMaximum Length:4000URL of the attached file. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Name of the user associated with an attachment.
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.