Create relationships
/fscmRestApi/resources/11.13.18.05/GTINRelationships
Request
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
- application/json
object
-
DFF: array
DFF
-
EPCGTINSerial: number
Title:
EPC or GTIN Serial
Value that identifies the electronic product code or the GTIN serial number. -
GTIN: string
Title:
GTIN
Maximum Length:255
Number that identifies the global trade item. -
InventoryItemId(required): 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 GTIN relationship.
-
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the organization. -
OrganizationId: integer
Value that uniquely identifies the organization.
-
PartyName: string
Title:
Name
Maximum Length:360
Name of the party. -
PartyType: string
Maximum Length:
255
Type of the party. -
RegistryId: string
Title:
Registry ID
Maximum Length:30
Value that uniquely identifies the party. -
RelationshipDescription: string
Title:
GTIN Description
Maximum Length:240
Description of the GTIN relationship. -
RevisionCode: string
Title:
Revision Code
Maximum Length:18
Abbreviation that identifies the revision of the item. -
translatableAttributes: array
Translatable Attributes
Title:
Translatable Attributes
The Translatable Attributes resource manages the translatable attributes for item relationships. -
UOM: string
Title:
UOM Name
Maximum Length:25
Unit of measure for the GTIN relationship.
array
Translatable Attributes
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
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
- application/json
Default Response
-
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.
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the GTIN relationship. -
CreationDateTime: string
(date-time)
Read Only:
true
Date and time when the user created the GTIN relationship. -
DFF: array
DFF
-
EPCGTINSerial: number
Title:
EPC or GTIN Serial
Value that identifies the electronic product code or the GTIN serial number. -
GTIN: string
Title:
GTIN
Maximum Length:255
Number that identifies the global trade item. -
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 GTIN relationship.
-
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date when the user most recently updated the GTIN relationship. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the GTIN relationship. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the GTIN 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.
-
PartyName: string
Title:
Name
Maximum Length:360
Name of the party. -
PartyType: string
Maximum Length:
255
Type of the party. -
RegistryId: string
Title:
Registry ID
Maximum Length:30
Value that uniquely identifies the party. -
RelationshipDescription: string
Title:
GTIN Description
Maximum Length:240
Description of the GTIN relationship. -
RevisionCode: string
Title:
Revision Code
Maximum Length:18
Abbreviation that identifies the revision of the item. -
translatableAttributes: array
Translatable Attributes
Title:
Translatable Attributes
The Translatable Attributes resource manages the translatable attributes for item relationships. -
UOM: string
Title:
UOM Name
Maximum Length:25
Unit of measure for the GTIN relationship.
array
Links
array
Translatable Attributes
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.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
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.
array
Links
- DFF
-
Parameters:
- ItemRelationshipId:
$request.path.ItemRelationshipId
- ItemRelationshipId:
- PartyTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DEGP_GTIN_PARTY_TYPES
The following properties are defined on the LOV link relation:- Source Attribute: PartyType; 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 create relationships.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/transitTimes"
Example 1 Request Body
The following example includes the contents of the request body in JSON format to create a 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 creates.
{ "OrganizationCode" : "V1", "Item" : "M2584", "UOM" : "Bag", "GTIN" : "67867867847781", "RelationshipDescription" : "Trade GTIN", "RevisionCode" : "A", "translatableAttributes" : [ { "RelationshipDescription" : "US June 17 Desc1", "Language" : "US", "SourceLanguage" : "US" }, { "RelationshipDescription" : "설명 17", "Language" : "KO", "SourceLanguage" : "KO" } ] }
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "ItemRelationshipId": 300100197102285, "OrganizationId": 204, "OrganizationCode": "V1", "InventoryItemId": 300100185399391, "Item": "M2584", "RevisionCode": "A", "PartyType": null, "PartyName": null, "RegistryId": null, "GTIN": "67867867847781", "UOM": "Bag", "RelationshipDescription": "Trade GTIN", "EpcGtinSerial": null, "CreationDateTime": "2020-07-10T10:25:23.001+00:00", "LastUpdateDateTime": "2020-07-10T10:25:23.391+00:00", "CreatedBy": user", "LastUpdateLogin": "A9EBC37ADBFE1382E0537AA8F00A4821", "LastUpdatedBy": user, "translatableAttributes": [ { "ItemRelationshipId": 300100197102285, "RelationshipDescription": "US June 17 Desc1", "Language": "US", "SourceLanguage": "US", "CreationDateTime": "2020-07-10T10:25:23.157+00:00", "LastUpdateDateTime": "2020-07-10T10:25:23.391+00:00", "CreatedBy": "PIMQA", "LastUpdateLogin": "A9EBC37ADBFE1382E0537AA8F00A4821", "LastUpdatedBy": "PIMQA", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102285/child/translatableAttributes/00020000000EACED00057708000110F085A532CD000000025553", "name": "translatableAttributes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102285/child/translatableAttributes/00020000000EACED00057708000110F085A532CD000000025553", "name": "translatableAttributes", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102285", "name": "GTINRelationships", "kind": "item" } ] }, { "ItemRelationshipId": 300100197102285, "RelationshipDescription": "설명 17", "Language": "KO", "SourceLanguage": "KO", "CreationDateTime": "2020-07-10T10:25:23.164+00:00", "LastUpdateDateTime": "2020-07-10T10:25:23.392+00:00", "CreatedBy": user, "LastUpdateLogin": "A9EBC37ADBFE1382E0537AA8F00A4821", "LastUpdatedBy": user, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102285/child/translatableAttributes/00020000000EACED00057708000110F085A532CD000000024B4F", "name": "translatableAttributes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102285/child/translatableAttributes/00020000000EACED00057708000110F085A532CD000000024B4F", "name": "translatableAttributes", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102285", "name": "GTINRelationships", "kind": "item" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102285", "name": "GTINRelationships", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102285", "name": "GTINRelationships", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102285/child/DFF", "name": "DFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102285/child/translatableAttributes", "name": "translatableAttributes", "kind": "collection" } ] }
Example 2 Request Body
The following example includes the contents of the request body in JSON format to create a GTIN relationship by adding an existing GTIN and specifying values for descriptive flexfield attributes. 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 creates.
{ "OrganizationCode" : "V1", "Item" : "DemoItemJul10_2", "UOM" : "Bag", "GTIN" : "67867867847781", "RelationshipDescription" : "Trade GTIN", "RevisionCode" : "A", "DFF" : [ { "char1" : "postDFF1", "char2" : "Bangalore" } ] }
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{ "ItemRelationshipId": 300100197102287, "OrganizationId": 204, "OrganizationCode": "V1", "InventoryItemId": 300100185399396, "Item": "DemoItemJul10_2", "RevisionCode": "A", "PartyType": null, "PartyName": null, "RegistryId": null, "GTIN": "67867867847781", "UOM": "Bag", "RelationshipDescription": "Trade GTIN", "EpcGtinSerial": null, "CreationDateTime": "2020-07-10T10:29:22.024+00:00", "LastUpdateDateTime": "2020-07-10T10:29:22.508+00:00", "CreatedBy": "user", "LastUpdateLogin": "A9EBC37ADBFE1382E0537AA8F00A4821", "LastUpdatedBy": "user", "DFF": [ { "ItemRelationshipId": 300100197102287, "ItemRelationshipType": "GTIN_XREF", "char1": "postDFF1", "numb1": null, "date1": null, "datetime1": null, "char2": "Bangalore", "RELGlobSegChar1": null, "zbiaitemreldff": null, "__FLEX_Context": null, "__FLEX_Context_DisplayValue": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102287/child/DFF/300100197102287", "name": "DFF", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102287/child/DFF/300100197102287", "name": "DFF", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102287", "name": "GTINRelationships", "kind": "item" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102287", "name": "GTINRelationships", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102287", "name": "GTINRelationships", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102287/child/DFF", "name": "DFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102287/child/translatableAttributes", "name": "translatableAttributes", "kind": "collection" } ] }