Get all product relationships
get
/fscmRestApi/resources/11.13.18.05/supplierProducts/{supplierProductsUniqID}/child/productRelationships
Request
Path Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Find product relationships according to the specified primary key criteria.
Finder Variables:- InterfaceTableUniqueId; integer; Value that uniquely identifies the product relationship row in the staging interface.
- PrimaryKey: Find product relationships according to the specified primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CompetitorSubTypeValue; string; 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; User who created the product relationship.
- CreationDate; string; Date and time when the application created the product relationship.
- CrossReference; string; Value that uniquely identifies the cross-reference of an item.
- CrossReferenceTypeValue; string; 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.
- EPCGTINSerial; integer; Value that uniquely identifies the electronic product code (EPC) or global trade item number (GTIN) identifier for the GTIN item relationship.
- EndDate; string; Date and time when the item relationship ends or is no longer active.
- FromItemNumber; string; Name or number of the item from which the relationship is created.
- InterfaceTableUniqueId; integer; Value that uniquely identifies the product relationship row in staging.
- ItemRelationshipType; string; 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 and time when the product relationship was most recently updated.
- LastUpdatedBy; string; User who most recently updated the product relationship.
- MasterOrganizationCode; string; 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; 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; 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; 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; 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 does not have a default value.
- PlanningEnabledFlag; boolean; 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 does not have a default value.
- PreferenceNumber; integer; Number that indicates the rank of the trading partner item relationship.
- ProductNumber; string; Name or number of the spoke part, item, product, or service.
- ReciprocalFlag; boolean; 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 does not exists in the item relationship. This attribute does not have a default value.
- RelatedItemRelationshipRank; integer; Rank of the related item relationship.
- RelationshipDescription; string; Description of the item relationship.
- RelationshipStatusCode; string; 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.
- SpokeSystemId; integer; 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 and time when the item relationship begins or becomes active.
- SubType; string; 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; 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; 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; Name or number of the item for which the relationship is created.
- TradingPartnerItemNumber; string; Name or number of the item from a trading partner.
- TradingPartnerNumber; string; Number that identifies the trading partner.
- TransactionId; integer; Value that identifies the product row in the staging interface.
- TransactionType; string; Type of action to be taken when importing a record. Valid values include SYNC and DELETE.
- UOMCode; string; Unit of measure code of the global trade item number (GTIN) relationship.
- UOMCodeValue; string; Unit of measure of the global trade item number (GTIN) relationship.
- UOMName; string; Unit of measure name of the global trade item number (GTIN) relationship.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 TopResponse
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 : supplierProducts-productRelationships
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : supplierProducts-productRelationships-item-response
Type:
Show Source
object
-
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 does not 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 does not 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 does not exists in the item relationship. This attribute does not 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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.