1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Product Lifecycle Management
  4. Cross-Reference Relationships

Get all relationships

get

/fscmRestApi/resources/11.13.18.05/crossReferenceRelationships

Request

Query Parameters
  • 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).
  • 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
  • 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 cross-reference relationships according to the primary key criteria.
      Finder Variables
      • ApplicableOrganizationId; integer; Value that uniquely identifies the organization.
      • InventoryItemId; integer; Value that uniquely identifies the item.
      • ItemRelationshipId; integer; Value that uniquely identifies the cross-reference relationship.
    • findByOrganization Find cross-references according to the specified item and organization. This will include cross-references that are applicable to all the organizations and also cross-references applicable only to the specified organization.
      Finder Variables
      • ApplicableOrganizationCode; string; Abbreviation that identifies the organization for which cross-reference relationships are to be fetched.
      • Item; string; Value that uniquely identifies the cross-reference relationship.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • ApplicableOrganizationCode; string; Abbreviation that identifies the organization.
    • ApplicableOrganizationId; integer; Value that uniquely identifies the organization.
    • ApplyToAllOrganizationFlag; boolean; 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; User who created the cross-reference relationship.
    • CreationDateTime; string; Date and time when the user created the cross-reference relationship.
    • CrossReference; string; Value that identifies the cross-reference.
    • CrossReferenceType; string; 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.
    • 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 cross-reference relationship.
    • LastUpdateDateTime; string; Date when the user most recently updated the cross-reference relationship.
    • LastUpdateLogin; string; Login that the user used when updating the cross-reference relationship.
    • LastUpdatedBy; string; User who most recently updated the cross-reference relationship.
    • MasterOrganizationCode; string; 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; Description of the cross-reference relationship.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : crossReferenceRelationships
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : crossReferenceRelationships-item-response
Type: object
Show Source
Nested Schema : DFF
Type: array
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: object
Show Source
Nested Schema : crossReferenceRelationships-translatableAttributes-item-response
Type: object
Show Source
Back to Top

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/crossReferenceRelationships"

For example, the following command gets cross reference relationships:

curl -u username:password "https://servername/fscmRestApi/resources/version/crossReferenceRelationships?q=Item=xyz;ApplyToAllOrganizationFlag=true"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"items" : [ {
		"ItemRelationshipId" : 300100197102447,
		"MasterOrganizationId" : 204,
		"MasterOrganizationCode" : "V1",
		"InventoryItemId" : 300100185399391,
		"Item" : "xyz",
		"CrossReferenceType" : "Charge Master",
		"CrossReference" : "cm_xyz",
		"ApplyToAllOrganizationFlag" : true,
		"ApplicableOrganizationId" : null,
		"ApplicableOrganizationCode" : null,
		"RelationshipDescription" : "Test Item Xref",
		"CreationDateTime" : "2020-07-10T10:43:51.023+00:00",
		"LastUpdateDateTime" : "2020-07-10T10:43:51.301+00:00",
		"CreatedBy" : "user",
		"LastUpdateLogin" : "A9EBC4B5D3EA1384E0537AA8F00AF719",
		"LastUpdatedBy" : "user",
		"links" : [ {
			"rel" : "self",
			"https://servername/fscmRestApi/resources/version/crossReferenceRelationships/00030000000EACED00057708000110F085A5336F0000000EACED00057708000110F084F2A05FFFFFFFFF",
			"name" : "crossReferenceRelationships",
			"kind" : "item",
			"properties" : {
				"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		}, {
			"rel" : "canonical",
			"href" : "https://servername/fscmRestApi/resources/version/crossReferenceRelationships/00030000000EACED00057708000110F085A5336F0000000EACED00057708000110F084F2A05FFFFFFFFF",
			"name" : "crossReferenceRelationships",
			"kind" : "item"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/crossReferenceRelationships/00030000000EACED00057708000110F085A5336F0000000EACED00057708000110F084F2A05FFFFFFFFF/child/DFF",
			"name" : "DFF",
			"kind" : "collection"
		}, {
			"rel" : "child",
			"href" : "https://servername/fscmRestApi/resources/version/crossReferenceRelationships/00030000000EACED00057708000110F085A5336F0000000EACED00057708000110F084F2A05FFFFFFFFF/child/translatableAttributes",
			"name" : "translatableAttributes",
			"kind" : "collection"
		} ]
	} ],
	"count" : 1,
	"hasMore" : false,
	"limit" : 25,
	"offset" : 0,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/crossReferenceRelationships",
		"name" : "crossReferenceRelationships",
		"kind" : "collection"
	} ]
}
Back to Top