Jump to

• Request
• Response
• Examples

Update one name

patch

/fscmRestApi/resources/11.13.18.05/assetLogicalHierarchies/{HierarchyId}

Request

Path Parameters

• HierarchyId(required): integer(int64)
  Value that uniquely identifies the hierarchy name. The application generates this value when it creates the hierarchy. This attribute is read-only.

Header Parameters

• Metadata-Context: string
  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: string
  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

• HierarchyCode: string
  Title: Code

  Maximum Length: 30

  Abbreviation that uniquely identifies the asset hierarchy name.
• HierarchyDescription: string
  Title: Description

  Maximum Length: 240

  Description of the hierarchy.
• HierarchyDisableFlag: boolean
  Contains one of the following values: true or false. If true, then the hierarchy name is disabled. If false, then the hierarchy name is enabled. The default value is false.
• HierarchyId: integer (int64)
  Value that uniquely identifies the hierarchy name. The application generates this value when it creates the hierarchy. This attribute is read-only.
• HierarchyName: string
  Title: Name

  Maximum Length: 120

  Name of the hierarchy.
• RouteAssetId: integer (int64)
  Value that identifies the route asset associated with the hierarchy.
• RouteAssetNumber: string
  Value that identifies the route asset number associated with the hierarchy.
• RouteCompletionCode: string
  Maximum Length: 30

  Code that uniquely identifies the route completion. Valid values are Automatic or Manual, as defined in the lookup ORA_MNT_MX_PROGRAM_WO_CREATE. If set to Automatic, route assets don't need to be marked as complete or skipped during work order reporting. If set to Manual, route assets must be marked as either complete or skipped during work order reporting.
• RouteFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then it indicates a route asset hierarchy. The default value is false.
• RouteSkipAllowedFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If set to true, then assets can optionally be marked as skipped during work order reporting. If set to false, then all assets must be marked as complete during work order reporting. The default value is false.

{
    "type":"object",
    "properties":{
        "HierarchyCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the asset hierarchy name.",
            "nullable":false
        },
        "HierarchyDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the hierarchy.",
            "nullable":true
        },
        "HierarchyDisableFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the hierarchy name is disabled. If false, then the hierarchy name is enabled. The default value is false.",
            "nullable":true
        },
        "HierarchyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the hierarchy name. The application generates this value when it creates the hierarchy. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "HierarchyName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"Name of the hierarchy.",
            "nullable":false
        },
        "RouteAssetId":{
            "type":"integer",
            "description":"Value that identifies the route asset associated with the hierarchy.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RouteAssetNumber":{
            "type":"string",
            "description":"Value that identifies the route asset number associated with the hierarchy.",
            "nullable":true
        },
        "RouteCompletionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that uniquely identifies the route completion. Valid values are Automatic or Manual, as defined in the lookup ORA_MNT_MX_PROGRAM_WO_CREATE. If set to Automatic, route assets don't need to be marked as complete or skipped during work order reporting. If set to Manual, route assets must be marked as either complete or skipped during work order reporting.",
            "nullable":true
        },
        "RouteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then it indicates a route asset hierarchy. The default value is false.",
            "nullable":true
        },
        "RouteSkipAllowedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If set to true, then assets can optionally be marked as skipped during work order reporting. If set to false, then all assets must be marked as complete during work order reporting. The default value is false.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : assetLogicalHierarchies-item-response

Type: object

Show Source

• ActiveEndDate: string (date)
  Title: Disabled

  Read Only: true

  Date and time when the hierarchy name becomes inactive.
• HierarchyCode: string
  Title: Code

  Maximum Length: 30

  Abbreviation that uniquely identifies the asset hierarchy name.
• HierarchyDescription: string
  Title: Description

  Maximum Length: 240

  Description of the hierarchy.
• HierarchyDisableFlag: boolean
  Contains one of the following values: true or false. If true, then the hierarchy name is disabled. If false, then the hierarchy name is enabled. The default value is false.
• HierarchyId: integer (int64)
  Value that uniquely identifies the hierarchy name. The application generates this value when it creates the hierarchy. This attribute is read-only.
• HierarchyName: string
  Title: Name

  Maximum Length: 120

  Name of the hierarchy.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RouteAssetDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the route asset number associated with the hierarchy.
• RouteAssetId: integer (int64)
  Value that identifies the route asset associated with the hierarchy.
• RouteAssetNumber: string
  Value that identifies the route asset number associated with the hierarchy.
• RouteAssetOperatingOrganization: string
  Read Only: true

  Maximum Length: 255

  The operating organization of the asset route within the logical hierarchy.
• RouteAssetOperatingOrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization for the route asset.
• RouteAssetSerialNumber: string
  Read Only: true

  Maximum Length: 80

  Serial number of the asset route within the logical hierarchy.
• RouteCompletionCode: string
  Maximum Length: 30

  Code that uniquely identifies the route completion. Valid values are Automatic or Manual, as defined in the lookup ORA_MNT_MX_PROGRAM_WO_CREATE. If set to Automatic, route assets don't need to be marked as complete or skipped during work order reporting. If set to Manual, route assets must be marked as either complete or skipped during work order reporting.
• RouteCompletionMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the route completion code.
• RouteFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then it indicates a route asset hierarchy. The default value is false.
• RouteSkipAllowedFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If set to true, then assets can optionally be marked as skipped during work order reporting. If set to false, then all assets must be marked as complete during work order reporting. The default value is false.

{
    "type":"object",
    "properties":{
        "ActiveEndDate":{
            "title":"Disabled",
            "type":"string",
            "description":"Date and time when the hierarchy name becomes inactive.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HierarchyCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the asset hierarchy name.",
            "nullable":false,
            "x-queryable":true
        },
        "HierarchyDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the hierarchy.",
            "nullable":true,
            "x-queryable":true
        },
        "HierarchyDisableFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the hierarchy name is disabled. If false, then the hierarchy name is enabled. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "HierarchyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the hierarchy name. The application generates this value when it creates the hierarchy. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "HierarchyName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"Name of the hierarchy.",
            "nullable":false,
            "x-queryable":true
        },
        "RouteAssetDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the route asset number associated with the hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RouteAssetId":{
            "type":"integer",
            "description":"Value that identifies the route asset associated with the hierarchy.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RouteAssetNumber":{
            "type":"string",
            "description":"Value that identifies the route asset number associated with the hierarchy.",
            "nullable":true,
            "x-queryable":true
        },
        "RouteAssetOperatingOrganization":{
            "maxLength":255,
            "type":"string",
            "description":"The operating organization of the asset route within the logical hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RouteAssetOperatingOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization for the route asset.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RouteAssetSerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Serial number of the asset route within the logical hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RouteCompletionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that uniquely identifies the route completion. Valid values are Automatic or Manual, as defined in the lookup ORA_MNT_MX_PROGRAM_WO_CREATE. If set to Automatic, route assets don't need to be marked as complete or skipped during work order reporting. If set to Manual, route assets must be marked as either complete or skipped during work order reporting.",
            "nullable":true,
            "x-queryable":true
        },
        "RouteCompletionMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the route completion code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RouteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then it indicates a route asset hierarchy. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "RouteSkipAllowedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If set to true, then assets can optionally be marked as skipped during work order reporting. If set to false, then all assets must be marked as complete during work order reporting. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Examples

This example describes how to update one logical hierarchy name.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/assetLogicalHierarchies/123456789101112"

Example Request Body

The following example includes the contents of the request body in JSON format. 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 updates.

{
	"HierarchyName": "Hierarchy_Name_Updated",
	"HierarchyCode": "Hierarchy_Code_Updated",
	"HierarchyDescription": "Hierarchy_Description_Updated",
	"HierarchyDisableFlag": "true"
}

Example Response Body

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

{
	"HierarchyName": "Hierarchy_Name_Updated",
	"HierarchyCode": "Hierarchy_Code_Updated",
	"HierarchyDescription": "Hierarchy_Description_Updated",
	"HierarchyId": 123456789101112,
	"ActiveEndDate": systemdate,
	"HierarchyDisableFlag": "true"
}

Back to Top