Update an attachment of a change order
patch
/fscmRestApi/resources/11.13.18.05/productChangeOrdersV2/{productChangeOrdersV2UniqID}/child/changeOrderAttachments/{changeOrderAttachmentsUniqID}
Request
Path Parameters
-
changeOrderAttachmentsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Change Order Attachments resource and used to uniquely identify an instance of Change Order Attachments. The client should not generate the hash key value. Instead, the client should query on the Change Order Attachments collection resource in order to navigate to a specific instance of Change Order Attachments to get the hash key.
-
productChangeOrdersV2UniqID(required): string
This is the hash key of the attributes which make up the composite key for the Product Change Orders Version 2 resource and used to uniquely identify an instance of Product Change Orders Version 2. The client should not generate the hash key value. Instead, the client should query on the Product Change Orders Version 2 collection resource in order to navigate to a specific instance of Product Change Orders Version 2 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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of a change-order attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Unique identifier of the datatype of the attachment. -
Description: string
Title:
Description
Maximum Length:255
An attribute value that represents the description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier of the document in the repository. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Attribute value that represents the repository folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Attribute value that represents the version number of the attachment in the repository. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code for the change-order attachment upload. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message for the change-order attachment upload. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Attachment expiration date of the change order. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the change-order attachment. -
FileUrl: string
Title:
File Url
File URL of the change-order attachment. -
Title: string
Title:
Title
Attribute value that represents the title of a change-order attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded change-order attachment. -
UploadedFileLength: integer
Title:
File Size
File length of the uploaded change-order attachment. -
UploadedFileName: string
Title:
Uploaded File Name
File name of the uploaded change-order attachment. -
UploadedText: string
Title:
Uploaded Text
Contents of attached text file. -
Uri: string
Title:
Uri
Maximum Length:4000
An attribute value that represents the URI for the attachment. -
Url: string
Title:
Url
Maximum Length:4000
An attribute value that represents the URL for the attachment.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : productChangeOrdersV2-changeOrderAttachments-item-response
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of a change-order attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the change-order attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Name of the user who created the change-order attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the change object was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Unique identifier of the datatype of the attachment. -
Description: string
Title:
Description
Maximum Length:255
An attribute value that represents the description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier of the document in the repository. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Attribute value that represents the repository folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Attribute value that represents the version number of the attachment in the repository. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code for the change-order attachment upload. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message for the change-order attachment upload. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Attachment expiration date of the change order. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the change-order attachment. -
FileUrl: string
Title:
File Url
File URL of the change-order attachment. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Attribute that indicates the date and time of the last update of the attachment. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the change-order attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the change-order attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Attribute value that represents the title of a change-order attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded change-order attachment. -
UploadedFileLength: integer
Title:
File Size
File length of the uploaded change-order attachment. -
UploadedFileName: string
Title:
Uploaded File Name
File name of the uploaded change-order attachment. -
UploadedText: string
Title:
Uploaded Text
Contents of attached text file. -
Uri: string
Title:
Uri
Maximum Length:4000
An attribute value that represents the URI for the attachment. -
Url: string
Title:
Url
Maximum Length:4000
An attribute value that represents the URL for the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Attribute value that represents the name of user who uploaded the attachment.
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.