Get all relationships
get
/fscmRestApi/resources/11.13.18.05/GTINRelationships
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Find GTIN relationships according to the primary key criteria.
Finder Variables- ItemRelationshipId; integer; Value that uniquely identifies the GTIN relationship.
- PrimaryKey Find GTIN relationships according to the primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CreatedBy; string; User who created the GTIN relationship.
- CreationDateTime; string; Date and time when the user created the GTIN relationship.
- EPCGTINSerial; number; Value that identifies the electronic product code or the GTIN serial number.
- GTIN; string; Number that identifies the global trade item.
- InventoryItemId; integer; Value that uniquely identifies an item.
- Item; string; Name or number of the part, item, product, or service.
- ItemRelationshipId; integer; Value that uniquely identifies the GTIN relationship.
- LastUpdateDateTime; string; Date when the user most recently updated the GTIN relationship.
- LastUpdateLogin; string; Login that the user used when updating the GTIN relationship.
- LastUpdatedBy; string; User who most recently updated the GTIN relationship.
- OrganizationCode; string; Abbreviation that identifies the organization.
- OrganizationId; integer; Value that uniquely identifies the organization.
- PartyName; string; Name of the party.
- PartyType; string; Type of the party.
- RegistryId; string; Value that uniquely identifies the party.
- RelationshipDescription; string; Description of the GTIN relationship.
- RevisionCode; string; Abbreviation that identifies the revision of the item.
- UOM; string; Unit of measure for the GTIN relationship.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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:
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 : GTINRelationships
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : GTINRelationships-item-response
Type:
Show Source
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.
-
PackedItem: string
Read Only:
true
Maximum Length:255
Name or number of the part, item, product, or service that's packed with a GTIN. -
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.
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 : GTINRelationships-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 : GTINRelationships-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
Examples
This example describes how to get all relationships.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/GTINRelationships"
For example, the following command gets all relationships:
curl -u username:password "https://servername/fscmRestApi/resources/version/GTINRelationships?q=Item=M2584;UOM=Each"
Example Response Body
The following shows an example of the response body in JSON format.
{ "ItemRelationshipId": 300100197102286, "OrganizationId": 204, "OrganizationCode": "V1", "InventoryItemId": 300100185399396, "Item": "M2584", "RevisionCode": "A", "PartyType": "Manufacturer", "PartyName": "TCP Manufacturer", "RegistryId": "100000017351024", "GTIN": "67867767847782", "UOM": "Each", "RelationshipDescription": "Trade GTIN", "EpcGtinSerial": null, "CreationDateTime": "2020-07-10T10:26:23.056+00:00", "LastUpdateDateTime": "2020-07-10T10:37:39+00:00", "CreatedBy": "user", "LastUpdateLogin": "A9EBC37ADBFE1382E0537AA8F00A4821", "LastUpdatedBy": "user", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102286", "name": "GTINRelationships", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102286", "name": "GTINRelationships", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102286/child/DFF", "name": "DFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/GTINRelationships/300100197102286/child/translatableAttributes", "name": "translatableAttributes", "kind": "collection" } ] }