Jump to

• Request
• Response

Create extensible flexfields

post

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

Request

Path Parameters

• ItemRevisionUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- RevisionId, OrganizationId and InventoryItemId ---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 with a filter on the primary key values in order to navigate to a specific instance of Item Revisions.
  
  For example: ItemRevision?q=RevisionId=<value1>;OrganizationId=<value2>;InventoryItemId=<value3>
• 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 : 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"
            }
        }
    }
}

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

Back to Top