Jump to

• Request
• Response
• Examples

Upload an attachment

post

/fscmRestApi/resources/11.13.18.05/itemsV2/{itemsV2UniqID}/child/ItemAttachment

Request

Path Parameters

• itemsV2UniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Items Version 2 resource and used to uniquely identify an instance of Items Version 2. The client should not generate the hash key value. Instead, the client should query on the Items Version 2 collection resource in order to navigate to a specific instance of Items 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.
• Upsert-Mode:
  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

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AttachedDocumentId: integer (int64)
  An unique identifier for document that is an attachment in the repository.
• AttachedDocumentsDFF: array Flexfields for Item Attachments
  Title: Flexfields for Item Attachments

  The Flexfields for Item Attachments resource manages the descriptive flexfields for item attachments.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Name of the item attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: true or false. If true then the attachment is shared. If false, then it is not shared. The default value is false.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that indicates the type of data. Valid values include WEB_PAGE, TEXT, or FILE.
• Description: string
  Title: Description

  Maximum Length: 255

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

  Value that uniquely identifies the document in repository.
• DmFolderPath: string
  Maximum Length: 1000

  Path to the folder in which the attachment file is uploaded.
• DmVersionNumber: string
  Maximum Length: 255

  Version number that identifies the attachment in repository.
• DownloadInfo: string
  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Abbreviation that identifies the error code, if any, for the attachment.
• ErrorStatusMessage: string
  Text of the error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Date when the contents of the attachment are no longer valid.
• FileContents: string (byte)
  Contents of the attachment. The file content must be in the base64 format. This attribute is hidden when base64 format is not present..
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Name of the file attached to the item.
• FileUrl: string
  Path of the document file.
• Title: string
  Title: Title

  Title of the item attachment.
• UploadedFileContentType: string
  Content type of the attached file.
• UploadedFileLength: integer
  Title: File Size

  Length of the attached file.
• UploadedFileName: string
  Name of the attached file.
• UploadedText: string
  Contents of text file that is attached.
• Uri: string
  Maximum Length: 4000

  URI (Uniform Resource Identifier) appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID.
• Url: string
  Maximum Length: 4000

  Uniform resource locator of the attachment.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "type":"string",
            "description":"Text of the error message, if any, for the 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 item 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 indicates the type of data. Valid values include WEB_PAGE, TEXT, or FILE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"Name of the file attached to the item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the item attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "maxLength":"4000",
            "type":"string",
            "description":"URI (Uniform Resource Identifier) appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "maxLength":"4000",
            "type":"string",
            "description":"Uniform resource locator of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "type":"string",
            "description":"Name of the attached 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 document in repository.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "type":"string",
            "description":"Path of the document 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 attachment is shared. If false, then it is not shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "AttachedDocumentId":{
            "type":"integer",
            "description":"An unique identifier for document that is an attachment in the repository.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "FileContents":{
            "type":"string",
            "description":"Contents of the attachment. The file content must be in the base64 format. This attribute is hidden when base64 format is not present..",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"Content type of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Date when the contents of the attachment are no longer valid.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"Abbreviation that identifies the error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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
            }
        },
        "AttachedDocumentsDFF":{
            "title":"Flexfields for Item Attachments",
            "type":"array",
            "description":"The Flexfields for Item Attachments resource manages the descriptive flexfields for item attachments.",
            "items":{
                "$ref":"#/components/schemas/itemsV2-ItemAttachment-AttachedDocumentsDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "DmFolderPath":{
            "maxLength":"1000",
            "type":"string",
            "description":"Path to the folder in which the attachment file is uploaded.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "type":"string",
            "description":"Contents of text file that is attached.",
            "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 item attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Version number that identifies the attachment in repository.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : Flexfields for Item Attachments

Type: array

Title: Flexfields for Item Attachments

The Flexfields for Item Attachments resource manages the descriptive flexfields for item attachments.

Show Source

• Array of: object itemsV2-ItemAttachment-AttachedDocumentsDFF-item-post-request

{
    "title":"Flexfields for Item Attachments",
    "type":"array",
    "description":"The Flexfields for Item Attachments resource manages the descriptive flexfields for item attachments.",
    "items":{
        "$ref":"#/components/schemas/itemsV2-ItemAttachment-AttachedDocumentsDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : itemsV2-ItemAttachment-AttachedDocumentsDFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Descriptive flexfield context name for item attachments.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Descriptive flexfield context display value for item attachments.
• AttachedDocumentId: integer (int64)

{
    "type":"object",
    "properties":{
        "AttachedDocumentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for item attachments.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "description":"Descriptive flexfield context name for item attachments.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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 : itemsV2-ItemAttachment-item-response

Type: object

Show Source

• AttachedDocumentId: integer (int64)
  An unique identifier for document that is an attachment in the repository.
• AttachedDocumentsDFF: array Flexfields for Item Attachments
  Title: Flexfields for Item Attachments

  The Flexfields for Item Attachments resource manages the descriptive flexfields for item attachments.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Name of the item attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Contains one of the following values: true or false. If true then the attachment is shared. If false, then it is not shared. The default value is false.
• CreatedBy: string
  Read Only: true

  Maximum Length: 255

  User who created the attachment.
• CreatedByUserName: string
  Read Only: true

  Login that the user used when creating the attachment.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the attachment.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Abbreviation that indicates the type of data. Valid values include WEB_PAGE, TEXT, or FILE.
• Description: string
  Title: Description

  Maximum Length: 255

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

  Value that uniquely identifies the document in repository.
• DmFolderPath: string
  Maximum Length: 1000

  Path to the folder in which the attachment file is uploaded.
• DmVersionNumber: string
  Maximum Length: 255

  Version number that identifies the attachment in repository.
• DocumentURL: string
  Read Only: true

  Complete URL (Uniform Resource Locator) of the item attachment uploaded to web center.
• DownloadInfo: string
  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Abbreviation that identifies the error code, if any, for the attachment.
• ErrorStatusMessage: string
  Text of the error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Date when the contents of the attachment are no longer valid.
• FileContents: string (byte)
  Contents of the attachment. The file content must be in the base64 format. This attribute is hidden when base64 format is not present..
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Name of the file attached to the item.
• FileUrl: string
  Path of the document file.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the item was most recently updated. For a list of attribute value interdependencies, refer to Interdependent Item Attributes: Explained at: https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=FAPIM287169.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who most recently updated the attachment.
• LastUpdatedByUserName: string
  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.
• Title: string
  Title: Title

  Title of the item attachment.
• UploadedFileContentType: string
  Content type of the attached file.
• UploadedFileLength: integer
  Title: File Size

  Length of the attached file.
• UploadedFileName: string
  Name of the attached file.
• UploadedText: string
  Contents of text file that is attached.
• Uri: string
  Maximum Length: 4000

  URI (Uniform Resource Identifier) appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID.
• Url: string
  Maximum Length: 4000

  Uniform resource locator of the attachment.
• UserName: string
  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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "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 item 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":"Name of the file attached to the item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Uri":{
            "maxLength":"4000",
            "type":"string",
            "description":"URI (Uniform Resource Identifier) appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "maxLength":"4000",
            "type":"string",
            "description":"Uniform resource locator of 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 document in repository.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "type":"integer",
            "description":"An unique identifier for document that is an attachment in the repository.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"Content type of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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
            }
        },
        "CreatedByUserName":{
            "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 attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Version number that identifies the attachment in repository.",
            "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":{
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "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 indicates the type of data. Valid values include WEB_PAGE, TEXT, or FILE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DocumentURL":{
            "type":"string",
            "description":"Complete URL (Uniform Resource Locator) of the item attachment uploaded to web center.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the item attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "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":{
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "type":"string",
            "description":"Path of the document 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 attachment is shared. If false, then it is not shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "type":"string",
            "description":"Contents of the attachment. The file content must be in the base64 format. This attribute is hidden when base64 format is not present..",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Date when the contents of the attachment are no longer valid.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"Abbreviation that identifies the error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "AttachedDocumentsDFF":{
            "title":"Flexfields for Item Attachments",
            "type":"array",
            "description":"The Flexfields for Item Attachments resource manages the descriptive flexfields for item attachments.",
            "items":{
                "$ref":"#/components/schemas/itemsV2-ItemAttachment-AttachedDocumentsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "DmFolderPath":{
            "maxLength":"1000",
            "type":"string",
            "description":"Path to the folder in which the attachment file is uploaded.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "type":"string",
            "description":"Contents of text file that is attached.",
            "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 item attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task.",
            "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 item was most recently updated. For a list of attribute value interdependencies, refer to Interdependent Item Attributes: Explained at: https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=FAPIM287169.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Flexfields for Item Attachments

Type: array

Title: Flexfields for Item Attachments

The Flexfields for Item Attachments resource manages the descriptive flexfields for item attachments.

Show Source

• Array of: object itemsV2-ItemAttachment-AttachedDocumentsDFF-item-response

{
    "title":"Flexfields for Item Attachments",
    "type":"array",
    "description":"The Flexfields for Item Attachments resource manages the descriptive flexfields for item attachments.",
    "items":{
        "$ref":"#/components/schemas/itemsV2-ItemAttachment-AttachedDocumentsDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : itemsV2-ItemAttachment-AttachedDocumentsDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Descriptive flexfield context name for item attachments.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Descriptive flexfield context display value for item attachments.
• AttachedDocumentId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttachedDocumentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for item attachments.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "description":"Descriptive flexfield context name for item attachments.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

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."
        }
    }
}

Links

AttachedDocumentsDFF

Operation: /fscmRestApi/resources/11.13.18.05/itemsV2/{itemsV2UniqID}/child/ItemAttachment/{ItemAttachmentUniqID}/child/AttachedDocumentsDFF

Parameters:

• ItemAttachmentUniqID: $request.path.ItemAttachmentUniqID
• itemsV2UniqID: $request.path.itemsV2UniqID

The Flexfields for Item Attachments resource manages the descriptive flexfields for item attachments.

Back to Top

Examples

This example describes how to add an attachment to an existing item.

Example cURL Command

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/itemsV2/itemsV2UniqID/child/ItemAttachment"

Example Request Body

The following example includes the contents of the request body in JSON format to add an attachment to an existing item.

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

{
"DatatypeCode": "FILE",
"DmDocumentId":"UCMFA00533425",
"DmVersionNumber":"533449",
"CategoryName": "MISC"
}

Example Response Body

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

{
    "AttachedDocumentId": 300100635470291,
    "LastUpdateDate": "2024-02-22T11:13:17.471+00:00",
    "LastUpdatedBy": "PIMQA",
    "DatatypeCode": "FILE",
    "FileName": "Structures.json",
    "DmFolderPath": null,
    "DmDocumentId": "UCMFA00533425",
    "DmVersionNumber": "533449",
    "Url": null,
    "CategoryName": "MISC",
    "UserName": null,
    "Uri": null,
    "FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID:533449?download&XFND_SCHEME_ID=1&XFND_CERT_FP=3D81D59DF29739B02CC8E384E7479EB8C51279F4&XFND_RANDOM=-8558612953089208810&XFND_EXPIRES=1708600997838&XFND_SIGNATURE=JykEP-wnqCsYROEfjS0ytoS-NgynnjRpT3nMUTzWNF-7dex6NRA~W-LcDKboj-QjjMTQ19Odrf-ohvPutGefU~Pc76fOVR6jTaqT4VZGhF~1fXkrpLvTfdv1k9WF2TkjRSS~ELG18yORhehJQ09whGdJiiTvl9ibT3g4~zNR5i5wjZPH4quGAr000KIMoJ~SRkhCz0kpsuPgoYkioSr0H06onBSEX5SBkBVP61cvFyx2ehyiMsnmr~BSt4hq1QHprBrnpBEocjoi6Ni0m4PjTebNCupkScYwBLanYtZgJsjRSRW-W9dm1ZBMLXfuEf3Lj7iuhOMDvNNCB4cUowthXQ__&Id=533449",
    "UploadedText": null,
    "UploadedFileContentType": "Application/json",
    "UploadedFileLength": 8425,
    "UploadedFileName": null,
    "ContentRepositoryFileShared": "false",
    "Title": "Structures.json",
    "Description": "",
    "ErrorStatusCode": null,
    "ErrorStatusMessage": null,
    "CreatedBy": "PIMQA",
    "CreationDate": "2024-02-22T11:13:17+00:00",
    "ExpirationDate": null,
    "LastUpdatedByUserName": "PIMQA",
    "CreatedByUserName": "PIMQA",
    "DownloadInfo": "{\"XFND_EXPIRES\":\"1708600997841\",\"XFND_SCHEME_ID\":\"1\",\"XFND_CERT_FP\":\"3D81D59DF29739B02CC8E384E7479EB8C51279F4\",\"XFND_SIGNATURE\":\"TlPHG~YSyXd-Sgbmm5hhlcfPyS7e1SXAWYHFbO3f-vRuEYO5xR6oVGTctqKJuSEzrC0WR4ueb7gedLrS5N3j-qzC2hPKErza6nVx9cnxcI58a0wZnDsgsfZQhdWw3MtWW6WpCRTWlCmIPGfgiegKhBr6~kyxq1JqYj1lNNzAEJuMvDK9Xb~otyDmj~9qzjmYMVtvR6ObXx2uMVqAcNRqQiA-FDio1kayDHCWqHnGL42xYfoTh-QZ~f72~LvZudcLI6J-3TMyr~JmnKWkwFLWG9-3dGpI4RKwvEzFkq7-R7wOqnuX~8KZhRAydc5ke48lABTl38p3Ftj1esQGVqsXrg__\",\"XFND_RANDOM\":\"4045208130649729672\"}",
    "DocumentURL": "https://servername/fscmUI/content/conn/FusionAppsContentRepository/uuid/dDocID:533449?download&XFND_SCHEME_ID=1&XFND_CERT_FP=3D81D59DF29739B02CC8E384E7479EB8C51279F4&XFND_RANDOM=-8558612953089208810&XFND_EXPIRES=1708600997838&XFND_SIGNATURE=JykEP-wnqCsYROEfjS0ytoS-NgynnjRpT3nMUTzWNF-7dex6NRA~W-LcDKboj-QjjMTQ19Odrf-ohvPutGefU~Pc76fOVR6jTaqT4VZGhF~1fXkrpLvTfdv1k9WF2TkjRSS~ELG18yORhehJQ09whGdJiiTvl9ibT3g4~zNR5i5wjZPH4quGAr000KIMoJ~SRkhCz0kpsuPgoYkioSr0H06onBSEX5SBkBVP61cvFyx2ehyiMsnmr~BSt4hq1QHprBrnpBEocjoi6Ni0m4PjTebNCupkScYwBLanYtZgJsjRSRW-W9dm1ZBMLXfuEf3Lj7iuhOMDvNNCB4cUowthXQ__&Id=533449",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/itemsV2/00040000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC0000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC/child/ItemAttachment/00020000000EACED00057708000110F09FC629D30000000EACED00057708000110F09FC629D2",
            "name": "ItemAttachment",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/itemsV2/00040000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC0000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC/child/ItemAttachment/00020000000EACED00057708000110F09FC629D30000000EACED00057708000110F09FC629D2",
            "name": "ItemAttachment",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/itemsV2/00040000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC0000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC",
            "name": "itemsV2",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/itemsV2/00040000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC0000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC/child/ItemAttachment/00020000000EACED00057708000110F09FC629D30000000EACED00057708000110F09FC629D2/child/AttachedDocumentsDFF",
            "name": "AttachedDocumentsDFF",
            "kind": "collection"
        },
        {
            "rel": "enclosure",
            "href": "https://servername/fscmRestApi/resources/version/itemsV2/00040000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC0000000EACED0005770800000000000001BA0000000EACED0005770800000000000000CC/child/ItemAttachment/00020000000EACED00057708000110F09FC629D30000000EACED00057708000110F09FC629D2/enclosure/FileContents",
            "name": "FileContents",
            "kind": "other"
        }
    ]
}

Back to Top