POST Agents/List/GetHierarchyEntity

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/List/GetHierarchyEntity

Gets a HierarchyEntity object.

Query String Parameters

Parameter Name Type Description
hierarchyEntityId int32 Required The primary key.
$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. 
POST /api/v1/Agents/List/GetHierarchyEntity?hierarchyEntityId=700
POST /api/v1/Agents/List/GetHierarchyEntity?$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:

OK

Response Description
200 OK

Response body: HierarchyEntity

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.

Sample request

POST /api/v1/Agents/List/GetHierarchyEntity
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "HierarchyId": 379,
  "Domain": "Dashboards",
  "Name": "Turner-Schoen",
  "Fullname": "quasi",
  "ParentId": 275,
  "Children": [
    {
      "HierarchyId": 138,
      "Domain": "Dashboards",
      "Name": "Hamill-Altenwerth",
      "Fullname": "aliquid",
      "ParentId": 357,
      "Children": [
        {},
        {}
      ],
      "Registered": "1999-04-03T17:54:03.3045907+02:00",
      "RegisteredAssociateId": 685,
      "Updated": "2010-04-27T17:54:03.3045907+02:00",
      "UpdatedAssociateId": 897,
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 773
        }
      }
    }
  ],
  "Registered": "2019-09-03T17:54:03.3045907+02:00",
  "RegisteredAssociateId": 323,
  "Updated": "2000-01-01T17:54:03.3045907+01:00",
  "UpdatedAssociateId": 738,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 748
    }
  }
}