Jump to

• Request
• Response

Get one item revision

get

/fscmRestApi/resources/11.13.18.05/itemTemplates/{itemTemplatesUniqID}/child/itemRevisions/{itemRevisionsUniqID}

Request

Path Parameters

• itemRevisionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Item Revisions resource and used to uniquely identify an instance of Item Revisions. The client should not generate the hash key value. Instead, the client should query on the Item Revisions collection resource in order to navigate to a specific instance of Item Revisions to get the hash key.
• itemTemplatesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Item Templates resource and used to uniquely identify an instance of Item Templates. The client should not generate the hash key value. Instead, the client should query on the Item Templates collection resource in order to navigate to a specific instance of Item Templates to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : itemTemplates-itemRevisions-item-response

Type: object

Show Source

• DFFs: array Descriptive Flexfields for Item Revisions
  Title: Descriptive Flexfields for Item Revisions

  The Descriptive Flexfields for Item Revisions resource manages the item revision contextual descriptive flexfields in an item template.
• EFFs: array Extensible Flexfields for Item Revisions
  Title: Extensible Flexfields for Item Revisions

  The Extensible Flexfields for Item Revisions resource manages item revision extensible descriptive flexfields in an item template. Extensible flexfields are user-specified set of fields that are used to capture a characteristic of a item revision such as, color or size.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• 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.

{
    "type":"object",
    "properties":{
        "DFFs":{
            "title":"Descriptive Flexfields for Item Revisions",
            "type":"array",
            "description":"The Descriptive Flexfields for Item Revisions resource manages the item revision contextual descriptive flexfields in an item template.",
            "items":{
                "$ref":"#/components/schemas/itemTemplates-itemRevisions-DFFs-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "EFFs":{
            "title":"Extensible Flexfields for Item Revisions",
            "type":"array",
            "description":"The Extensible Flexfields for Item Revisions resource manages item revision extensible descriptive flexfields in an item template. Extensible flexfields are user-specified set of fields that are used to capture a characteristic of a item revision such as, color or size.",
            "items":{
                "$ref":"#/components/schemas/itemTemplates-itemRevisions-EFFs-item-response"
            }
        }
    }
}

Nested Schema : Descriptive Flexfields for Item Revisions

Type: array

Title: Descriptive Flexfields for Item Revisions

The Descriptive Flexfields for Item Revisions resource manages the item revision contextual descriptive flexfields in an item template.

Show Source

• Array of: object itemTemplates-itemRevisions-DFFs-item-response

{
    "title":"Descriptive Flexfields for Item Revisions",
    "type":"array",
    "description":"The Descriptive Flexfields for Item Revisions resource manages the item revision contextual descriptive flexfields in an item template.",
    "items":{
        "$ref":"#/components/schemas/itemTemplates-itemRevisions-DFFs-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 item revision extensible descriptive flexfields in an item template. Extensible flexfields are user-specified set of fields that are used to capture a characteristic of a item revision such as, color or size.

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 item revision extensible descriptive flexfields in an item template. Extensible flexfields are user-specified set of fields that are used to capture a characteristic of a item revision such as, color or size.",
    "items":{
        "$ref":"#/components/schemas/itemTemplates-itemRevisions-EFFs-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 : itemTemplates-itemRevisions-DFFs-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 30

  Descriptive flexfield context name for items.
• __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 items.",
            "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"
    }
}

Links

DFFs

Operation: /fscmRestApi/resources/11.13.18.05/itemTemplates/{itemTemplatesUniqID}/child/itemRevisions/{itemRevisionsUniqID}/child/DFFs

Parameters:

• itemRevisionsUniqID: $request.path.itemRevisionsUniqID
• itemTemplatesUniqID: $request.path.itemTemplatesUniqID

The Descriptive Flexfields for Item Revisions resource manages the item revision contextual descriptive flexfields in an item template.

EFFs

Operation: /fscmRestApi/resources/11.13.18.05/itemTemplates/{itemTemplatesUniqID}/child/itemRevisions/{itemRevisionsUniqID}/child/EFFs

Parameters:

• itemRevisionsUniqID: $request.path.itemRevisionsUniqID
• itemTemplatesUniqID: $request.path.itemTemplatesUniqID

The Extensible Flexfields for Item Revisions resource manages item revision extensible descriptive flexfields in an item template. Extensible flexfields are user-specified set of fields that are used to capture a characteristic of a item revision such as, color or size.

Back to Top