Update a relationship
patch
/fscmRestApi/resources/11.13.18.05/crossReferenceRelationships/{crossReferenceRelationshipsUniqID}
Request
Path Parameters
-
crossReferenceRelationshipsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- ItemRelationshipId, InventoryItemId and ApplicableOrganizationId ---for the Cross-Reference Relationships resource and used to uniquely identify an instance of Cross-Reference Relationships. The client should not generate the hash key value. Instead, the client should query on the Cross-Reference Relationships collection resource with a filter on the primary key values in order to navigate to a specific instance of Cross-Reference Relationships.
For example: crossReferenceRelationships?q=ItemRelationshipId=<value1>;InventoryItemId=<value2>;ApplicableOrganizationId=<value3>
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
-
ApplicableOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the organization. -
ApplicableOrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
ApplyToAllOrganizationFlag: boolean
Title:
Organization Independent
Maximum Length:1
Default Value:true
Contains one of the following values: true or false. If true, then the cross-reference is applicable to all the organizations. If false, then it's not. The default value is true. -
CrossReference: string
Title:
Value
Maximum Length:255
Value that identifies the cross-reference. -
CrossReferenceType: string
Maximum Length:
80
Type of the cross-reference. A list of accepted values is defined in the lookup type EGP_ITEM_XREF_TYPES. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. There is no default value. -
DFF: array
DFF
-
InventoryItemId: integer
Value that uniquely identifies an item.
-
Item: string
Maximum Length:
300
Name or number of the part, item, product, or service. -
MasterOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the master organization of the item for which the cross-reference relationship is defined. -
MasterOrganizationId: integer
Value that uniquely identifies the master organization of the item for which the cross-reference relationship is defined.
-
RelationshipDescription: string
Title:
Description
Maximum Length:240
Description of the cross-reference relationship. -
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 : crossReferenceRelationships-translatableAttributes-item-patch-request
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(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 : crossReferenceRelationships-item-response
Type:
Show Source
object
-
ApplicableOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the organization. -
ApplicableOrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
ApplyToAllOrganizationFlag: boolean
Title:
Organization Independent
Maximum Length:1
Default Value:true
Contains one of the following values: true or false. If true, then the cross-reference is applicable to all the organizations. If false, then it's not. The default value is true. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the cross-reference relationship. -
CreationDateTime: string
(date-time)
Read Only:
true
Date and time when the user created the cross-reference relationship. -
CrossReference: string
Title:
Value
Maximum Length:255
Value that identifies the cross-reference. -
CrossReferenceType: string
Maximum Length:
80
Type of the cross-reference. A list of accepted values is defined in the lookup type EGP_ITEM_XREF_TYPES. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. There is no default value. -
DFF: array
DFF
-
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 cross-reference relationship.
-
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date when the user most recently updated the cross-reference relationship. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the cross-reference relationship. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the cross-reference relationship. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MasterOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the master organization of the item for which the cross-reference relationship is defined. -
MasterOrganizationId: integer
Value that uniquely identifies the master organization of the item for which the cross-reference relationship is defined.
-
RelationshipDescription: string
Title:
Description
Maximum Length:240
Description of the cross-reference relationship. -
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 : crossReferenceRelationships-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 : crossReferenceRelationships-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
- CrossReferenceTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DEGP_ITEM_XREF_TYPES
The following properties are defined on the LOV link relation:- Source Attribute: CrossReferenceType; Target Attribute: Meaning
- Display Attribute: Meaning, LookupCode
- finder:
- DFF
-
Parameters:
- crossReferenceRelationshipsUniqID:
$request.path.crossReferenceRelationshipsUniqID
- crossReferenceRelationshipsUniqID:
- translatableAttributes
-
Parameters:
- crossReferenceRelationshipsUniqID:
$request.path.crossReferenceRelationshipsUniqID
The Translatable Attributes resource manages the translatable attributes for item relationships. - crossReferenceRelationshipsUniqID: