Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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

• 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.

{
    "type":"object",
    "properties":{
        "SubjectTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the child object type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HierarchyCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the hierarchy instance. You can use either HierarchyId or HierarchyCode during the POST action.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectAssetNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies a parent asset instance. If the parent type is asset, you can either ObjectId or ObjectAssetNumber during the POST action.",
            "nullable":true,
            "x-queryable":true
        },
        "SubjectHierarchyDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the child hierarchy instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubjectAssetOperationOrganization":{
            "maxLength":18,
            "type":"string",
            "description":"Value of the organization code inside which a child asset is operated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HierarchyDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the hierarchy instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectHierarchyName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the parent hierarchy instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectType":{
            "maxLength":3,
            "type":"string",
            "description":"Type of the parent object. Valid values are H for Hierarchy, A for Asset, and N for Node.",
            "nullable":true,
            "default":"A",
            "x-queryable":true
        },
        "SubjectAssetNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies a child object. If the child object type is asset, you can use either SubjectId or SubjectAssetNumber during the POST action.",
            "nullable":true,
            "x-queryable":true
        },
        "SubjectType":{
            "maxLength":3,
            "type":"string",
            "description":"Type of a child object. Valid values are H for Hierarchy, A for Asset, and N for Node.",
            "nullable":true,
            "default":"A",
            "x-queryable":true
        },
        "ObjectAssetDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the parent asset instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubjectHierarchyCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies a child object instance. When SubjectType is Asset, this value is a valid asset identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubjectHierarchyName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the child hierarchy instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies a parent object instance. For instance, it can be hierarchy identifier or asset identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HierarchyName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the hierarchy instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectAssetOperationOrganization":{
            "maxLength":18,
            "type":"string",
            "description":"Value of the organization code inside which a parent asset is operated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PositionNumber":{
            "type":"number",
            "description":"Number that specifies the order of a child node under its parent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RootHierarchyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the root hierarchy instance.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectHierarchyCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "HierarchyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the hierarchy instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelationshipTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"ORA_HIERARCHY",
            "x-queryable":true
        },
        "ObjectHierarchyDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the parent hierarchy instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubjectAssetDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the child asset instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the relationship between the parent node and a child node. A node can be a hierarchy, asset, and so on.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ObjectTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the parent object type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top