Jump to

• Request
• Response

Get one product relationship

get

/fscmRestApi/resources/11.13.18.05/supplierProducts/{supplierProductsUniqID}/child/productRelationships/{InterfaceTableUniqueId}

Request

Path Parameters

• InterfaceTableUniqueId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• supplierProductsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Supplier Products resource and used to uniquely identify an instance of Supplier Products. The client should not generate the hash key value. Instead, the client should query on the Supplier Products collection resource in order to navigate to a specific instance of Supplier Products 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: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

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

Body ()

Root Schema : supplierProducts-productRelationships-item-response

Type: object

Show Source

• CompetitorSubTypeValue: string
  Maximum Length: 255

  Value that indicates the type of the competitor trading partner item in the item relationship. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the product relationship.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the application created the product relationship.
• CrossReference: string
  Title: Cross Reference

  Maximum Length: 1020

  Value that uniquely identifies the cross-reference of an item.
• CrossReferenceTypeValue: string
  Maximum Length: 255

  Value that indicates the type of cross-reference relationship. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
• EndDate: string (date-time)
  Title: End Date

  Date and time when the item relationship ends or is no longer active.
• EPCGTINSerial: integer (int64)
  Title: EPC or GTIN Serial

  Value that uniquely identifies the electronic product code (EPC) or global trade item number (GTIN) identifier for the GTIN item relationship.
• FromItemNumber: string
  Title: Item

  Maximum Length: 820

  Name or number of the item from which the relationship is created.
• InterfaceTableUniqueId: integer (int64)
  Value that uniquely identifies the product relationship row in staging.
• ItemRelationshipType: string
  Title: Type

  Maximum Length: 30

  Value that indicates the type of trading partner item relationship. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the product relationship was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the product relationship.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MasterOrganizationCode: string
  Title: Master Organization

  Maximum Length: 18

  Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
• MasterOrganizationId: integer (int64)
  Title: Master Organization

  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.
• OrganizationCode: string
  Title: Default Organization

  Maximum Length: 18

  Abbreviation that identifies the item cross-reference relationship 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)
  Title: Organization

  Value that uniquely identifies the item cross-reference relationship organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
• OrganizationIndependentFlag: boolean
  Title: Organization Independent

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the item relationship is applicable across all organizations. If false, then the item relationship is not applicable across all organizations. This attribute doesn't have a default value.
• PlanningEnabledFlag: boolean
  Title: Planning Enabled

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then planning is enabled for related item. If false, then planning is not enabled for related item. This attribute doesn't have a default value.
• PreferenceNumber: integer (int64)
  Title: Rank

  Number that indicates the rank of the trading partner item relationship.
• ProductNumber: string
  Title: Spoke Item

  Maximum Length: 255

  Name or number of the spoke part, item, product, or service.
• ReciprocalFlag: boolean
  Title: Reciprocal

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then a reciprocal relationship exists in the item relationship. If false, then a reciprocal relationship doesn't exists in the item relationship. This attribute doesn't have a default value.
• RelatedItemRelationshipRank: integer
  Rank of the related item relationship.
• RelationshipDescription: string
  Title: Relationship Description

  Maximum Length: 200

  Description of the item relationship.
• RelationshipStatusCode: string
  Maximum Length: 30

  Abbreviation that uniquely identifies the status of trading partner item relationship. A list of accepted values is defined in the lookup type ORA_ACA_AML_STATUS. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Product Development Lookups task.
• RelationshipStatusValue: string
  Status of trading partner item relationship. A list of accepted values is defined in the lookup type ORA_ACA_AML_STATUS. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Product Development Lookups task.
• RelationshipTypeValue: string
  Value that indicates the type of related item. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
• SpokeSystemCode: string
  Maximum Length: 255

  Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
• SpokeSystemId: integer (int64)
  Title: Spoke System ID

  Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
• StartDate: string (date-time)
  Title: Start Date

  Date and time when the item relationship begins or becomes active.
• SubType: string
  Title: Type

  Maximum Length: 100

  Abbreviation that identifies the party type of the GTIN in item relationship. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
• SubTypeValue: string
  Value that indicates the party type of the global trade item number (GTIN) in item relationship. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
• SupplierId: integer (int64)
  Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
• SupplierName: string
  Title: Supplier

  Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
• ToItemNumber: string
  Title: To Item

  Maximum Length: 820

  Name or number of the item for which the relationship is created.
• TradingPartnerItemNumber: string
  Title: Trading Partner Item

  Maximum Length: 150

  Name or number of the item from a trading partner.
• TradingPartnerNumber: string
  Title: Trading Partner Number

  Maximum Length: 30

  Number that identifies the trading partner.
• TransactionId: integer (int64)
  Value that identifies the product row in the staging interface.
• TransactionType: string
  Title: Transaction Type

  Maximum Length: 10

  Type of action to be taken when importing a record. Valid values include SYNC and DELETE.
• UOMCode: string
  Title: UOM

  Maximum Length: 72

  Unit of measure code of the global trade item number (GTIN) relationship.
• UOMCodeValue: string
  Maximum Length: 255

  Unit of measure of the global trade item number (GTIN) relationship.
• UOMName: string
  Title: UOM

  Maximum Length: 25

  Unit of measure name of the global trade item number (GTIN) relationship.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the application created the product relationship.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionType":{
            "title":"Transaction Type",
            "maxLength":10,
            "type":"string",
            "description":"Type of action to be taken when importing a record. Valid values include SYNC and DELETE.",
            "nullable":true,
            "x-queryable":true
        },
        "SpokeSystemId":{
            "title":"Spoke System ID",
            "type":"integer",
            "description":"Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TradingPartnerItemNumber":{
            "title":"Trading Partner Item",
            "maxLength":150,
            "type":"string",
            "description":"Name or number of the item from a trading partner.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"Value that uniquely identifies the item cross-reference relationship 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,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubTypeValue":{
            "type":"string",
            "description":"Value that indicates the party type of the global trade item number (GTIN) in item relationship. 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
        },
        "RelationshipTypeValue":{
            "type":"string",
            "description":"Value that indicates the type of related item. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date and time when the item relationship begins or becomes active.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FromItemNumber":{
            "title":"Item",
            "maxLength":820,
            "type":"string",
            "description":"Name or number of the item from which the relationship is created.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemRelationshipType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the type of trading partner item relationship. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferenceNumber":{
            "title":"Rank",
            "type":"integer",
            "description":"Number that indicates the rank of the trading partner item relationship.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MasterOrganizationId":{
            "title":"Master Organization",
            "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":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationIndependentFlag":{
            "title":"Organization Independent",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the item relationship is applicable across all organizations. If false, then the item relationship is not applicable across all organizations. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "CrossReferenceTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the type of cross-reference relationship. 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
        },
        "SpokeSystemCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.",
            "nullable":true,
            "x-queryable":false
        },
        "RelationshipDescription":{
            "title":"Relationship Description",
            "maxLength":200,
            "type":"string",
            "description":"Description of the item relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Default Organization",
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the item cross-reference relationship organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EPCGTINSerial":{
            "title":"EPC or GTIN Serial",
            "type":"integer",
            "description":"Value that uniquely identifies the electronic product code (EPC) or global trade item number (GTIN) identifier for the GTIN item relationship.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReciprocalFlag":{
            "title":"Reciprocal",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then a reciprocal relationship exists in the item relationship. If false, then a reciprocal relationship doesn't exists in the item relationship. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningEnabledFlag":{
            "title":"Planning Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then planning is enabled for related item. If false, then planning is not enabled for related item. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the status of trading partner item relationship. A list of accepted values is defined in the lookup type ORA_ACA_AML_STATUS. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Product Development Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":72,
            "type":"string",
            "description":"Unit of measure code of the global trade item number (GTIN) relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the product relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MasterOrganizationCode":{
            "title":"Master Organization",
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the product relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubType":{
            "title":"Type",
            "maxLength":100,
            "type":"string",
            "description":"Abbreviation that identifies the party type of the GTIN in item relationship. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipStatusValue":{
            "type":"string",
            "description":"Status of trading partner item relationship. A list of accepted values is defined in the lookup type ORA_ACA_AML_STATUS. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Product Development Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TradingPartnerNumber":{
            "title":"Trading Partner Number",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the trading partner.",
            "nullable":true,
            "x-queryable":true
        },
        "CompetitorSubTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the type of the competitor trading partner item in the item relationship. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductNumber":{
            "title":"Spoke Item",
            "maxLength":255,
            "type":"string",
            "description":"Name or number of the spoke part, item, product, or service.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date and time when the item relationship ends or is no longer active.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that identifies the product row in the staging interface.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InterfaceTableUniqueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product relationship row in staging.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UOMCodeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure of the global trade item number (GTIN) relationship.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ToItemNumber":{
            "title":"To Item",
            "maxLength":820,
            "type":"string",
            "description":"Name or number of the item for which the relationship is created.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierName":{
            "title":"Supplier",
            "type":"string",
            "description":"Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.",
            "nullable":true,
            "x-queryable":true
        },
        "CrossReference":{
            "title":"Cross Reference",
            "maxLength":1020,
            "type":"string",
            "description":"Value that uniquely identifies the cross-reference of an item.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMName":{
            "title":"UOM",
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure name of the global trade item number (GTIN) relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "RelatedItemRelationshipRank":{
            "type":"integer",
            "description":"Rank of the related item relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the product relationship was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "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 : 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