PUT Hierarchy/{id}

• 4 minutes to read
 • 4 minutes to read 
PUT /api/v1/Hierarchy/{id}

Updates the existing HierarchyEntity

NsApiSlow threshold: 5000 ms.

Path Part Type Description
id int32 The HierarchyEntity id to update. 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. 
PUT /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
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
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.

Request Body: entity

The HierarchyEntity to be saved.

Property Name Type Description
HierarchyId Integer 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 Integer Parent table
Children Array Sub-items, if any.
Registered String Registered when in UTC.
RegisteredAssociateId Integer Registered by whom
Updated String Last updated when in UTC.
UpdatedAssociateId Integer Last updated by whom

Response:

HierarchyEntity updated.

Response Description
200 HierarchyEntity updated.
400 Bad request. Entity to save is not in request body.

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

PUT /api/v1/Hierarchy/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv
Content-Type: application/json; charset=utf-8

{
  "HierarchyId": 642,
  "Domain": "Dashboards",
  "Name": "Witting Group",
  "Fullname": "excepturi",
  "ParentId": 777,
  "Children": [
    {
      "HierarchyId": 541,
      "Domain": "Dashboards",
      "Name": "Wilkinson-Hansen",
      "Fullname": "nesciunt",
      "ParentId": 841,
      "Children": [
        {},
        {}
      ],
      "Registered": "2022-08-14T02:30:52.6630355+02:00",
      "RegisteredAssociateId": 836,
      "Updated": "1998-11-16T02:30:52.6630355+01:00",
      "UpdatedAssociateId": 456
    }
  ],
  "Registered": "2021-05-11T02:30:52.6630355+02:00",
  "RegisteredAssociateId": 854,
  "Updated": "2023-06-14T02:30:52.6630355+02:00",
  "UpdatedAssociateId": 784
}

Sample response

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

{
  "HierarchyId": 115,
  "Domain": "Dashboards",
  "Name": "Conroy-Tromp",
  "Fullname": "et",
  "ParentId": 351,
  "Children": [
    {
      "HierarchyId": 51,
      "Domain": "Dashboards",
      "Name": "Hudson, Nitzsche and Paucek",
      "Fullname": "eaque",
      "ParentId": 339,
      "Children": [
        {},
        {}
      ],
      "Registered": "2010-06-17T02:30:52.6630355+02:00",
      "RegisteredAssociateId": 645,
      "Updated": "2007-10-19T02:30:52.6630355+02:00",
      "UpdatedAssociateId": 195,
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.String",
          "FieldLength": 873
        }
      }
    }
  ],
  "Registered": "2024-03-26T02:30:52.6630355+01:00",
  "RegisteredAssociateId": 652,
  "Updated": "2024-09-21T02:30:52.6630355+02:00",
  "UpdatedAssociateId": 384,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 552
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/project/321",
    "Archive": "https://www.example.com/api/v1/project"
  }
}