Update one ASN line attachment
patch
/fscmRestApi/resources/11.13.18.05/receivingReceiptRequests/{HeaderInterfaceId}/child/lines/{InterfaceTransactionId}/child/ASNLineAttachments/{ASNLineAttachmentsUniqID}
Request
Path Parameters
-
ASNLineAttachmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Attachments for ASN Lines resource and used to uniquely identify an instance of Attachments for ASN Lines. The client should not generate the hash key value. Instead, the client should query on the Attachments for ASN Lines collection resource in order to navigate to a specific instance of Attachments for ASN Lines to get the hash key.
-
HeaderInterfaceId(required): integer(int64)
Value that uniquely identifies the receipt request header.
-
InterfaceTransactionId(required): integer(int64)
Value that uniquely identifies the interfaced receipt line request.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attachment for the advanced shipment notice (ASN) line request. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the data type. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment for the advanced shipment notice (ASN) line request. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the content server document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255Number that identifies a particular version of the content server document. -
DownloadInfo: string
Title:
DownloadInfoJSON-formatted string containing information required to programmatically retrieve a large file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error code, if any, for the attachment for the advanced shipment notice (ASN) line request. -
ErrorStatusMessage: string
Title:
Error Status MessageError message, if any, for the attachment for the advanced shipment notice (ASN) line request. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the contents in the attachment for the advanced shipment notice (ASN) line request expire. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment for the advanced shipment notice (ASN) line request. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment for the advanced shipment notice (ASN) line request. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) of the attachment for the advanced shipment notice (ASN) line request. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment for the advanced shipment notice (ASN) line request. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attachment for the advanced shipment notice (ASN) line request. -
UploadedFileLength: integer
Title:
File SizeLength of the attachment file for the advanced shipment notice (ASN) line request. -
UploadedFileName: string
Title:
Uploaded File NameName of the attachment file for the advanced shipment notice (ASN) line request. -
UploadedText: string
Title:
Uploaded TextText of the attachment for the advanced shipment notice (ASN) line request. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
UrlMaximum Length:4000URL (Uniform Resource Locator) that locates the attachment for the advanced shipment notice (ASN) line request.
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 : receivingReceiptRequests-lines-ASNLineAttachments-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 of a shipment line. It is a primary key that the application generates when a document is attached to the advanced shipment notice (ASN) line request. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attachment for the advanced shipment notice (ASN) line request. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueLogin that the user used when creating the attachment for the specification. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the user created the attachment record. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the data type. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment for the advanced shipment notice (ASN) line request. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the content server document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255Number that identifies a particular version of the content server document. -
DownloadInfo: string
Title:
DownloadInfoJSON-formatted string containing information required to programmatically retrieve a large file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error code, if any, for the attachment for the advanced shipment notice (ASN) line request. -
ErrorStatusMessage: string
Title:
Error Status MessageError message, if any, for the attachment for the advanced shipment notice (ASN) line request. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the contents in the attachment for the advanced shipment notice (ASN) line request expire. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment for the advanced shipment notice (ASN) line request. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment for the advanced shipment notice (ASN) line request. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) of the attachment for the advanced shipment notice (ASN) line request. -
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 user most recently updated the document that is attached to the receipt header. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255Login of the user who updated the document that is attached to the receipt header. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueLogin that the user used when updating the attachment for the specification. -
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 for the advanced shipment notice (ASN) line request. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attachment for the advanced shipment notice (ASN) line request. -
UploadedFileLength: integer
Title:
File SizeLength of the attachment file for the advanced shipment notice (ASN) line request. -
UploadedFileName: string
Title:
Uploaded File NameName of the attachment file for the advanced shipment notice (ASN) line request. -
UploadedText: string
Title:
Uploaded TextText of the attachment for the advanced shipment notice (ASN) line request. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
UrlMaximum Length:4000URL (Uniform Resource Locator) that locates the attachment for the advanced shipment notice (ASN) line request. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Login that the user used when adding or modifying the 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.