Jump to

• Request
• Response

Update one attachment of the item revision

patch

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

Request

Path Parameters

• ItemAttachmentUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Item Revision Attachments List of Values resource and used to uniquely identify an instance of Item Revision Attachments List of Values. The client should not generate the hash key value. Instead, the client should query on the Item Revision Attachments List of Values collection resource in order to navigate to a specific instance of Item Revision Attachments List of Values to get the hash key.
• 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: string
  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: string
  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

• AttachedDocumentsDFF: array AttachedDocumentsDFF
  The name of the attachment descriptive flexfield.
• BaseDocumentId: integer (int64)
  Unique identifier of the document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Represents a component of a catalog used for classification of items.
• ContentRepositoryFileCheckedOutBy: string
  Title: Checked Out By

  User who checked out the file from the repository.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Value that uniquely identifies whether the repository file is shared by the item revision.
• DatabaseDescription: string
  Title: Description

  Maximum Length: 255

  Description of the file.
• DatabaseTitle: string
  Title: Title

  Maximum Length: 80

  Name of the file.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Unique identifier for the datatype of the attachment.
• DataTypeName: string
  Name for the datatype of the attachment.
• Description: string
  Title: Description

  Maximum Length: 255

  Value that represents the description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Unique identifier for a document in the repository.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Value that represents the repository folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Value that represents the version number of attachment in repository.
• DocumentId: integer (int64)
  An unique identifier for document referenced in an attachment.
• DownloadInfo: string
  Title: DownloadInfo

  Value that represents the download information of the attachment.
• EntityName: string
  Title: Entity Name

  Maximum Length: 40

  Value that represents the entity of the attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Value that represents the error status associated with the attachment creation.
• ErrorStatusMessage: string
  Title: Error Status Message

  Value that represents the error details associated with the attachment creation.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Value that represents the expiration date of the attachment associated with the item revision.
• FileContents: string (byte)
  Title: File Contents

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

  Maximum Length: 2048

  Value the represents the name of a file of the attachment.
• FileUrl: string
  Title: File Url

  Value that represents the URL of the attachment file.
• ItemId: string
  Maximum Length: 150

  Value that uniquely represents the item associated with the attachment.
• OrganizationId: string
  Maximum Length: 150

  Represents the organization associated with the item attachment.
• PrimaryCategoryFlag: string
  Title: Primary

  Maximum Length: 1

  Value that indicates whether the attachment is the primary attachment associated with the item revision.
• RevisionId: string
  Maximum Length: 150

  Value that indicates the revision ID associated with the attachment.
• Title: string
  Title: Title

  Value that represents the title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Value that represents the content type of the file attachments associated with the item revision.
• UploadedFileLength: integer
  Title: File Size

  Value that indicates the length of the file attachment associated with the item revision.
• UploadedFileName: string
  Title: Uploaded File Name

  Value that indicates the name of the file attachment associated with the item revision.
• UploadedText: string
  Title: Uploaded Text

  Contents of the text file that's attached.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  Value the represents the Uniform Resource Identifier appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID.
• Url: string
  Title: Url

  Maximum Length: 4000

  Value that represents the URL for the attachment.

{
    "type":"object",
    "properties":{
        "AttachedDocumentsDFF":{
            "type":"array",
            "description":"The name of the attachment descriptive flexfield.",
            "items":{
                "$ref":"#/components/schemas/itemsV2-ItemAttachment-AttachedDocumentsDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "BaseDocumentId":{
            "type":"integer",
            "description":"Unique identifier of the document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Represents a component of a catalog used for classification of items.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileCheckedOutBy":{
            "title":"Checked Out By",
            "type":"string",
            "description":"User who checked out the file from the repository.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "PAYLOADHINT":"Show"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Value that uniquely identifies whether the repository file is shared by the item revision.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DataTypeName":{
            "type":"string",
            "description":"Name for the datatype of the attachment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DatabaseDescription":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the file.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "PAYLOADHINT":"Show"
            }
        },
        "DatabaseTitle":{
            "title":"Title",
            "maxLength":80,
            "type":"string",
            "description":"Name of the file.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_USER_KEY":"true",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "PAYLOADHINT":"Show"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the datatype of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Value that represents the description of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier for a document in the repository.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Value that represents the repository folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Value that represents the version number of attachment in repository.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DocumentId":{
            "type":"integer",
            "description":"An unique identifier for document referenced in an attachment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "PAYLOADHINT":"Show"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"Value that represents the download information of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "EntityName":{
            "title":"Entity Name",
            "maxLength":40,
            "type":"string",
            "description":"Value that represents the entity of the attachment.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "PAYLOADHINT":"Show"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Value that represents the error status associated with the attachment creation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Value that represents the error details associated with the attachment creation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Value that represents the expiration date of the attachment associated with the item revision.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the file attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Value the represents the name of a file of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"Value that represents the URL of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ItemId":{
            "maxLength":150,
            "type":"string",
            "description":"Value that uniquely represents the item associated with the attachment.",
            "nullable":true
        },
        "OrganizationId":{
            "maxLength":150,
            "type":"string",
            "description":"Represents the organization associated with the item attachment.",
            "nullable":true
        },
        "PrimaryCategoryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"string",
            "description":"Value that indicates whether the attachment is the primary attachment associated with the item revision.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "RevisionId":{
            "maxLength":150,
            "type":"string",
            "description":"Value that indicates the revision ID associated with the attachment.",
            "nullable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Value that represents the title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Value that represents the content type of the file attachments associated with the item revision.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Value that indicates the length of the file attachment associated with the item revision.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Value that indicates the name of the file attachment associated with the item revision.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Contents of the text file that's attached.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"Value the represents the 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":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"Value that represents the URL for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : AttachedDocumentsDFF

Type: array

The name of the attachment descriptive flexfield.

Show Source

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

{
    "type":"array",
    "description":"The name of the attachment descriptive flexfield.",
    "items":{
        "$ref":"#/components/schemas/itemsV2-ItemAttachment-AttachedDocumentsDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

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

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• 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":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Context Segment",
            "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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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"
                }
            }
        }
    }
}

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

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

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

  Unique identifier for a document that's an attachment in the repository.
• AttachedDocumentsDFF: array AttachedDocumentsDFF
  The name of the attachment descriptive flexfield.
• BaseDocumentId: integer (int64)
  Unique identifier of the document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Represents a component of a catalog used for classification of items.
• ContentRepositoryFileCheckedOutBy: string
  Title: Checked Out By

  User who checked out the file from the repository.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Value that uniquely identifies whether the repository file is shared by the item revision.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  Name of the user who created the attachment associated with the item revision.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  User name of the user who created the attachment associated with the item revision.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date on which the attachment with associated to the item revision.
• DatabaseDescription: string
  Title: Description

  Maximum Length: 255

  Description of the file.
• DatabaseTitle: string
  Title: Title

  Maximum Length: 80

  Name of the file.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Unique identifier for the datatype of the attachment.
• DataTypeName: string
  Name for the datatype of the attachment.
• Description: string
  Title: Description

  Maximum Length: 255

  Value that represents the description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Unique identifier for a document in the repository.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Value that represents the repository folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Value that represents the version number of attachment in repository.
• DocumentId: integer (int64)
  An unique identifier for document referenced in an attachment.
• DocumentPreviewURL: string
  Read Only: true

  Maximum Length: 255

  Value that represents the URL for preview of the attachment.
• DocumentURL: string
  Read Only: true

  Value that represents the URL of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  Value that represents the download information of the attachment.
• EntityName: string
  Title: Entity Name

  Maximum Length: 40

  Value that represents the entity of the attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Value that represents the error status associated with the attachment creation.
• ErrorStatusMessage: string
  Title: Error Status Message

  Value that represents the error details associated with the attachment creation.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Value that represents the expiration date of the attachment associated with the item revision.
• FileContents: string (byte)
  Title: File Contents

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

  Maximum Length: 2048

  Value the represents the name of a file of the attachment.
• FileUrl: string
  Title: File Url

  Value that represents the URL of the attachment file.
• ItemId: string
  Maximum Length: 150

  Value that uniquely represents the item associated with the attachment.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Indicates the date and time of the last update of the attachment.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  Indicates the last user who updated the attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Indicates the user name of the user who updated the attachment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: string
  Maximum Length: 150

  Represents the organization associated with the item attachment.
• PrimaryCategoryFlag: string
  Title: Primary

  Maximum Length: 1

  Value that indicates whether the attachment is the primary attachment associated with the item revision.
• RevisionId: string
  Maximum Length: 150

  Value that indicates the revision ID associated with the attachment.
• Title: string
  Title: Title

  Value that represents the title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Value that represents the content type of the file attachments associated with the item revision.
• UploadedFileLength: integer
  Title: File Size

  Value that indicates the length of the file attachment associated with the item revision.
• UploadedFileName: string
  Title: Uploaded File Name

  Value that indicates the name of the file attachment associated with the item revision.
• UploadedText: string
  Title: Uploaded Text

  Contents of the text file that's attached.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  Value the represents the Uniform Resource Identifier appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID.
• Url: string
  Title: Url

  Maximum Length: 4000

  Value that represents the URL for the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Value that represents the name of user who uploads the attachment.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Unique identifier for a document that's 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
        },
        "AttachedDocumentsDFF":{
            "type":"array",
            "description":"The name of the attachment descriptive flexfield.",
            "items":{
                "$ref":"#/components/schemas/itemsV2-ItemAttachment-AttachedDocumentsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "BaseDocumentId":{
            "type":"integer",
            "description":"Unique identifier of the document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Represents a component of a catalog used for classification of items.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileCheckedOutBy":{
            "title":"Checked Out By",
            "type":"string",
            "description":"User who checked out the file from the repository.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "PAYLOADHINT":"Show"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Value that uniquely identifies whether the repository file is shared by the item revision.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who created the attachment associated with the item revision.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"User name of the user who created the attachment associated with the item revision.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date on which the attachment with associated to the item revision.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DataTypeName":{
            "type":"string",
            "description":"Name for the datatype of the attachment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DatabaseDescription":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the file.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DatabaseTitle":{
            "title":"Title",
            "maxLength":80,
            "type":"string",
            "description":"Name of the file.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_USER_KEY":"true",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the datatype of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Value that represents the description of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier for a document in the repository.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Value that represents the repository folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Value that represents the version number of attachment in repository.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DocumentId":{
            "type":"integer",
            "description":"An unique identifier for document referenced in an attachment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DocumentPreviewURL":{
            "maxLength":255,
            "type":"string",
            "description":"Value that represents the URL for preview of the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentURL":{
            "type":"string",
            "description":"Value that represents the URL of the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"Value that represents the download information of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "EntityName":{
            "title":"Entity Name",
            "maxLength":40,
            "type":"string",
            "description":"Value that represents the entity of the attachment.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Value that represents the error status associated with the attachment creation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Value that represents the error details associated with the attachment creation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Value that represents the expiration date of the attachment associated with the item revision.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the file attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Value the represents the name of a file of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"Value that represents the URL of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ItemId":{
            "maxLength":150,
            "type":"string",
            "description":"Value that uniquely represents the item associated with the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Indicates the date and time of the last update of the attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"Indicates the last user who updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Indicates the user name of the user who updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "maxLength":150,
            "type":"string",
            "description":"Represents the organization associated with the item attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryCategoryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"string",
            "description":"Value that indicates whether the attachment is the primary attachment associated with the item revision.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RevisionId":{
            "maxLength":150,
            "type":"string",
            "description":"Value that indicates the revision ID associated with the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Value that represents the title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Value that represents the content type of the file attachments associated with the item revision.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Value that indicates the length of the file attachment associated with the item revision.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Value that indicates the name of the file attachment associated with the item revision.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Contents of the text file that's attached.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"Value the represents the 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":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"Value that represents the URL for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"Value that represents the name of user who uploads the attachment.",
            "nullable":false,
            "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"
            }
        }
    }
}

Nested Schema : AttachedDocumentsDFF

Type: array

The name of the attachment descriptive flexfield.

Show Source

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

{
    "type":"array",
    "description":"The name of the attachment descriptive flexfield.",
    "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

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• AttachedDocumentId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AttachedDocumentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Context Segment",
            "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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

cancelCheckOut

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

Parameters:

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

Cancels the check out and makes the item attachment available to other users.

checkIn

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

Parameters:

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

Makes the attachment available to other users until the item attachment is checked out by another user.

checkOut

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

Parameters:

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

Marks the item attachment temporarily unavailable to other users, until the item attachment is checked in, or another user undo the check out.

downloadAttachmentAudit

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

Parameters:

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

Audits the downloads of the attachments.

fetchVersions

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

Parameters:

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

Fetches the versions of an attachment.

previewAttachmentAudit

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

Parameters:

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

Audits the previews of the attachments.

updateActiveVersion

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

Parameters:

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

Updates the active version of an attachment.

Back to Top