Get one relationship
get
/fscmRestApi/resources/11.13.18.05/tradingPartnerItemRelationships/{ItemRelationshipId}
Request
Path Parameters
-
ItemRelationshipId(required): integer
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=
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 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 : tradingPartnerItemRelationships-item-response
Type:
Show Source
object
-
CompetitorItemRelationshipType: string
Maximum Length:
255
Type of competitor for the item relationship. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the trading partner item relationship. -
CreationDateTime: string
(date-time)
Read Only:
true
Date and time when the user created the trading partner item relationship. -
CustomerItemRelationshipRank: integer
Title:
Rank
Rank used within the customer item relationship. -
DFF: array
DFF
-
EndDateTime: string
(date-time)
Date when the trading partner item relationship becomes ineffective.
-
InventoryItemId: integer
Value that uniquely identifies an item.
-
Item: string
Maximum Length:
255
Name or number of the part, item, product, or service. -
ItemRelationshipId: integer
(int64)
Value that uniquely identifies the trading partner item relationship.
-
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date when the user most recently updated the trading partner item relationship. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the trading partner item relationship. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the trading partner item relationship. -
LinkedMPNRelationships: array
Linked MPN Relationships
Title:
Linked MPN Relationships
The Linked MPN Relationships resource manages the manufacturer part number relationships that are linked to supplier item relationships for an internal item. -
LinkedSupplierItemRelationships: array
Linked Supplier Item Relationships
Title:
Linked Supplier Item Relationships
The Linked Supplier Item Relationships resource manages the supplier item relationships that are linked to manufacturer part number relationships for an internal item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the organization. -
OrganizationId: integer
Value that uniquely identifies the organization.
-
RegistryId: string
Maximum Length:
255
Value that uniquely identifies the party. -
RelationshipDescription: string
Maximum Length:
240
Description of the trading partner item relationship. -
RelationshipStatus: string
Maximum Length:
255
Status of the trading partner item relationship. -
StartDateTime: string
(date-time)
Date when the trading partner item relationship becomes effective.
-
TradingPartnerId: string
Maximum Length:
255
Value that uniquely identifies the trading partner. -
TradingPartnerItemId: integer
(int64)
Value that uniquely identifies the trading partner item.
-
TradingPartnerItemNumber: string
Maximum Length:
255
Number that identifies a trading partner item, such as supplier item, customer item, competitor item, and manufacturer part number. -
TradingPartnerName: string
Maximum Length:
255
Name of the trading partner. -
TradingPartnerType: string
Maximum Length:
255
Type of the trading partner. -
translatableAttributes: array
Translatable Attributes
Title:
Translatable Attributes
The Translatable Attributes resource manages the translatable attributes for item relationships.
Nested Schema : Linked MPN Relationships
Type:
array
Title:
Linked MPN Relationships
The Linked MPN Relationships resource manages the manufacturer part number relationships that are linked to supplier item relationships for an internal item.
Show Source
Nested Schema : Linked Supplier Item Relationships
Type:
array
Title:
Linked Supplier Item Relationships
The Linked Supplier Item Relationships resource manages the supplier item relationships that are linked to manufacturer part number relationships for an internal item.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Translatable Attributes
Type:
array
Title:
Translatable Attributes
The Translatable Attributes resource manages the translatable attributes for item relationships.
Show Source
Nested Schema : tradingPartnerItemRelationships-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context
-
ItemRelationshipId: integer
(int64)
-
ItemRelationshipType: string
Title:
Type
Maximum Length:30
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Nested Schema : tradingPartnerItemRelationships-LinkedMPNRelationships-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the linked MPN relationship. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the linked MPN relationship. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the linked MPN relationship. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the linked MPN relationship. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the linked MPN relationship. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManufacturerId: integer
Value that uniquely identifies the linked manufacturer.
-
ManufacturerName: string
Maximum Length:
255
Name of the linked manufacturer. -
ManufacturerPartId: integer
Value that uniquely identifies the manufacturer trading partner item.
-
ManufacturerPartNumber: string
Maximum Length:
255
Number that identifies a manufacturer part number. -
ManufacturerRegistryId: string
Maximum Length:
255
Value that uniquely identifies the manufacturer party. -
PrimaryLinkageFlag: boolean
Maximum Length:
1
Default Value:false
Value that identifies whether the linked MPN relationship is primary. The default value is False. -
RelationshipId: integer
(int64)
Value that uniquely identifies the linked MPN relationship.
-
RelationshipStatus: string
Read Only:
true
Maximum Length:255
Status of the linked MPN relationship. -
TPILinkageId: integer
(int64)
Value that uniquely identify MPN relationship linkage.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : tradingPartnerItemRelationships-LinkedSupplierItemRelationships-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the linked supplier item relationship. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the linked supplier item relationship. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the linked supplier item relationship. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the linked supplier item relationship. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login associated with the user who most recently updated the linked supplier item relationship. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryLinkageFlag: boolean
Maximum Length:
1
Default Value:false
Value that identifies whether the linked supplier item relationship is primary. The default value is False. -
RelationshipId: integer
(int64)
Value that uniquely identifies the linked supplier item relationship.
-
RelationshipStatus: string
Read Only:
true
Maximum Length:255
Status of the linked supplier item relationship. -
SupplierId: integer
Value that uniquely identifies the linked supplier.
-
SupplierName: string
Maximum Length:
255
Name of the linked supplier. -
SupplierPartId: integer
Value that uniquely identifies the supplier trading partner item.
-
SupplierPartNumber: string
Maximum Length:
255
Number that identifies a supplier part number. -
SupplierRegistryId: string
Maximum Length:
255
Value that uniquely identifies the supplier party. -
TPILinkageId: integer
(int64)
Value that uniquely identifies the supplier item relationship linkage.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : tradingPartnerItemRelationships-translatableAttributes-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who first provided value for the item relationship translatable attribute. -
CreationDateTime: string
(date-time)
Read Only:
true
Date and time when the user first provided value for the item relationship translatable attribute. -
ItemRelationshipId: integer
Value that uniquely identifies the item relationship.
-
Language: string
Maximum Length:
4
Value that identifies the language used for the item relationship translatable attribute. -
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the item relationship translatable attribute. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the item relationship translatable attribute. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the item relationship translatable attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RelationshipDescription: string
Maximum Length:
240
Description of the item relationship. -
SourceLanguage: string
Maximum Length:
4
Source language of the translation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- CompetitorItemRelationshipTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DEGP_COMPETITOR_ITEM_XREF
The following properties are defined on the LOV link relation:- Source Attribute: CompetitorItemRelationshipType; Target Attribute: Meaning
- Display Attribute: Meaning, LookupCode
- finder:
- DFF
-
Operation: /fscmRestApi/resources/11.13.18.05/tradingPartnerItemRelationships/{ItemRelationshipId}/child/DFFParameters:
- ItemRelationshipId:
$request.path.ItemRelationshipId
- ItemRelationshipId:
- LinkedMPNRelationships
-
Parameters:
- ItemRelationshipId:
$request.path.ItemRelationshipId
The Linked MPN Relationships resource manages the manufacturer part number relationships that are linked to supplier item relationships for an internal item. - ItemRelationshipId:
- LinkedSupplierItemRelationships
-
Parameters:
- ItemRelationshipId:
$request.path.ItemRelationshipId
The Linked Supplier Item Relationships resource manages the supplier item relationships that are linked to manufacturer part number relationships for an internal item. - ItemRelationshipId:
- RelationshipStatusLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_ACA_AML_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: RelationshipStatus; Target Attribute: Meaning
- Display Attribute: Meaning, LookupCode
- finder:
- TradingPartnerTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DEGP_TP_TYPES
The following properties are defined on the LOV link relation:- Source Attribute: TradingPartnerType; Target Attribute: Meaning
- Display Attribute: Meaning
- finder:
- translatableAttributes
-
Parameters:
- ItemRelationshipId:
$request.path.ItemRelationshipId
The Translatable Attributes resource manages the translatable attributes for item relationships. - ItemRelationshipId: