Jump to

• Request
• Response
• Examples

Update one attachment

patch

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/lines/{linesUniqID}/child/attachments/{attachmentsUniqID}

Request

Path Parameters

• OrderKey(required): string
  Value that uniquely identifies the sales order. It can have the following formats.
  
  - Concatenation of SourceOrderSystem, a colon, and the value of SourceTransactionId. For orders created through the Oracle Fusion Cloud Order Management work area, the SourceTransactionId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceTransactionId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order. This format of the OrderKey in the URL always returns the latest version of the sales order. When a draft exists, that becomes the latest version of the sales order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section point to the latest version of the sales order and the corresponding child objects.
  Example: /salesOrdersForOrderHub/LEG:R13_Sample_Order points to the latest version of the order with SourceTransactionId "R13_Sample_Order" in the SourceOrderSystem "LEG".
  
  - Primary key of the sales order, which is HeaderId. This format of the OrderKey is useful when the order has multiple revisions because it helps in accessing either the older version or the latest version of the order. When there's a draft revision then HeaderId can be used to access the processing order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section also point to that specific version of the sales order and the corresponding child objects. Only the Get operation is supported on older revisions of the order.
  Example: /salesOrdersForOrderHub/12345 points to an order with HeaderId 12345.
  
  When a q parameter or query finder is used to GET an order that has multiple versions then the latest version has the OrderKey in the format <sourceOrderSystem>:<SourceTransactionId> whereas reference orders have OrderKey in the format of HeaderId.
• attachmentsUniqID(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• linesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Order Lines resource and used to uniquely identify an instance of Order Lines. The client should not generate the hash key value. Instead, the client should query on the Order Lines collection resource in order to navigate to a specific instance of Order Lines 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  Name of the attachment category.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the application shares the attachment file in the content repository. If false, then the application does not share.
• 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 attachment.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Path to the folder that contains the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the version of the attached document.
• 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

  Abbreviation that identifies the status of the attachment upload.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error message encountered while uploading attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Date when the attachment expires.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment file.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL (Uniform Resource Locator) that locates the attachment file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

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

  Length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  Text that the attachment contains.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI (Uniform Resource Identifier) that identifies the attachment file.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL (Uniform Resource Locator) that locates the attachment.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message encountered while uploading attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI (Uniform Resource Identifier) that identifies the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application shares the attachment file in the content repository. If false, then the application does not share.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Type of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the attachment expires.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the status of the attachment upload.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"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,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Path to the folder that contains the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text that the attachment contains.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the attachment category.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : salesOrdersForOrderHub-lines-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  An identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Value that uniquely identifies the attachment.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Name of the attachment category.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the application shares the attachment file in the content repository. If false, then the application does not share.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  Login that the user used when creating the attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the user created 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 attachment.
• DmDocumentId: string
  Maximum Length: 255

  Value that uniquely identifies the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Path to the folder that contains the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Number that identifies the version of the attached document.
• 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

  Abbreviation that identifies the status of the attachment upload.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error message encountered while uploading attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Date when the attachment expires.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment file.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL (Uniform Resource Locator) that locates the attachment file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

  User who most recently updated the attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Login that the user used when updating the attachment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

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

  Length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  Text that the attachment contains.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI (Uniform Resource Identifier) that identifies the attachment file.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL (Uniform Resource Locator) that locates the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  User who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user created the attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI (Uniform Resource Identifier) that identifies the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Type of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"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,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Login that the user used when creating the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "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 attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"User who most recently updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message encountered while uploading attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "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,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Login that the user used when updating the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application shares the attachment file in the content repository. If false, then the application does not share.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the attachment expires.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the status of the attachment upload.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Path to the folder that contains the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text that the attachment contains.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the attachment category.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user 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
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"An identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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

Examples

This example describes how to update one attachment.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/OrderKey/child/lines/linesUniqID/child/attachments/attachmentsUniqID"

For example, use the following command:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Line_Attach_01/child/lines/00020000000EACED00057708000110F084F2A8550000000EACED00057708000110F084F2A856/child/attachments/00020000000EACED00057708000110F084F2A8580000000EACED00057708000110F084F2A857"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

You can achieve the same result with Create sales orders using the upsert-mode header parameter. Refer to the examples in the Create sales orders section to see how to update child resource in the existing order.

{ 
	"Title" : "UpdateTest",
	"FileContents": "TGluZSBsZXZlbCBhdHRhY2htZW50IHVwZGF0ZWQ=" 
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
	"AttachedDocumentId" : 300100185401432,
	"LastUpdateDate" : "2019-11-18T10:24:35.742+00:00",
	"LastUpdatedBy" : "SCMOPERATIONS",
	"DatatypeCode" : "FILE",
	"FileName" : "TEST1.txt",
	"DmFolderPath" : null,
	"DmDocumentId" : "UCMFA00031446",
	"DmVersionNumber" : "120508",
	"Url" : null,
	"CategoryName" : "MISC",
	"UserName" : "Miscellaneous",
	"Uri" : null,
	"FileUrl" : "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a120508?XFND_SCHEME_ID=1&XFND_CERT_FP=43234DFCA02EE72391FA46FA15431B9A9405E9F2&XFND_RANDOM=5993989553350271123&XFND_EXPIRES=1574883771695&XFND_SIGNATURE=Icq4DsBUb8rE6jLWJANgUUrmLNil63Nq3GQUza-3sMcwhSAqvO0N97jZNPqorOZJa4VsOWbWZvp2z-Ia61kz-DnZRr1nqdUZC2zQAeb61l~2RucrhczHe01RnH2dFM4eDIOMM3r7rWDTV-0JWb6O68KpFgJRVd8LXpd7F7StuPdl77RHUtdfX7-kRWDzz5nQet50TnQ7jWWIIG-dS00WKcD3qjNaNm53XOcE11eNz9dt2RGzMWuUi4EWCqUAqtUwOjV3Dcsl6YrlJ2T4AXWOUMMRSPh6BEXN4qdLVVfwpF5kt6iNO6DWcBFX3S6mBhaTzpNzGk~8kIuyK5banpePDg__&Id=120508&download",
	"UploadedText" : null,
	"UploadedFileContentType" : "text/plain",
	"UploadedFileLength" : 29,
	"UploadedFileName" : "TEST1.txt",
	"ContentRepositoryFileShared" : "false",
	"Title" : "UpdateTest",
	"Description" : "Sigma Filter",
	"ErrorStatusCode" : null,
	"ErrorStatusMessage" : null,
	"CreatedBy" : "SCMOPERATIONS",
	"CreationDate" : "2019-11-18T10:24:33.059+00:00",
	"ExpirationDate" : null,
	"LastUpdatedByUserName" : "Patric",
	"CreatedByUserName" : "Patric",
	"AsyncTrackerId" : null,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Line_Attach_01/child/lines/00020000000EACED00057708000110F084F2A8550000000EACED00057708000110F084F2A856/child/attachments/00020000000EACED00057708000110F084F2A8580000000EACED00057708000110F084F2A857",
		"name" : "attachments",
		"kind" : "item"
	}, {
		"rel" : "canonical",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Line_Attach_01/child/lines/00020000000EACED00057708000110F084F2A8550000000EACED00057708000110F084F2A856/child/attachments/00020000000EACED00057708000110F084F2A8580000000EACED00057708000110F084F2A857",
		"name" : "attachments",
		"kind" : "item"
	}, {
		"rel" : "parent",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Line_Attach_01/child/lines/00020000000EACED00057708000110F084F2A8550000000EACED00057708000110F084F2A856",
		"name" : "lines",
		"kind" : "item"
	}, {
		"rel" : "enclosure",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Line_Attach_01/child/lines/00020000000EACED00057708000110F084F2A8550000000EACED00057708000110F084F2A856/child/attachments/00020000000EACED00057708000110F084F2A8580000000EACED00057708000110F084F2A857/enclosure/FileContents",
		"name" : "FileContents",
		"kind" : "other"
	} ]
}

Back to Top