Jump to

• Request
• Response

Get Hierarchies

post

/config/sim/v1/hierarchy/getHierarchy

Gets a list of hierarchies in a given organization

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-OrgShortName: string(string)
  Org Identifier

Body ()

A request body

Root Schema : HierachyGetRequestBody

Type: object

The input Body model that needs to be given.

Show Source

• include(optional): string
  Objects included in response
• languages(optional): string
  If specified, limits translated strings returned
• limit(optional): integer
  If using paging, number of results returned in this page.
• offset(optional): integer
  Starting resource record index. Not required if paging parameters are not supported
• orderBy(optional): integer
  Sorts the response by the specified field name and sort order.
• searchCriteria(optional): string
  Search criteria to filter results based on field value

{
    "description":"The input Body model that needs to be given.",
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "description":"Objects included in response"
        },
        "languages":{
            "type":"string",
            "description":"If specified, limits translated strings returned"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"integer",
            "description":"Sorts the response by the specified field name and sort order."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of hierarchies in organization.

Body ()

Root Schema : Hierarchy

Type: object

Model for a Hierarchy Object

Show Source

• hierType(optional): string
  Type of Hierarchy Node

  Example: Default
• hierUnitId(optional): integer
  Hierarchy Unit Id of the root node of the hierarchy

  Example: 1
• name(optional): object name
  Hierarchy Name
• nodes(optional): array nodes
  An array of Hierarchy.
• parentHierUnitId(optional): integer
  Hierarchy unit id of the parent node

  Example: oracle.doceng.json.BetterJsonNull@45ecf220

{
    "description":"Model for a Hierarchy Object",
    "type":"object",
    "properties":{
        "name":{
            "description":"Hierarchy Name",
            "type":"object",
            "example":"{\"en-US\":\"Enterprise\", \"de-DE\": \"Enterprise\", \"ar-AR\": \"??????????????\"}"
        },
        "hierType":{
            "description":"Type of Hierarchy Node",
            "type":"string",
            "example":"Default"
        },
        "hierUnitId":{
            "description":"Hierarchy Unit Id of the root node of the hierarchy",
            "type":"integer",
            "example":1
        },
        "parentHierUnitId":{
            "description":"Hierarchy unit id of the parent node",
            "type":"integer",
            "example":null
        },
        "nodes":{
            "description":"An array of Hierarchy.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Hierarchy"
            }
        }
    }
}

Nested Schema : name

Type: object

Hierarchy Name

Example:

{"en-US":"Enterprise", "de-DE": "Enterprise", "ar-AR": "??????????????"}

Nested Schema : nodes

Type: array

An array of Hierarchy.

Show Source

• Array of: object Hierarchy
  Model for a Hierarchy Object

{
    "description":"An array of Hierarchy.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Hierarchy"
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(optional): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(optional): integer
  Error code of the problem

  Example: 55223
• status(optional): integer
  HTTP status code.

  Example: 400
• title(optional): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(optional): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

404 Response

404 Requested resource not found

Back to Top