Update a relationship
patch
/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=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
CompetitorItemRelationshipType: string
Maximum Length:
255Type of competitor for the item relationship. -
CustomerItemRelationshipRank: integer
Title:
RankRank used within the customer item relationship. -
DFF: array
DFF
-
EndDateTime: string
(date-time)
Title:
End DateDate when the trading partner item relationship becomes ineffective. -
LinkedMPNRelationships: array
Linked MPN Relationships
Title:
Linked MPN RelationshipsThe 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 RelationshipsThe Linked Supplier Item Relationships resource manages the supplier item relationships that are linked to manufacturer part number relationships for an internal item. -
RelationshipDescription: string
Title:
Relationship DescriptionMaximum Length:240Description of the trading partner item relationship. -
RelationshipStatus: string
Maximum Length:
255Status of the trading partner item relationship. -
StartDateTime: string
(date-time)
Title:
Start DateDate when the trading partner item relationship becomes effective. -
translatableAttributes: array
Translatable Attributes
Title:
Translatable AttributesThe Translatable Attributes resource manages the translatable attributes for item relationships.
Nested Schema : Linked MPN Relationships
Type:
arrayTitle:
Linked MPN RelationshipsThe 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:
arrayTitle:
Linked Supplier Item RelationshipsThe 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 : Translatable Attributes
Type:
arrayTitle:
Translatable AttributesThe Translatable Attributes resource manages the translatable attributes for item relationships.
Show Source
Nested Schema : tradingPartnerItemRelationships-DFF-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
ContextMaximum Length:150Context -
__FLEX_Context_DisplayValue: string
Title:
ContextContext
Nested Schema : tradingPartnerItemRelationships-LinkedMPNRelationships-item-patch-request
Type:
Show Source
object-
PrimaryLinkageFlag: boolean
Maximum Length:
1Default Value:falseValue that identifies whether the linked MPN relationship is primary. The default value is False.
Nested Schema : tradingPartnerItemRelationships-LinkedSupplierItemRelationships-item-patch-request
Type:
Show Source
object-
PrimaryLinkageFlag: boolean
Maximum Length:
1Default Value:falseValue that identifies whether the linked supplier item relationship is primary. The default value is False.
Nested Schema : tradingPartnerItemRelationships-translatableAttributes-item-patch-request
Type:
Show Source
object-
ItemRelationshipId: integer
Value that uniquely identifies the item relationship.
-
Language: string
Maximum Length:
4Value that identifies the language used for the item relationship translatable attribute. -
RelationshipDescription: string
Maximum Length:
240Description of the item relationship. -
SourceLanguage: string
Maximum Length:
4Source language of the translation.
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.
Root Schema : tradingPartnerItemRelationships-item-response
Type:
Show Source
object-
AcdType: string
Read Only:
trueMaximum Length:30Default Value:PRODValue that identifies whether the relationship row is an added, updated, deleted, or production row. -
CompetitorItemRelationshipType: string
Maximum Length:
255Type of competitor for the item relationship. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the trading partner item relationship. -
CreationDateTime: string
(date-time)
Read Only:
trueDate and time when the user created the trading partner item relationship. -
CustomerItemRelationshipRank: integer
Title:
RankRank used within the customer item relationship. -
DFF: array
DFF
-
EndDateTime: string
(date-time)
Title:
End DateDate when the trading partner item relationship becomes ineffective. -
InventoryItemId: integer
Value that uniquely identifies an item.
-
Item: string
Maximum Length:
255Name 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:
trueDate when the user most recently updated the trading partner item relationship. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the trading partner item relationship. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Login that the user used when updating the trading partner item relationship. -
LinkedMPNRelationships: array
Linked MPN Relationships
Title:
Linked MPN RelationshipsThe 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 RelationshipsThe 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:
LinksThe link relations associated with the resource instance. -
OrganizationCode: string
Maximum Length:
255Abbreviation that identifies the organization. -
OrganizationId: integer
Value that uniquely identifies the organization.
-
RegistryId: string
Maximum Length:
255Value that uniquely identifies the party. -
RelationshipDescription: string
Title:
Relationship DescriptionMaximum Length:240Description of the trading partner item relationship. -
RelationshipStatus: string
Maximum Length:
255Status of the trading partner item relationship. -
StartDateTime: string
(date-time)
Title:
Start DateDate when the trading partner item relationship becomes effective. -
TradingPartnerId: string
Maximum Length:
255Value that uniquely identifies the trading partner. -
TradingPartnerItemDescription: string
Title:
Trading Partner Item DescriptionRead Only:trueMaximum Length:240Describes the trading partner item. -
TradingPartnerItemId: integer
(int64)
Value that uniquely identifies the trading partner item.
-
TradingPartnerItemNumber: string
Maximum Length:
255Number that identifies a trading partner item, such as supplier item, customer item, competitor item, and manufacturer part number. -
TradingPartnerItemStatus: string
Read Only:
trueMaximum Length:255Status of the trading partner item. -
TradingPartnerName: string
Maximum Length:
255Name of the trading partner. -
TradingPartnerStatus: string
Read Only:
trueMaximum Length:255Status of the trading partner. -
TradingPartnerType: string
Maximum Length:
255Type of the trading partner. -
translatableAttributes: array
Translatable Attributes
Title:
Translatable AttributesThe Translatable Attributes resource manages the translatable attributes for item relationships.
Nested Schema : Linked MPN Relationships
Type:
arrayTitle:
Linked MPN RelationshipsThe 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:
arrayTitle:
Linked Supplier Item RelationshipsThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Translatable Attributes
Type:
arrayTitle:
Translatable AttributesThe 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:
ContextMaximum Length:150Context -
__FLEX_Context_DisplayValue: string
Title:
ContextContext -
ItemRelationshipId: integer
(int64)
-
ItemRelationshipType: string
Title:
TypeMaximum Length:30 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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:
trueMaximum Length:64User who created the linked MPN relationship. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the linked MPN relationship. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the linked MPN relationship. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the linked MPN relationship. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Login that the user used when updating the linked MPN relationship. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManufacturerId: integer
Value that uniquely identifies the linked manufacturer.
-
ManufacturerName: string
Maximum Length:
255Name of the linked manufacturer. -
ManufacturerPartId: integer
Value that uniquely identifies the manufacturer trading partner item.
-
ManufacturerPartNumber: string
Maximum Length:
255Number that identifies a manufacturer part number. -
ManufacturerRegistryId: string
Maximum Length:
255Value that uniquely identifies the manufacturer party. -
PrimaryLinkageFlag: boolean
Maximum Length:
1Default Value:falseValue 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:
trueMaximum Length:255Status of the linked MPN relationship. -
TPILinkageId: integer
(int64)
Value that uniquely identify MPN relationship linkage.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : tradingPartnerItemRelationships-LinkedSupplierItemRelationships-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the linked supplier item relationship. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the linked supplier item relationship. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the linked supplier item relationship. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the linked supplier item relationship. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Login associated with the user who most recently updated the linked supplier item relationship. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PrimaryLinkageFlag: boolean
Maximum Length:
1Default Value:falseValue 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:
trueMaximum Length:255Status of the linked supplier item relationship. -
SupplierId: integer
Value that uniquely identifies the linked supplier.
-
SupplierName: string
Maximum Length:
255Name of the linked supplier. -
SupplierPartId: integer
Value that uniquely identifies the supplier trading partner item.
-
SupplierPartNumber: string
Maximum Length:
255Number that identifies a supplier part number. -
SupplierRegistryId: string
Maximum Length:
255Value that uniquely identifies the supplier party. -
TPILinkageId: integer
(int64)
Value that uniquely identifies the supplier item relationship linkage.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : tradingPartnerItemRelationships-translatableAttributes-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who first provided value for the item relationship translatable attribute. -
CreationDateTime: string
(date-time)
Read Only:
trueDate 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:
4Value that identifies the language used for the item relationship translatable attribute. -
LastUpdateDateTime: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the item relationship translatable attribute. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the item relationship translatable attribute. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Login that the user used when updating the item relationship translatable attribute. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
RelationshipDescription: string
Maximum Length:
240Description of the item relationship. -
SourceLanguage: string
Maximum Length:
4Source language of the translation.
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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:
Examples
This example describes how to update a relationship.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/tradingPartnerItemRelationships/ItemRelationshipId"
For example:
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/tradingPartnerItemRelationships/300100185357962"
Example Request Body
The following example includes the contents of the request body in JSON format to update a trading partner item relationship. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{
"EndDateTime": "2025-07-11T10:00:35+00:00"
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"ItemRelationshipId": 300100197102117,
"OrganizationId": 204,
"OrganizationCode": "V1",
"InventoryItemId": 149,
"Item": "AS54888",
"TradingPartnerType": "Manufacturer",
"TradingPartnerId": "300100182181356",
"TradingPartnerName": "Mfr_PLM_57225_02",
"RegistryId": "CDRM_877762",
"TradingPartnerItemId": 300100182218392,
"TradingPartnerItemNumber": "MPN_PLM_57225_B_15",
"RelationshipDescription": null,
"StartDateTime": "2020-07-11T10:00:35+00:00",
"EndDateTime": "2025-07-11T10:00:35+00:00",
"CustomerItemRelationshipRank": null,
"CompetitorItemRelationshipType": null,
"RelationshipStatus": null,
"CreationDateTime": "2020-07-10T10:00:35.118+00:00",
"LastUpdateDateTime": "2020-07-10T10:09:34+00:00",
"CreatedBy": "user",
"LastUpdateLogin": "A9F34275918F13B3E0537AA8F00AE37D",
"LastUpdatedBy": "user",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/tradingPartnerItemRelationships/300100197102117",
"name": "tradingPartnerItemRelationships",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/tradingPartnerItemRelationships/300100197102117",
"name": "tradingPartnerItemRelationships",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/tradingPartnerItemRelationships/300100197102117/child/DFF",
"name": "DFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/tradingPartnerItemRelationships/300100197102117/child/translatableAttributes",
"name": "translatableAttributes",
"kind": "collection"
}
]
}