Update one relationship
patch
/fscmRestApi/resources/11.13.18.05/assetLogicalHierarchyRelationships/{RelationshipId}
Request
Path Parameters
-
RelationshipId(required): integer(int64)
Value that uniquely identifies the relationship between the parent node and a child node. A node can be a hierarchy, asset, and so on.
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.
Supported Media Types
- application/json
Response
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 : assetLogicalHierarchyRelationships-item-response
Type:
Show Source
object
-
HierarchyCode: string
Maximum Length:
30
Abbreviation that identifies the hierarchy instance. You can use either HierarchyId or HierarchyCode during the POST action. -
HierarchyDescription: string
Read Only:
true
Maximum Length:240
Description of the hierarchy instance. -
HierarchyId: integer
(int64)
Value that uniquely identifies the hierarchy instance.
-
HierarchyName: string
Read Only:
true
Maximum Length:120
Name of the hierarchy instance. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectAssetDescription: string
Read Only:
true
Maximum Length:240
Description of the parent asset instance. -
ObjectAssetNumber: string
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. -
ObjectAssetOperationOrganization: string
Read Only:
true
Maximum Length:18
Value of the organization code inside which a parent asset is operated. -
ObjectHierarchyCode: string
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. -
ObjectHierarchyDescription: string
Read Only:
true
Maximum Length:240
Description of the parent hierarchy instance. -
ObjectHierarchyName: string
Read Only:
true
Maximum Length:120
Name of the parent hierarchy instance. -
ObjectId: integer
(int64)
Value that uniquely identifies a parent object instance. For instance, it can be hierarchy identifier or asset identifier.
-
ObjectType: string
Maximum Length:
3
Default Value:A
Type of the parent object. Valid values are H for Hierarchy, A for Asset, and N for Node. -
ObjectTypeMeaning: string
Read Only:
true
Maximum Length:80
Meaning of the parent object type. -
PositionNumber: number
Read Only:
true
Number that specifies the order of a child node under its parent. -
RelationshipId: integer
(int64)
Read Only:
true
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
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. -
RootHierarchyId: integer
(int64)
Read Only:
true
Value that uniquely identifies the root hierarchy instance. -
SubjectAssetDescription: string
Read Only:
true
Maximum Length:240
Description of the child asset instance. -
SubjectAssetNumber: string
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. -
SubjectAssetOperationOrganization: string
Read Only:
true
Maximum Length:18
Value of the organization code inside which a child asset is operated. -
SubjectHierarchyCode: string
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. -
SubjectHierarchyDescription: string
Read Only:
true
Maximum Length:240
Description of the child hierarchy instance. -
SubjectHierarchyName: string
Read Only:
true
Maximum Length:120
Name of the child hierarchy instance. -
SubjectId: integer
(int64)
Value that uniquely identifies a child object instance. When SubjectType is Asset, this value is a valid asset identifier.
-
SubjectType: string
Maximum Length:
3
Default Value:A
Type of a child object. Valid values are H for Hierarchy, A for Asset, and N for Node. -
SubjectTypeMeaning: string
Read Only:
true
Maximum Length:80
Meaning of the child object type.
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.