Jump to

• Request
• Response
• Examples

Create names

post

/fscmRestApi/resources/11.13.18.05/assetLogicalHierarchies

Request

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.
• Upsert-Mode:
  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

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

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        }
    }
}

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.

{
    "type":"object",
    "properties":{
        "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
        },
        "HierarchyCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the asset hierarchy name.",
            "nullable":false,
            "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
        },
        "HierarchyName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the hierarchy.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ActiveEndDate":{
            "title":"Disabled",
            "type":"string",
            "description":"Date and time when the hierarchy name becomes inactive.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HierarchyDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the hierarchy.",
            "nullable":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

Examples

This example describes how to create one logical hierarchy name.

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

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

{
	"HierarchyName": "Hierarchy_Name",
	"HierarchyCode": "Hierarchy_Code",
	"HierarchyDescription": "Hierarchy_Description"
}

Example Response Body

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

{
	"HierarchyName": "Hierarchy_Name",
	"HierarchyCode": "Hierarchy_Code",
	"HierarchyDescription": "Hierarchy_Description",
	"HierarchyId": 123456789101112,
	"ActiveEndDate": null,
	"HierarchyDisableFlag": "false"
}

Back to Top