Jump to

• Request
• Response

Update an attachment

patch

/fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}/child/AffectedObject/{AffectedObjectUniqID}/child/AffectedItemAttachment/{AffectedItemAttachmentUniqID}

Request

Path Parameters

• AffectedItemAttachmentUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Affected Item Attachments resource and used to uniquely identify an instance of Affected Item Attachments. The client should not generate the hash key value. Instead, the client should query on the Affected Item Attachments collection resource in order to navigate to a specific instance of Affected Item Attachments to get the hash key.
• AffectedObjectUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Affected Objects resource and used to uniquely identify an instance of Affected Objects. The client should not generate the hash key value. Instead, the client should query on the Affected Objects collection resource in order to navigate to a specific instance of Affected Objects to get the hash key.
• ChangeId(required): integer
  Value that uniquely identifies the change.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CategoryCode: string
  Title: Category

  Maximum Length: 30

  Abbreviation that identifies the category of the attachment.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type of the attachment.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the file attachment.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the attached document.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the version of the attached document.
• DocumentId: integer (int64)
  Value that uniquely identifies the attachment.
• DownloadInfo: string
  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• FileContents: string (byte)
  Contents of the file attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• Revision: string
  Revision of the attachment. A revision of the attachment gets created when the user checks out and checks in an attachment.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attached file.
• UploadedText: string
  Text of the attachment.
• Url: string
  Maximum Length: 4000

  URL (Uniform Resource Locator) of the attachment.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the category of the attachment.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the data type of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "DocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the attachment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Url":{
            "maxLength":4000,
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "PAYLOADHINT":"Show",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileContents":{
            "type":"string",
            "description":"Contents of the file attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "Revision":{
            "type":"string",
            "description":"Revision of the attachment. A revision of the attachment gets created when the user checks out and checks in an attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "DownloadInfo":{
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "UploadedText":{
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : productChangeOrders-AffectedObject-AffectedItemAttachment-item-response

Type: object

Show Source

• AttachedDocumentId: integer (int64)
  Value that uniquely identifies the attached document.
• CategoryCode: string
  Title: Category

  Maximum Length: 30

  Abbreviation that identifies the category of the attachment.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that identifies the data type of the attachment.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the file attachment.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the attached document.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the version of the attached document.
• DocumentId: integer (int64)
  Value that uniquely identifies the attachment.
• DownloadInfo: string
  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• FileContents: string (byte)
  Contents of the file attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileSize: integer
  Title: Size

  Read Only: true

  Size of the file in the attachment.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the application most recently updated the attachment.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  Login of the user who most recently updated the attachment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Revision: string
  Revision of the attachment. A revision of the attachment gets created when the user checks out and checks in an attachment.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attached file.
• UploadedText: string
  Text of the attachment.
• Url: string
  Maximum Length: 4000

  URL (Uniform Resource Locator) of the attachment.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"Login of the user who most recently updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the category of the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the data type of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the attachment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Url":{
            "maxLength":4000,
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "PAYLOADHINT":"Show",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FileContents":{
            "type":"string",
            "description":"Contents of the file attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "Revision":{
            "type":"string",
            "description":"Revision of the attachment. A revision of the attachment gets created when the user checks out and checks in an attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "DownloadInfo":{
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "UploadedText":{
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the application most recently updated the attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "FileSize":{
            "title":"Size",
            "type":"integer",
            "description":"Size of the file in the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top