Update an attachment of a change order

patch

/fscmRestApi/resources/11.13.18.05/productChangeOrdersV2/{productChangeOrdersV2UniqID}/child/changeOrderAttachments/{changeOrderAttachmentsUniqID}

Request

Path Parameters
  • 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.
  • 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
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Category
    Maximum Length: 30
    Category name of a change-order attachment.
  • Title: Shared
    Boolean attribute of a change order attachment shared by the content repository file. Contains one of the following values: true or false. If true, then the file is shared, If false, then the file isn't shared. The default value is false.
  • Title: Type
    Maximum Length: 30
    Default Value: FILE
    Unique identifier of the datatype of the attachment.
  • Title: Description
    Maximum Length: 255
    An attribute value that represents the description of the attachment.
  • Maximum Length: 255
    Unique identifier of the document in the repository.
  • Title: Dm Folder Path
    Maximum Length: 1000
    Attribute value that represents the repository folder path of the attachment.
  • Maximum Length: 255
    Attribute value that represents the version number of the attachment in the repository.
  • Title: DownloadInfo
    JSON object represented as a string containing information used to programmatically retrieve a file attachment.
  • Title: Error Status Code
    Error status code for the change-order attachment upload.
  • Title: Error Status Message
    Error status message for the change-order attachment upload.
  • Title: Expiration Date
    Attachment expiration date of the change order.
  • Title: File Name
    Maximum Length: 2048
    File name of the change-order attachment.
  • Title: File Url
    File URL of the change-order attachment.
  • Title: Title
    Attribute value that represents the title of a change-order attachment.
  • Title: Uploaded File Content Type
    Content type of the uploaded change-order attachment.
  • Title: File Size
    File length of the uploaded change-order attachment.
  • Title: Uploaded File Name
    File name of the uploaded change-order attachment.
  • Title: Uploaded Text
    Contents of attached text file.
  • Title: Uri
    Maximum Length: 4000
    An attribute value that represents the URI for the attachment.
  • Title: Url
    Maximum Length: 4000
    An attribute value that represents the URL for the attachment.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : productChangeOrdersV2-changeOrderAttachments-item-response
Type: object
Show Source
  • Title: Category
    Maximum Length: 30
    Category name of a change-order attachment.
  • Title: Shared
    Boolean attribute of a change order attachment shared by the content repository file. Contains one of the following values: true or false. If true, then the file is shared, If false, then the file isn't shared. The default value is false.
  • Title: Created By
    Read Only: true
    Maximum Length: 255
    User who created the change-order attachment.
  • Title: Created By User Name
    Read Only: true
    Name of the user who created the change-order attachment.
  • Title: Creation Date
    Read Only: true
    Date when the change object was created.
  • Title: Type
    Maximum Length: 30
    Default Value: FILE
    Unique identifier of the datatype of the attachment.
  • Title: Description
    Maximum Length: 255
    An attribute value that represents the description of the attachment.
  • Maximum Length: 255
    Unique identifier of the document in the repository.
  • Title: Dm Folder Path
    Maximum Length: 1000
    Attribute value that represents the repository folder path of the attachment.
  • Maximum Length: 255
    Attribute value that represents the version number of the attachment in the repository.
  • Title: DownloadInfo
    JSON object represented as a string containing information used to programmatically retrieve a file attachment.
  • Title: Error Status Code
    Error status code for the change-order attachment upload.
  • Title: Error Status Message
    Error status message for the change-order attachment upload.
  • Title: Expiration Date
    Attachment expiration date of the change order.
  • Title: File Name
    Maximum Length: 2048
    File name of the change-order attachment.
  • Title: File Url
    File URL of the change-order attachment.
  • Title: Last Update Date
    Read Only: true
    Attribute that indicates the date and time of the last update of the attachment.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 255
    User who last updated the change-order attachment.
  • Title: Last Updated By User
    Read Only: true
    Name of the user who last updated the change-order attachment.
  • Links
  • Title: Title
    Attribute value that represents the title of a change-order attachment.
  • Title: Uploaded File Content Type
    Content type of the uploaded change-order attachment.
  • Title: File Size
    File length of the uploaded change-order attachment.
  • Title: Uploaded File Name
    File name of the uploaded change-order attachment.
  • Title: Uploaded Text
    Contents of attached text file.
  • Title: Uri
    Maximum Length: 4000
    An attribute value that represents the URI for the attachment.
  • Title: Url
    Maximum Length: 4000
    An attribute value that represents the URL for the attachment.
  • Title: User Name
    Read Only: true
    Maximum Length: 255
    Attribute value that represents the name of user who uploaded the attachment.
Back to Top