Jump to

• Request
• Response

Create item revisions

post

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

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

• EffectivityDate(required): string (date-time)
  Title: Effective Date

  Date when the revision goes into effect.
• ItemId(required): integer (int64)
  Value that uniquely identifies the part, item, product, or service.
• ItemRevisionDescription: string
  Title: Description

  Maximum Length: 240

  Description of the item revision.
• ItemRevisionDFF: array Descriptive Flexfields for Item Revisions
  Title: Descriptive Flexfields for Item Revisions

  The Descriptive Flexfields for Item Revisions resource manages the descriptive flexfields of item revision.
• ItemRevisionEffCategory: array Extensible Flexfields for Item Revisions
  Title: Extensible Flexfields for Item Revisions

  The Extensible Flexfields for Item Revisions resource manages the values for item extensible flexfields. Item flexfields are user-defined attributes.
• ItemRevisionTranslation: array Item Revision Translatable Attributes
  Title: Item Revision Translatable Attributes

  The Item Revision Translatable Attributes resource manages the translatable attributes of item revision.
• RequestId: integer (int64)
  Value that uniquely identifies the request. This attribute is generated during import. This value is used to verify import, when items are published.
• RevisionAttachment: array Item Revision Attachments
  Title: Item Revision Attachments

  The Item Revision Attachments resource manages attachments associated with item revisions.
• RevisionCode(required): string
  Title: Revision Code

  Maximum Length: 18

  Value that identifies the revision.
• RevisionExtensibleFlexfieldCategoryCode: string
  Maximum Length: 240

  Abbreviation that identifies the item class associated with the item revision extensible flexfield. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Classes task.
• RevisionId: integer (int64)
  Value that uniquely identifies the revision of the item.
• RevisionReasonValue: string
  Reason for the revision. A list of accepted values is defined in the lookup type ORA_EGP_SAFETY_STK_PLN_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.

{
    "required":[
        "EffectivityDate",
        "ItemId",
        "RevisionCode"
    ],
    "type":"object",
    "properties":{
        "RevisionCode":{
            "title":"Revision Code",
            "maxLength":18,
            "type":"string",
            "description":"Value that identifies the revision.",
            "nullable":false
        },
        "ItemRevisionDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the item revision.",
            "nullable":true
        },
        "ItemRevisionTranslation":{
            "title":"Item Revision Translatable Attributes",
            "type":"array",
            "description":"The Item Revision Translatable Attributes resource manages the translatable attributes of item revision.",
            "items":{
                "$ref":"#/components/schemas/itemsV2-ItemRevision-ItemRevisionTranslation-item-post-request"
            }
        },
        "RevisionReasonValue":{
            "type":"string",
            "description":"Reason for the revision. A list of accepted values is defined in the lookup type ORA_EGP_SAFETY_STK_PLN_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RevisionExtensibleFlexfieldCategoryCode":{
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the item class associated with the item revision extensible flexfield. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Classes task.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemRevisionEffCategory":{
            "title":"Extensible Flexfields for Item Revisions",
            "type":"array",
            "description":"The Extensible Flexfields for Item Revisions resource manages the values for item extensible flexfields. Item flexfields are user-defined attributes.",
            "items":{
                "$ref":"#/components/schemas/itemsV2-ItemRevision-ItemRevisionEffCategory-item-post-request"
            },
            "x-cardinality":"1"
        },
        "RevisionAttachment":{
            "title":"Item Revision Attachments",
            "type":"array",
            "description":"The Item Revision Attachments resource manages attachments associated with item revisions.",
            "items":{
                "$ref":"#/components/schemas/itemsV2-ItemRevision-RevisionAttachment-item-post-request"
            }
        },
        "RequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the request. This attribute is generated during import. This value is used to verify import, when items are published.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EffectivityDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"Date when the revision goes into effect.",
            "format":"date-time",
            "nullable":false
        },
        "ItemRevisionDFF":{
            "title":"Descriptive Flexfields for Item Revisions",
            "type":"array",
            "description":"The Descriptive Flexfields for Item Revisions resource manages the descriptive flexfields of item revision.",
            "items":{
                "$ref":"#/components/schemas/itemsV2-ItemRevision-ItemRevisionDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the part, item, product, or service.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RevisionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the revision of the item.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : Descriptive Flexfields for Item Revisions

Type: array

Title: Descriptive Flexfields for Item Revisions

The Descriptive Flexfields for Item Revisions resource manages the descriptive flexfields of item revision.

Show Source

• Array of: object itemsV2-ItemRevision-ItemRevisionDFF-item-post-request

{
    "title":"Descriptive Flexfields for Item Revisions",
    "type":"array",
    "description":"The Descriptive Flexfields for Item Revisions resource manages the descriptive flexfields of item revision.",
    "items":{
        "$ref":"#/components/schemas/itemsV2-ItemRevision-ItemRevisionDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Extensible Flexfields for Item Revisions

Type: array

Title: Extensible Flexfields for Item Revisions

The Extensible Flexfields for Item Revisions resource manages the values for item extensible flexfields. Item flexfields are user-defined attributes.

Show Source

• Array of: object Discriminator: CategoryCode
  Discriminator: { "propertyName":"CategoryCode", "mapping":{ "ROOT_ICC":"#/components/schemas/oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_itemRevision_categories_view_j__ItemRevisionRootIccPrivateVO-item-post-request" } }

{
    "title":"Extensible Flexfields for Item Revisions",
    "type":"array",
    "description":"The Extensible Flexfields for Item Revisions resource manages the values for item extensible flexfields. Item flexfields are user-defined attributes.",
    "items":{
        "$ref":"#/components/schemas/itemsV2-ItemRevision-ItemRevisionEffCategory-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Item Revision Translatable Attributes

Type: array

Title: Item Revision Translatable Attributes

The Item Revision Translatable Attributes resource manages the translatable attributes of item revision.

Show Source

• Array of: object schema

{
    "title":"Item Revision Translatable Attributes",
    "type":"array",
    "description":"The Item Revision Translatable Attributes resource manages the translatable attributes of item revision.",
    "items":{
        "$ref":"#/components/schemas/itemsV2-ItemRevision-ItemRevisionTranslation-item-post-request"
    }
}

Nested Schema : Item Revision Attachments

Type: array

Title: Item Revision Attachments

The Item Revision Attachments resource manages attachments associated with item revisions.

Show Source

• Array of: object itemsV2-ItemRevision-RevisionAttachment-item-post-request

{
    "title":"Item Revision Attachments",
    "type":"array",
    "description":"The Item Revision Attachments resource manages attachments associated with item revisions.",
    "items":{
        "$ref":"#/components/schemas/itemsV2-ItemRevision-RevisionAttachment-item-post-request"
    }
}

Nested Schema : itemsV2-ItemRevision-ItemRevisionDFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 30

  Descriptive flexfield context name for item revision.
• __FLEX_Context_DisplayValue: string
  Title: Context
• RevisionId: integer (int64)
  Value that uniquely identifies the revision of the item.

{
    "type":"object",
    "properties":{
        "RevisionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the revision of the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "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":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for item revision.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : Discriminator: CategoryCode

Type: object

Discriminator: CategoryCode

Discriminator Values

• ROOT_ICC

{
    "discriminator":{
        "propertyName":"CategoryCode",
        "mapping":{
            "ROOT_ICC":"#/components/schemas/oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_itemRevision_categories_view_j__ItemRevisionRootIccPrivateVO-item-post-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_itemRevision_categories_view_j__ItemRevisionRootIccPrivateVO-item-post-request"
        }
    ]
}

Match One Schema

Show Source

• ROOT_ICC - object oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_itemRevision_categories_view_j__ItemRevisionRootIccPrivateVO-item-post-request

{
    "discriminator":{
        "propertyName":"CategoryCode",
        "mapping":{
            "ROOT_ICC":"#/components/schemas/oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_itemRevision_categories_view_j__ItemRevisionRootIccPrivateVO-item-post-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_itemRevision_categories_view_j__ItemRevisionRootIccPrivateVO-item-post-request"
        }
    ]
}

Nested Schema : oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_itemRevision_categories_view_j__ItemRevisionRootIccPrivateVO-item-post-request

Type: object

Show Source

• CategoryCode: string
  Maximum Length: 240

  Default Value: ROOT_ICC

  Abbreviation that identifies the item class associated with the item revision extensible flexfield. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Classes task.
• RevisionId: integer (int64)
  Value that uniquely identifies the revision.
• VersionId: integer
  Default Value: -1

  Value that uniquely identifies the item version.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the item class associated with the item revision extensible flexfield. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Classes task.",
            "nullable":true,
            "default":"ROOT_ICC"
        },
        "VersionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item version.",
            "nullable":true,
            "default":-1,
            "x-queryable":false
        },
        "RevisionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the revision.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• Description: string
  Maximum Length: 240

  Not exposed in code.
• Language: string
  Maximum Length: 4

  Language associated with item long description.
• RevisionId: integer (int64)
  Value that uniquely identifies the revision of the item.
• SourceLanguage: string
  Maximum Length: 4

  Language from which the item revision values are translated.

{
    "type":"object",
    "properties":{
        "SourceLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"Language from which the item revision values are translated.",
            "nullable":false
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Not exposed in code.",
            "nullable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language associated with item long description.",
            "nullable":false
        },
        "RevisionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the revision of the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : itemsV2-ItemRevision-RevisionAttachment-item-post-request

Type: object

Show Source

• AttachedDocumentId: integer (int64)
  An unique identifier for document that is an attachment in the repository.
• 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

  Not exposed in code.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the item revision 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)
  Not exposed in code.
• 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 revision 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 revision attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Not exposed in code.",
            "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 revision 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":"Not exposed in code.",
            "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
            }
        },
        "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"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : itemsV2-ItemRevision-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the item.
• CreationDateTime: string (date-time)
  Read Only: true

  Date and time when the user created the item revision.
• EffectivityDate: string (date-time)
  Title: Effective Date

  Date when the revision goes into effect.
• EndEffectivityDate: string (date-time)
  Read Only: true

  Date and time when the effectivity of the revision ends.
• ImplementationDate: string (date-time)
  Read Only: true

  Date and time when the revision was implemented.
• ItemId: integer (int64)
  Value that uniquely identifies the part, item, product, or service.
• ItemRevisionDescription: string
  Title: Description

  Maximum Length: 240

  Description of the item revision.
• ItemRevisionDFF: array Descriptive Flexfields for Item Revisions
  Title: Descriptive Flexfields for Item Revisions

  The Descriptive Flexfields for Item Revisions resource manages the descriptive flexfields of item revision.
• ItemRevisionEffCategory: array Extensible Flexfields for Item Revisions
  Title: Extensible Flexfields for Item Revisions

  The Extensible Flexfields for Item Revisions resource manages the values for item extensible flexfields. Item flexfields are user-defined attributes.
• ItemRevisionTranslation: array Item Revision Translatable Attributes
  Title: Item Revision Translatable Attributes

  The Item Revision Translatable Attributes resource manages the translatable attributes of item revision.
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the item revision.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the item.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
• RequestId: integer (int64)
  Value that uniquely identifies the request. This attribute is generated during import. This value is used to verify import, when items are published.
• RevisionAttachment: array Item Revision Attachments
  Title: Item Revision Attachments

  The Item Revision Attachments resource manages attachments associated with item revisions.
• RevisionCode: string
  Title: Revision Code

  Maximum Length: 18

  Value that identifies the revision.
• RevisionExtensibleFlexfieldCategoryCode: string
  Maximum Length: 240

  Abbreviation that identifies the item class associated with the item revision extensible flexfield. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Classes task.
• RevisionId: integer (int64)
  Value that uniquely identifies the revision of the item.
• RevisionReasonValue: string
  Reason for the revision. A list of accepted values is defined in the lookup type ORA_EGP_SAFETY_STK_PLN_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemRevisionDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the item revision.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemRevisionTranslation":{
            "title":"Item Revision Translatable Attributes",
            "type":"array",
            "description":"The Item Revision Translatable Attributes resource manages the translatable attributes of item revision.",
            "items":{
                "$ref":"#/components/schemas/itemsV2-ItemRevision-ItemRevisionTranslation-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RevisionReasonValue":{
            "type":"string",
            "description":"Reason for the revision. A list of accepted values is defined in the lookup type ORA_EGP_SAFETY_STK_PLN_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RevisionExtensibleFlexfieldCategoryCode":{
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the item class associated with the item revision extensible flexfield. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Classes task.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemRevisionEffCategory":{
            "title":"Extensible Flexfields for Item Revisions",
            "type":"array",
            "description":"The Extensible Flexfields for Item Revisions resource manages the values for item extensible flexfields. Item flexfields are user-defined attributes.",
            "items":{
                "$ref":"#/components/schemas/itemsV2-ItemRevision-ItemRevisionEffCategory-item-response"
            },
            "x-cardinality":"1"
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date and time when the user most recently updated the item revision.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the request. This attribute is generated during import. This value is used to verify import, when items are published.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the part, item, product, or service.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevisionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the revision of the item.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RevisionCode":{
            "title":"Revision Code",
            "maxLength":18,
            "type":"string",
            "description":"Value that identifies the revision.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time when the user created the item revision.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RevisionAttachment":{
            "title":"Item Revision Attachments",
            "type":"array",
            "description":"The Item Revision Attachments resource manages attachments associated with item revisions.",
            "items":{
                "$ref":"#/components/schemas/itemsV2-ItemRevision-RevisionAttachment-item-response"
            }
        },
        "EffectivityDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"Date when the revision goes into effect.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "EndEffectivityDate":{
            "type":"string",
            "description":"Date and time when the effectivity of the revision ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementationDate":{
            "type":"string",
            "description":"Date and time when the revision was implemented.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemRevisionDFF":{
            "title":"Descriptive Flexfields for Item Revisions",
            "type":"array",
            "description":"The Descriptive Flexfields for Item Revisions resource manages the descriptive flexfields of item revision.",
            "items":{
                "$ref":"#/components/schemas/itemsV2-ItemRevision-ItemRevisionDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Descriptive Flexfields for Item Revisions

Type: array

Title: Descriptive Flexfields for Item Revisions

The Descriptive Flexfields for Item Revisions resource manages the descriptive flexfields of item revision.

Show Source

• Array of: object itemsV2-ItemRevision-ItemRevisionDFF-item-response

{
    "title":"Descriptive Flexfields for Item Revisions",
    "type":"array",
    "description":"The Descriptive Flexfields for Item Revisions resource manages the descriptive flexfields of item revision.",
    "items":{
        "$ref":"#/components/schemas/itemsV2-ItemRevision-ItemRevisionDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Extensible Flexfields for Item Revisions

Type: array

Title: Extensible Flexfields for Item Revisions

The Extensible Flexfields for Item Revisions resource manages the values for item extensible flexfields. Item flexfields are user-defined attributes.

Show Source

• Array of: object Discriminator: CategoryCode
  Discriminator: { "propertyName":"CategoryCode", "mapping":{ "ROOT_ICC":"#/components/schemas/oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_itemRevision_categories_view_j__ItemRevisionRootIccPrivateVO-item-response" } }

{
    "title":"Extensible Flexfields for Item Revisions",
    "type":"array",
    "description":"The Extensible Flexfields for Item Revisions resource manages the values for item extensible flexfields. Item flexfields are user-defined attributes.",
    "items":{
        "$ref":"#/components/schemas/itemsV2-ItemRevision-ItemRevisionEffCategory-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Item Revision Translatable Attributes

Type: array

Title: Item Revision Translatable Attributes

The Item Revision Translatable Attributes resource manages the translatable attributes of item revision.

Show Source

• Array of: object itemsV2-ItemRevision-ItemRevisionTranslation-item-response

{
    "title":"Item Revision Translatable Attributes",
    "type":"array",
    "description":"The Item Revision Translatable Attributes resource manages the translatable attributes of item revision.",
    "items":{
        "$ref":"#/components/schemas/itemsV2-ItemRevision-ItemRevisionTranslation-item-response"
    }
}

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 : Item Revision Attachments

Type: array

Title: Item Revision Attachments

The Item Revision Attachments resource manages attachments associated with item revisions.

Show Source

• Array of: object itemsV2-ItemRevision-RevisionAttachment-item-response

{
    "title":"Item Revision Attachments",
    "type":"array",
    "description":"The Item Revision Attachments resource manages attachments associated with item revisions.",
    "items":{
        "$ref":"#/components/schemas/itemsV2-ItemRevision-RevisionAttachment-item-response"
    }
}

Nested Schema : itemsV2-ItemRevision-ItemRevisionDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 30

  Descriptive flexfield context name for item revision.
• __FLEX_Context_DisplayValue: string
  Title: Context
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RevisionId: integer (int64)
  Value that uniquely identifies the revision of the item.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RevisionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the revision of the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "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":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for item revision.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "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."
        }
    }
}

Nested Schema : Discriminator: CategoryCode

Type: object

Discriminator: CategoryCode

Discriminator Values

• ROOT_ICC

{
    "discriminator":{
        "propertyName":"CategoryCode",
        "mapping":{
            "ROOT_ICC":"#/components/schemas/oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_itemRevision_categories_view_j__ItemRevisionRootIccPrivateVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_itemRevision_categories_view_j__ItemRevisionRootIccPrivateVO-item-response"
        }
    ]
}

Match One Schema

Show Source

• ROOT_ICC - object oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_itemRevision_categories_view_j__ItemRevisionRootIccPrivateVO-item-response

{
    "discriminator":{
        "propertyName":"CategoryCode",
        "mapping":{
            "ROOT_ICC":"#/components/schemas/oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_itemRevision_categories_view_j__ItemRevisionRootIccPrivateVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_itemRevision_categories_view_j__ItemRevisionRootIccPrivateVO-item-response"
        }
    ]
}

Nested Schema : oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_itemRevision_categories_view_j__ItemRevisionRootIccPrivateVO-item-response

Type: object

Show Source

• CategoryCode: string
  Maximum Length: 240

  Default Value: ROOT_ICC

  Abbreviation that identifies the item class associated with the item revision extensible flexfield. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Classes task.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RevisionId: integer (int64)
  Value that uniquely identifies the revision.
• VersionId: integer
  Default Value: -1

  Value that uniquely identifies the item version.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the item class associated with the item revision extensible flexfield. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Classes task.",
            "nullable":true,
            "default":"ROOT_ICC"
        },
        "VersionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item version.",
            "nullable":true,
            "default":-1,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RevisionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the revision.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : itemsV2-ItemRevision-ItemRevisionTranslation-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the item.
• CreationDateTime: string (date-time)
  Read Only: true

  Date and time when the user created the item revision translatable attribute.
• Description: string
  Maximum Length: 240

  Not exposed in code.
• Language: string
  Maximum Length: 4

  Language associated with item long description.
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the item revision translatable attribute.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the item.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• RevisionId: integer (int64)
  Value that uniquely identifies the revision of the item.
• SourceLanguage: string
  Maximum Length: 4

  Language from which the item revision values are translated.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"Language from which the item revision values are translated.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time when the user created the item revision translatable attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Not exposed in code.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date and time when the user most recently updated the item revision translatable attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language associated with item long description.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RevisionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the revision of the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the item.",
            "nullable":true,
            "readOnly":true,
            "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 : itemsV2-ItemRevision-RevisionAttachment-item-response

Type: object

Show Source

• AttachedDocumentId: integer (int64)
  An unique identifier for document that is an attachment in the repository.
• 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

  Not exposed in code.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the item revision 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)
  Not exposed in code.
• 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 user most recently updated the item revision attachment.
• 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 revision 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 revision 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":"Not exposed in code.",
            "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 revision 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":"Not exposed in code.",
            "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"
            }
        },
        "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 user most recently updated the item revision attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "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"
    }
}

Links

ItemRevisionDFF

Operation: /fscmRestApi/resources/11.13.18.05/itemsV2/{itemsV2UniqID}/child/ItemRevision/{ItemRevisionUniqID}/child/ItemRevisionDFF

Parameters:

• ItemRevisionUniqID: $request.path.ItemRevisionUniqID
• itemsV2UniqID: $request.path.itemsV2UniqID

The Descriptive Flexfields for Item Revisions resource manages the descriptive flexfields of item revision.

ItemRevisionEffCategory

Operation: /fscmRestApi/resources/11.13.18.05/itemsV2/{itemsV2UniqID}/child/ItemRevision/{ItemRevisionUniqID}/child/ItemRevisionEffCategory

Parameters:

• ItemRevisionUniqID: $request.path.ItemRevisionUniqID
• itemsV2UniqID: $request.path.itemsV2UniqID

The Extensible Flexfields for Item Revisions resource manages the values for item extensible flexfields. Item flexfields are user-defined attributes.

ItemRevisionTranslation

Operation: /fscmRestApi/resources/11.13.18.05/itemsV2/{itemsV2UniqID}/child/ItemRevision/{ItemRevisionUniqID}/child/ItemRevisionTranslation

Parameters:

• ItemRevisionUniqID: $request.path.ItemRevisionUniqID
• itemsV2UniqID: $request.path.itemsV2UniqID

The Item Revision Translatable Attributes resource manages the translatable attributes of item revision.

RevisionAttachment

Operation: /fscmRestApi/resources/11.13.18.05/itemsV2/{itemsV2UniqID}/child/ItemRevision/{ItemRevisionUniqID}/child/RevisionAttachment

Parameters:

• ItemRevisionUniqID: $request.path.ItemRevisionUniqID
• itemsV2UniqID: $request.path.itemsV2UniqID

The Item Revision Attachments resource manages attachments associated with item revisions.

Back to Top