1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Maintenance
  4. Asset Logical Hierarchy Relationships

Get all relationships

get

/fscmRestApi/resources/11.13.18.05/assetLogicalHierarchyRelationships

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 logical relationships.
      Finder Variables:
      • RelationshipId; integer; Value that uniquely identifies the relationship between the parent node and a child node.
  • 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:
    • HierarchyCode; string; Abbreviation that identifies the hierarchy instance. You can use either HierarchyId or HierarchyCode during the POST action.
    • HierarchyDescription; string; Description of the hierarchy instance.
    • HierarchyId; integer; Value that uniquely identifies the hierarchy instance.
    • HierarchyName; string; Name of the hierarchy instance.
    • ObjectAssetDescription; string; Description of the parent asset instance.
    • ObjectAssetNumber; string; Number that identifies a parent asset instance. If the parent type is asset, you can either ObjectId or ObjectAssetNumber during the POST action.
    • ObjectAssetOperationOrganization; string; Value of the organization code inside which a parent asset is operated.
    • ObjectHierarchyCode; string; Abbreviation that identifies the parent hierarchy instance. If the parent object type is Hierarchy, you can use either ObjectId or ObjectHierarchyCode during the POST action.
    • ObjectHierarchyDescription; string; Description of the parent hierarchy instance.
    • ObjectHierarchyName; string; Name of the parent hierarchy instance.
    • ObjectId; integer; Value that uniquely identifies a parent object instance. For instance, it can be hierarchy identifier or asset identifier.
    • ObjectType; string; Type of the parent object. Valid values are H for Hierarchy, A for Asset, and N for Node.
    • ObjectTypeMeaning; string; Meaning of the parent object type.
    • PositionNumber; number; Number that specifies the order of a child node under its parent.
    • RelationshipId; integer; Value that uniquely identifies the relationship between the parent node and a child node. A node can be a hierarchy, asset, and so on.
    • RelationshipTypeCode; string; Abbreviation that identifies the type of relationship. This is a read-only value that specifies whether the relationship is a logical relationship or a physical relationship.
    • RootHierarchyId; integer; Value that uniquely identifies the root hierarchy instance.
    • SubjectAssetDescription; string; Description of the child asset instance.
    • SubjectAssetNumber; string; Number that identifies a child object. If the child object type is asset, you can use either SubjectId or SubjectAssetNumber during the POST action.
    • SubjectAssetOperationOrganization; string; Value of the organization code inside which a child asset is operated.
    • SubjectHierarchyCode; string; Abbreviation that identifies the child hierarchy instance. If the child object type is Hierarchy, you can use either SubjectId or SubjectHierarchyCode during the POST action.
    • SubjectHierarchyDescription; string; Description of the child hierarchy instance.
    • SubjectHierarchyName; string; Name of the child hierarchy instance.
    • SubjectId; integer; Value that uniquely identifies a child object instance. When SubjectType is Asset, this value is a valid asset identifier.
    • SubjectType; string; Type of a child object. Valid values are H for Hierarchy, A for Asset, and N for Node.
    • SubjectTypeMeaning; string; Meaning of the child object type.
  • 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 : assetLogicalHierarchyRelationships
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : assetLogicalHierarchyRelationships-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 to get all logical hierarchy relationships across hierarchy names:

curl -u username:password "https://servername/fscmRestApi/resources/version/assetLogicalHierarchyRelationships"

Example Response Body

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

{
	"items": [ {
		"RelationshipId": 300100545631004,
		"RelationshipTypeCode": "ORA_HIERARCHY",
		"HierarchyId": 123456789101112,
		"RootHierarchyId": 123456789101112,
		"HierarchyCode": "Hierarchy_Code",
		"HierarchyName": "Hierarchy_Name",
		"HierarchyDescription": "Hierarchy_Description",
		"ObjectType": "H",
		"ObjectTypeMeaning": "Hierarchy",
		"ObjectId": 123456789101112,
		"ObjectHierarchyCode": "Hierarchy_Code",
		"ObjectHierarchyName": "Hierarchy_Name",
		"ObjectHierarchyDescription": "Hierarchy_Description",
		"ObjectAssetNumber": null,
		"ObjectAssetDescription": null,
		"ObjectAssetOperationOrganization": null,
		"SubjectType": "A",
		"SubjectTypeMeaning": "Asset",
		"SubjectId": 987654321,
		"SubjectHierarchyCode": null,
		"SubjectHierarchyName": null,
		"SubjectHierarchyDescription": null,
		"SubjectAssetNumber": "Parent_Asset_Number",
		"SubjectAssetDescription": "Parent_Asset_Description",
		"SubjectAssetOperationOrganization": "MNTALM",
		"PositionNumber": 1
	},{
		...
	} ],
	...
}
Back to Top