GET Hierarchy/{id}

• 3 minutes to read
 • 3 minutes to read 
GET /api/v1/Hierarchy/{id}

Gets a HierarchyEntity object.

Calls the List agent service GetHierarchyEntity.

Path Part Type Description
id int32 The id of the HierarchyEntity to return. Required

Query String Parameters

Parameter Name Type Description
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category" Default = show all fields. 
GET /api/v1/Hierarchy/{id}?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

HierarchyEntity found.

Response Description
200 HierarchyEntity found.
404 Not Found.

Response body: HierarchyEntityWithLinks

Property Name Type Description
HierarchyId int32 The primary key (auto-incremented)
Domain string Domain seperating the different hierarchy
Name string Name of this hierarchy folder.
Fullname string The full name of this category, i.e. Foo/bar/test.
ParentId int32 Parent table
Children array Sub-items, if any.
Registered date-time Registered when in UTC.
RegisteredAssociateId int32 Registered by whom
Updated date-time Last updated when in UTC.
UpdatedAssociateId int32 Last updated by whom
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.
_Links object

Sample request

GET /api/v1/Hierarchy/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *

Sample response

HTTP/1.1 200 HierarchyEntity found.
Content-Type: application/json; charset=utf-8

{
  "HierarchyId": 329,
  "Domain": "Dashboards",
  "Name": "Willms-Hoppe",
  "Fullname": "recusandae",
  "ParentId": 347,
  "Children": [
    {
      "HierarchyId": 872,
      "Domain": "Dashboards",
      "Name": "Eichmann, Corwin and Welch",
      "Fullname": "porro",
      "ParentId": 978,
      "Children": [
        {},
        {}
      ],
      "Registered": "2019-04-01T17:54:08.2574567+02:00",
      "RegisteredAssociateId": 21,
      "Updated": "2003-01-12T17:54:08.2574567+01:00",
      "UpdatedAssociateId": 535,
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.String",
          "FieldLength": 335
        }
      }
    }
  ],
  "Registered": "2023-07-16T17:54:08.2574567+02:00",
  "RegisteredAssociateId": 510,
  "Updated": "2018-01-06T17:54:08.2574567+01:00",
  "UpdatedAssociateId": 25,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 389
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/contact/321",
    "Archive": "https://www.example.com/api/v1/contact"
  }
}