Upload an attachment

post

/fscmRestApi/resources/11.13.18.05/itemCatalogs/{CatalogId}/child/attachments

Request

Path Parameters
  • 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=
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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Descriptive Flexfields for Attachments
    Title: Descriptive Flexfields for Attachments
    The Descriptive Flexfields for Attachments resource manages the contextual descriptive flexfields of the item catalog attachments.
  • Title: Category
    Maximum Length: 30
    Name of the catalog attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task.
  • Title: Shared
    Contains one of the following values: true or false. If true, then the attachment is shared. If false, then it's not shared. The default value is false.
  • Title: Type
    Maximum Length: 30
    Default Value: FILE
    Abbreviation that indicates the type of data. Valid values include WEB_PAGE, TEXT, or FILE.
  • Title: Description
    Maximum Length: 255
    Description of the catalog attachment.
  • Title: Dm Folder Path
    Maximum Length: 1000
    Path to the folder in which the attached file is uploaded.
  • Title: DownloadInfo
    JSON object represented as a string containing information used to programmatically retrieve a file attachment.
  • Title: Error Status Code
    Abbreviation that identifies the error code, if any, for the attachment.
  • Title: Error Status Message
    Text of the error message, if any, for the attachment.
  • Title: File Name
    Maximum Length: 2048
    Name of the file attached to the item.
  • Title: File Url
    Uniform resource locator of the attachment file.
  • Title: Title
    Title of the catalog attachment.
  • Title: Uploaded File Content Type
    Type of the file content.
  • Title: File Size
    Size of the attached file.
  • Title: Uploaded File Name
    Name of the attached file.
  • Title: Uploaded Text
    Content of the attached text file.
  • Title: Uri
    Maximum Length: 4000
    Uniform resource identifier appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID.
  • Title: Url
    Maximum Length: 4000
    Uniform resource locator of the attachment.
Nested Schema : Descriptive Flexfields for Attachments
Type: array
Title: Descriptive Flexfields for Attachments
The Descriptive Flexfields for Attachments resource manages the contextual descriptive flexfields of the item catalog attachments.
Show Source
Nested Schema : schema
Type: object
Show Source
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 : itemCatalogs-attachments-item-response
Type: object
Show Source
  • Descriptive Flexfields for Attachments
    Title: Descriptive Flexfields for Attachments
    The Descriptive Flexfields for Attachments resource manages the contextual descriptive flexfields of the item catalog attachments.
  • Title: Category
    Maximum Length: 30
    Name of the catalog attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task.
  • Title: Shared
    Contains one of the following values: true or false. If true, then the attachment is shared. If false, then it's not shared. The default value is false.
  • Title: Created By
    Read Only: true
    Maximum Length: 255
    User who created the attachment.
  • Title: Creation Date
    Read Only: true
    Date when the user created the attachment.
  • Title: Type
    Maximum Length: 30
    Default Value: FILE
    Abbreviation that indicates the type of data. Valid values include WEB_PAGE, TEXT, or FILE.
  • Title: Description
    Maximum Length: 255
    Description of the catalog attachment.
  • Title: Dm Folder Path
    Maximum Length: 1000
    Path to the folder in which the attached file is uploaded.
  • Read Only: true
    Uniform resource locator of the catalog attachment.
  • Title: DownloadInfo
    JSON object represented as a string containing information used to programmatically retrieve a file attachment.
  • Title: Error Status Code
    Abbreviation that identifies the error code, if any, for the attachment.
  • Title: Error Status Message
    Text of the error message, if any, for the attachment.
  • Title: File Name
    Maximum Length: 2048
    Name of the file attached to the item.
  • Title: File Url
    Uniform resource locator of the attachment file.
  • Title: Last Update Date
    Read Only: true
    Date when the user most recently updated the attachment.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 255
    User who most recently updated the attachment.
  • Links
  • Title: Title
    Title of the catalog attachment.
  • Title: Uploaded File Content Type
    Type of the file content.
  • Title: File Size
    Size of the attached file.
  • Title: Uploaded File Name
    Name of the attached file.
  • Title: Uploaded Text
    Content of the attached text file.
  • Title: Uri
    Maximum Length: 4000
    Uniform resource identifier appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID.
  • Title: Url
    Maximum Length: 4000
    Uniform resource locator of the attachment.
  • Title: User Name
    Read Only: true
    Maximum Length: 255
    Display name of the attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage attachment categories task.
Nested Schema : Descriptive Flexfields for Attachments
Type: array
Title: Descriptive Flexfields for Attachments
The Descriptive Flexfields for Attachments resource manages the contextual descriptive flexfields of the item catalog attachments.
Show Source
Nested Schema : itemCatalogs-attachments-attachmentDFF-item-response
Type: object
Show Source
Back to Top