Update a relationship
patch
/fscmRestApi/resources/11.13.18.05/spokeSystemItemRelationships/{ItemRelationshipId}
Request
Path Parameters
-
ItemRelationshipId(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=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DFF: array
DFF
-
EndDateTime: string
(date-time)
Date when the spoke system item relationship becomes ineffective.
-
RelationshipDescription: string
Title:
Spoke System Item Description
Maximum Length:240
Description of the spoke system item relationship. -
StartDateTime: string
(date-time)
Date and time when the spoke system item relationship becomes effective.
-
translatableAttributes: array
Translatable Attributes
Title:
Translatable Attributes
The Translatable Attributes resource manages the translatable attributes for item relationships.
Nested Schema : Translatable Attributes
Type:
array
Title:
Translatable Attributes
The Translatable Attributes resource manages the translatable attributes for item relationships.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context
Nested Schema : schema
Type:
Show Source
object
-
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. -
RelationshipDescription: string
Maximum Length:
240
Description of the item relationship. -
SourceLanguage: string
Maximum Length:
4
Source 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 : spokeSystemItemRelationships-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the spoke system item relationship. -
CreationDateTime: string
(date-time)
Read Only:
true
Date and time when the user created the spoke system item relationship. -
DFF: array
DFF
-
EndDateTime: string
(date-time)
Date when the spoke system item relationship becomes ineffective.
-
InventoryItemId: integer
Value that uniquely identifies an item.
-
Item: string
Maximum Length:
300
Name or number of the part, item, product, or service. -
ItemRelationshipId: integer
(int64)
Value that uniquely identifies the spoke system item relationship.
-
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the spoke system item relationship. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the spoke system item relationship. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the spoke system item relationship. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the organization. -
OrganizationId: integer
Value that uniquely identifies the organization.
-
RelationshipDescription: string
Title:
Spoke System Item Description
Maximum Length:240
Description of the spoke system item relationship. -
SpokeSystemCode: string
Maximum Length:
255
Abbreviation that identifies the spoke system. -
SpokeSystemId: integer
Title:
Spoke System
Value that uniquely identifies the spoke system. -
SpokeSystemItem: string
Title:
Spoke System Item
Maximum Length:255
Name or number of the spoke system item. -
StartDateTime: string
(date-time)
Date and time when the spoke system item relationship becomes effective.
-
translatableAttributes: array
Translatable Attributes
Title:
Translatable Attributes
The Translatable Attributes resource manages the translatable attributes for item relationships.
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 : spokeSystemItemRelationships-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 : spokeSystemItemRelationships-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
- DFF
-
Operation: /fscmRestApi/resources/11.13.18.05/spokeSystemItemRelationships/{ItemRelationshipId}/child/DFFParameters:
- ItemRelationshipId:
$request.path.ItemRelationshipId
- ItemRelationshipId:
- 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/spokeSystemItemRelationships/ItemRelationshipId"
Example Request Body
The following example includes the contents of the request body in JSON format. 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.
{ "RelationshipDescription": "Legacy System X Item" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "ItemRelationshipId": 300100210898445, "OrganizationId": 204, "OrganizationCode": "V1", "InventoryItemId": 300100210373488, "Item": "M123456", "SpokeSystemId": 300100025156920, "SpokeSystemCode": "Legacy", "SpokeSystemItem": "123456", "RelationshipDescription": "Legacy System X Item", "StartDateTime": "2020-08-18T10:31:35.211+00:00", "EndDateTime": null, "CreationDateTime": "2020-08-18T10:31:35.001+00:00", "LastUpdateDateTime": "2020-08-18T10:31:53.205+00:00", "CreatedBy": "UserX", "LastUpdateLogin": "ACDCD8FC19D338AEE053CC5AF00AC325", "LastUpdatedBy": "UserX", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/spokeSystemItemRelationships/300100210898445", "name": "spokeSystemItemRelationships", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/spokeSystemItemRelationships/300100210898445", "name": "spokeSystemItemRelationships", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/spokeSystemItemRelationships/300100210898445/child/DFF", "name": "DFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/spokeSystemItemRelationships/300100210898445/child/translatableAttributes", "name": "translatableAttributes", "kind": "collection" } ] }