> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Default Hierarchy Entity

> Loading default values into a new HierarchyEntity.

NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-ListAgent.json post /api/v1/Agents/List/CreateDefaultHierarchyEntity
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - ListAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/List/CreateDefaultHierarchyEntity:
    post:
      tags:
        - List_Agent
      summary: Create Default Hierarchy Entity
      description: |-
        Loading default values into a new HierarchyEntity.

        NsApiSlow threshold: 5000 ms.
      operationId: v1ListAgent_CreateDefaultHierarchyEntity
      parameters:
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.HierarchyEntity'
            text/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.HierarchyEntity'
            application/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.HierarchyEntity'
            text/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.HierarchyEntity'
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.HierarchyEntity'
            application/merge-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.HierarchyEntity'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.HierarchyEntity:
      description: "Folder structures\r\n<para />\r\nCarrier object for HierarchyEntity.\r\nServices for the HierarchyEntity Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        HierarchyId:
          format: int32
          description: The primary key (auto-incremented)
          type: integer
        Domain:
          description: Domain seperating the different hierarchy
          enum:
            - Unknown
            - ExtraTables
            - ScreenDefinitions
            - Scripts
            - Selections
            - ExternalDocuments
            - UserGroups
            - ExternalDocumentRelatedToSpmMessage
            - Dashboards
            - EmailFlows
          type: string
        Name:
          description: Name of this hierarchy folder.
          type: string
        Fullname:
          description: The full name of this category, i.e. Foo/bar/test.
          type: string
        ParentId:
          format: int32
          description: Parent table
          type: integer
        Children:
          description: Sub-items, if any.
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.HierarchyEntity'
        Registered:
          format: date-time
          description: Registered when  in UTC.
          type: string
        RegisteredAssociateId:
          format: int32
          description: Registered by whom
          type: integer
        Updated:
          format: date-time
          description: Last updated when  in UTC.
          type: string
        UpdatedAssociateId:
          format: int32
          description: Last updated by whom
          type: integer
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string

````

## Related topics

- [Default Hierarchy Entity](/en/api/reference/restful/rest/hierarchy/default-hierarchy-entity.md)
- [NSListAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSListAgent.md)
- [SuperOffice.WebApi.Agents.IListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IListAgent.md)
- [SuperOffice.WebApi.Agents.ListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ListAgent.md)
- [Create Default C R M Script Entity](/en/api/reference/restful/agent/crmscript_agent/create-default-c-r-m-script-entity.md)
- [Create Default Currency Entity](/en/api/reference/restful/rest/list_currency/create-default-currency-entity.md)
