Create relationships

post

/fscmRestApi/resources/11.13.18.05/assetLogicalHierarchyRelationships

Request

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.
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Maximum Length: 30
    Abbreviation that identifies the hierarchy instance. You can use either HierarchyId or HierarchyCode during the POST action.
  • Value that uniquely identifies the hierarchy instance.
  • Maximum Length: 80
    Number that identifies a parent asset instance. If the parent type is asset, you can either ObjectId or ObjectAssetNumber during the POST action.
  • Maximum Length: 30
    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.
  • Value that uniquely identifies a parent object instance. For instance, it can be hierarchy identifier or asset identifier.
  • Maximum Length: 3
    Default Value: A
    Type of the parent object. Valid values are H for Hierarchy, A for Asset, and N for Node.
  • Maximum Length: 30
    Default Value: ORA_HIERARCHY
    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.
  • Maximum Length: 80
    Number that identifies a child object. If the child object type is asset, you can use either SubjectId or SubjectAssetNumber during the POST action.
  • Maximum Length: 30
    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.
  • Value that uniquely identifies a child object instance. When SubjectType is Asset, this value is a valid asset identifier.
  • Maximum Length: 3
    Default Value: A
    Type of a child object. Valid values are H for Hierarchy, A for Asset, and N for Node.
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-item-response
Type: object
Show Source
Back to Top

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

Example 1 Request Body

The following example includes the contents of the request body in JSON format to create one logical hierarchy relationship under the hierarchy name using a subject asset identifier. 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.

{
	"HierarchyId": 123456789101112,
	"ObjectType": "H",
	"ObjectId": 123456789101112,
	"SubjectType": "A",
	"SubjectId": 987654321
}

Example 1 Response Body

The following example includes the contents of the response body in JSON format:

{
	"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
}

Example 2 Request Body

The following example includes the contents of the request body in JSON format to create one logical hierarchy relationship under the hierarchy name using a subject asset number. 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.

{
	"HierarchyCode": "Hierarchy_Code",
	"ObjectType": "H",
	"ObjectHierarchyCode": "Hierarchy_Code",
	"SubjectType": "A",
	"SubjectAssetNumber": "Child_Asset_Number"
}

Example 2 Response Body

The following example includes the contents of the response body in JSON format:

{
	"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
}

Example 3 Request Body

The following example includes the contents of the request body in JSON format to create one logical hierarchy relationship for an asset underneath another asset using object and subject identifiers. 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.

{
	"HierarchyId": 123456789101112,
	"ObjectType": "A",
	"ObjectId": 987654321,
	"SubjectType": "A",
	"SubjectId": 5678457879
}

Example 3 Response Body

The following example includes the contents of the response body in JSON format:

{
	"RelationshipId": 300100545634270,
	"RelationshipTypeCode": "ORA_HIERARCHY",
	"HierarchyId": 123456789101112,
	"RootHierarchyId": 123456789101112,
	"HierarchyCode": "Hierarchy_Code",
	"HierarchyName": "Hierarchy_Name",
	"HierarchyDescription": "Hierarchy_Description",
	"ObjectType": "A",
	"ObjectTypeMeaning": "Asset",
	"ObjectId": 987654321,
	"ObjectHierarchyCode": null,
	"ObjectHierarchyName": null,
	"ObjectHierarchyDescription": null,
	"ObjectAssetNumber": "Parent_Asset_Number",
	"ObjectAssetDescription": "Parent_Asset_Description",
	"ObjectAssetOperationOrganization": "MNTALM",
	"SubjectType": "A",
	"SubjectTypeMeaning": "Asset",
	"SubjectId": 300100545630754,
	"SubjectHierarchyCode": null,
	"SubjectHierarchyName": null,
	"SubjectHierarchyDescription": null,
	"SubjectAssetNumber": "Child_Asset_Number",
	"SubjectAssetDescription": "Child_Asset_Description",
	"SubjectAssetOperationOrganization": "MNTALM",
	"PositionNumber": 1
}

Example 4 Request Body

The following example includes the contents of the request body in JSON format to create one logical hierarchy relationship for an asset underneath another asset using object and subject asset numbers. 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.

{
	"HierarchyCode": "Hierarchy_Code",
	"ObjectType": "A",
	"ObjectAssetNumber": "Parent_Asset_Number"
	"SubjectType": "A",
	"SubjectAssetNumber": "Child_Asset_Number"
}

Example 4 Response Body

The following example includes the contents of the response body in JSON format:

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