REST API for Oracle Fusion Cloud SCM

Get one association

get

/fscmRestApi/resources/11.13.18.05/itemsV2/{itemsV2UniqID}/child/ItemSupplierAssociation/{ItemSupplierAssociationUniqID}

Request

Path Parameters

ItemSupplierAssociationUniqID(required): string

This is the hash key of the attributes which make up the composite key--- ItemId, OrganizationId, SupplierId, SupplierSiteId, AcdType, ChangeLineId, VersionId, OrganizationId1 and InventoryItemId ---for the Item-Supplier Associations resource and used to uniquely identify an instance of Item-Supplier Associations. The client should not generate the hash key value. Instead, the client should query on the Item-Supplier Associations collection resource with a filter on the primary key values in order to navigate to a specific instance of Item-Supplier Associations.

For example: ItemSupplierAssociation?q=ItemId=<value1>;OrganizationId=<value2>;SupplierId=<value3>;SupplierSiteId=<value4>;AcdType=<value5>;ChangeLineId=<value6>;VersionId=<value7>;OrganizationId1=<value8>;InventoryItemId=<value9>
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.

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.

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.

Root Schema : itemsV2-ItemSupplierAssociation-item-response

Type: object

Show Source

Address: string

Maximum Length: 255

Address of the supplier. Review and update the value for this attribute using the Suppliers work area, and the Manage Suppliers task.
AddressName: string

Maximum Length: 255

Name of the supplier address. Review and update the value for this attribute using the Suppliers work area, and the Manage Suppliers task.
AlternateSupplierNumber: string

Maximum Length: 255

Alternate number that identifies the supplier. Review and update the value for this attribute using the Suppliers work area, and the Manage suppliers task.
AssociationId: integer (int64)

Value that uniquely identifies an item-supplier association.
CreationDateTime: string (date-time)

Read Only: true

Date and time when the user created the item-supplier association.
ItemId: integer (int64)

Value that uniquely identifies the part, item, product, or service.
ItemSupplierEffCategory: array Extensible Flexfields for Item-Supplier Associations

Title: Extensible Flexfields for Item-Supplier Associations

The Extensible Flexfields for Item-Supplier Associations resource manages the values for item supplier association extensible flexfields. Item flexfields are user-defined attributes.
LastUpdateDateTime: string (date-time)

Read Only: true

Date and time when the user most recently updated the item-supplier association.
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.
PartySiteNumber: string

Number that identifies the supplier site.
PrimaryFlag: boolean

Title: Primary

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then it is a primary supplier association. If false, then it is not a primary supplier association. The default value is false.
RegistryId: string

Read Only: true

Maximum Length: 255

Number that uniquely identifies a supplier party. Review and update the value for this attribute using the Suppliers work area, and the Manage Suppliers task.
RequestId: integer (int64)

Read Only: true

Value that uniquely identifies the request. This attribute is generated during import. This value is used to verify import, when items are published.
SupplierExtensibleFlexfieldCategoryCode: string

Maximum Length: 240

Value that uniquely 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.
SupplierId: integer (int64)

This attribute is not currently used.
SupplierItemNumber: string

Maximum Length: 255

This attribute is not currently used.
SupplierName: string

Name of the supplier. Review and update the value for this attribute using the Suppliers work area, and the Manage Suppliers task.
SupplierSiteAssociationStatusValue: string

Status of item supplier association.
SupplierSiteId: integer (int64)

Value that uniquely identifies a supplier address. Review and update the value for this attribute using the Suppliers work area, and the Manage suppliers task.

{
    "type":"object",
    "properties":{
        "SupplierItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"This attribute is not currently used.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then it is a primary supplier association. If false, then it is not a primary supplier association. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date and time when the user most recently updated the item-supplier association.",
            "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,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Address":{
            "maxLength":255,
            "type":"string",
            "description":"Address of the supplier. Review and update the value for this attribute using the Suppliers work area, and the Manage Suppliers task.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteAssociationStatusValue":{
            "type":"string",
            "description":"Status of item supplier association.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "ItemSupplierEffCategory":{
            "title":"Extensible Flexfields for Item-Supplier Associations",
            "type":"array",
            "description":"The Extensible Flexfields for Item-Supplier Associations resource manages the values for item supplier association extensible flexfields. Item flexfields are user-defined attributes.",
            "items":{
                "$ref":"#/components/schemas/itemsV2-ItemSupplierAssociation-ItemSupplierEffCategory-item-response"
            },
            "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
            },
            "x-queryable":true
        },
        "AddressName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier address. Review and update the value for this attribute using the Suppliers work area, and the Manage Suppliers task.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"This attribute is not currently used.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartySiteNumber":{
            "type":"string",
            "description":"Number that identifies the supplier site.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time when the user created the item-supplier association.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierName":{
            "type":"string",
            "description":"Name of the supplier. Review and update the value for this attribute using the Suppliers work area, and the Manage Suppliers task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies a supplier address. Review and update the value for this attribute using the Suppliers work area, and the Manage suppliers task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AlternateSupplierNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Alternate number that identifies the supplier. Review and update the value for this attribute using the Suppliers work area, and the Manage suppliers task.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierExtensibleFlexfieldCategoryCode":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely 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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RegistryId":{
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies a supplier party. Review and update the value for this attribute using the Suppliers work area, and the Manage Suppliers task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationId":{
            "type":"integer",
            "description":"Value that uniquely identifies an item-supplier association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Extensible Flexfields for Item-Supplier Associations

Type: array

Title: Extensible Flexfields for Item-Supplier Associations

The Extensible Flexfields for Item-Supplier Associations resource manages the values for item supplier association 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_itemSupplier_categories_view_j__ItemSupplierRootIccPrivateVO-item-response" } }

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : 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_itemSupplier_categories_view_j__ItemSupplierRootIccPrivateVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_itemSupplier_categories_view_j__ItemSupplierRootIccPrivateVO-item-response"
        }
    ]
}

Match One Schema

Show Source

ROOT_ICC - object oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_itemSupplier_categories_view_j__ItemSupplierRootIccPrivateVO-item-response

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

Nested Schema : oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_itemSupplier_categories_view_j__ItemSupplierRootIccPrivateVO-item-response

Type: object

Show Source

AcdType: string

Maximum Length: 30

Default Value: PROD

This attribute is not currently used.
AssociationId: integer (int64)

Value that uniquely identifies an item-supplier association.
CategoryCode: string

Maximum Length: 240

Default Value: ROOT_ICC

Value that uniquely 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.
MasterOrganizationId: integer (int64)

Read Only: true

Value that uniquely identifies the master organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
OrganizationId: integer (int64)

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.
SupplierId: integer (int64)

Value that uniquely identifies the supplier.
SupplierSiteId: integer (int64)

Value that uniquely identifies a supplier address. Review and update the value for this attribute using the Suppliers work area, and the Manage Suppliers task.
VersionId: integer (int64)

Value that uniquely identifies the item version.

{
    "type":"object",
    "properties":{
        "VersionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryCode":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely 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"
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "AcdType":{
            "maxLength":30,
            "type":"string",
            "description":"This attribute is not currently used.",
            "nullable":false,
            "default":"PROD",
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "MasterOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the master 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":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies a supplier address. Review and update the value for this attribute using the Suppliers work area, and the Manage Suppliers task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "AssociationId":{
            "type":"integer",
            "description":"Value that uniquely identifies an item-supplier association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "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."
        }
    }
}

Links

ItemSupplierEffCategory

Operation: /fscmRestApi/resources/11.13.18.05/itemsV2/{itemsV2UniqID}/child/ItemSupplierAssociation/{ItemSupplierAssociationUniqID}/child/ItemSupplierEffCategory

Parameters:

ItemSupplierAssociationUniqID: $request.path.ItemSupplierAssociationUniqID
itemsV2UniqID: $request.path.itemsV2UniqID

The Extensible Flexfields for Item-Supplier Associations resource manages the values for item supplier association extensible flexfields. Item flexfields are user-defined attributes.