Aircampi Tree (0.1.0)

Download OpenAPI specification:Download

Support: [email protected] URL: https://github.com/aircampi Terms of Service

Introduction

Aircampi Tree is a tree manager service that helps you to create and maintain hierarchical relationships, such as trees.

A tree is a way of describing a hierarchy. Trees may have one or more versions. Each tree version contains at least one root node.

Tree

A tree contains data that is organized in a hierarchy, allowing the creation of groupings and rollups of information that already exist within an organization. A tree can have one or more tree versions.
Tree Version

A tree by default has only one version. If required, you can create and maintain more than one tree version. Similar to any other version control system, versions of trees are maintained to track all the changes that a tree undergoes in its life cycle.
Tree Node

Each tree version contains at least one root node; that is, a member that has no superior. A node is a parent of another node if it is one step higher in the hierarchy and closer to the root node. The root node is the highest node of a tree. Child nodes branch off from the root node. Child nodes at the same level, branching off from a common parent node, are called siblings. Leaves are details branching off from a node but not extending further down the tree hierarchy.
Translation

You can translate the tree, tree version, and tree nodes that you defined to the preferred language(s) without changing the language session of the application. When you edit a particular language entry, you can modify the translated name and description to the language in which you want the tree to appear. Once the updates are made, the end-users can view the lookup in the translated text.

Quick Links:

Endpoints

This section contains the information about api references for Aircampi Tree.

Group of endpoints:

Trees
Tree Versions
Translations
Settings
Health Check

Trees

A tree contains data that is organized in a hierarchy, allowing the creation of groupings and rollups of information that already exist within an organization. A tree can have one or more tree versions.

Get Trees

Retrieve filtered list of trees.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "hr_dept",
"name": "HR Department",
"description": "Human Resources Department, Aircampi Inc.",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"hr"
],
"fields": [{"name": "department_id",
"value": 123456
},
{"name": "department_name",
"value": "HR department"
},
{"name": "manager_id",
"value": 32143415
}
]
},
"enabled": true,
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"versions": 0,
"nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"versions": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"version": "v1",
"name": "Version 1.0",
"description": "Default Version 1.0",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"v1"
]
},
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"levels": 0,
"nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_node_id": "9f988f1f-6565-4ac9-8571-60af9afd9fc1",
"child_nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"child_nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": { },
"tags": [ ],
"fields": [ ]
},
"depth": 0,
"leaf": true,
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
]
}
]
}

Create Tree

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Create Tree

code required	string (tree_code) Tree Code
name required	string (tree_name) Tree Name
description	string (tree_description) Tree Description
	object (tree_metadata) Tree Metadata

Responses

Request samples

Payload

Content type

application/json

{"code": "devops_dept",
"name": "DevOps Department",
"description": "DevOps Department, Aircampi Inc.",
"metadata": {"tags": ["tag1",
"tag2"
]
}
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "hr_dept",
"name": "HR Department",
"description": "Human Resources Department, Aircampi Inc.",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"hr"
],
"fields": [{"name": "department_id",
"value": 123456
},
{"name": "department_name",
"value": "HR department"
},
{"name": "manager_id",
"value": 32143415
}
]
},
"enabled": true,
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"versions": 0,
"nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"versions": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"version": "v1",
"name": "Version 1.0",
"description": "Default Version 1.0",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"v1"
]
},
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"levels": 0,
"nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_node_id": "9f988f1f-6565-4ac9-8571-60af9afd9fc1",
"child_nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"child_nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
]
}

Get Tree

Retrieve tree details.

Authorizations:

Scopes

path Parameters

tree_code

required

string (tree_code)

Example: hr_dept

Tree

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "hr_dept",
"name": "HR Department",
"description": "Human Resources Department, Aircampi Inc.",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"hr"
],
"fields": [{"name": "department_id",
"value": 123456
},
{"name": "department_name",
"value": "HR department"
},
{"name": "manager_id",
"value": 32143415
}
]
},
"enabled": true,
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"versions": 0,
"nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"versions": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"version": "v1",
"name": "Version 1.0",
"description": "Default Version 1.0",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"v1"
]
},
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"levels": 0,
"nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_node_id": "9f988f1f-6565-4ac9-8571-60af9afd9fc1",
"child_nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"child_nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
]
}

Update Tree

Authorizations:

Scopes

path Parameters

tree_code

required

string (tree_code)

Example: hr_dept

Tree

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Update Tree

name	string (tree_name) Tree Name
description	string (tree_description) Tree Description
	object (tree_metadata) Tree Metadata
enabled	boolean (tree_enabled) Default: true Is tree enabled?

Responses

Request samples

Payload

Content type

application/json

{"name": "HR Department",
"description": "Human Resources Department, Aircampi Inc.",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"hr"
],
"fields": [{"name": "department_id",
"value": 123456
},
{"name": "department_name",
"value": "HR department"
},
{"name": "manager_id",
"value": 32143415
}
]
},
"enabled": true
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "hr_dept",
"name": "HR Department",
"description": "Human Resources Department, Aircampi Inc.",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"hr"
],
"fields": [{"name": "department_id",
"value": 123456
},
{"name": "department_name",
"value": "HR department"
},
{"name": "manager_id",
"value": 32143415
}
]
},
"enabled": true,
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"versions": 0,
"nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"versions": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"version": "v1",
"name": "Version 1.0",
"description": "Default Version 1.0",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"v1"
]
},
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"levels": 0,
"nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_node_id": "9f988f1f-6565-4ac9-8571-60af9afd9fc1",
"child_nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"child_nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
]
}

Delete Tree

Authorizations:

Scopes

path Parameters

tree_code

required

string (tree_code)

Example: hr_dept

Tree

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Clone Tree

Authorizations:

Scopes

path Parameters

tree_code

required

string (tree_code)

Example: hr_dept

Tree

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Clone Tree

code required	string (tree_code) Tree Code
name required	string (tree_name) Tree Name
description	string (tree_description) Tree Description
	object (tree_metadata) Tree Metadata

Responses

Request samples

Payload

Content type

application/json

{"code": "devops_dept",
"name": "DevOps Department",
"description": "DevOps Department, Aircampi Inc.",
"metadata": {"tags": ["tag1",
"tag2"
]
}
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Change Tree Code

Authorizations:

Scopes

path Parameters

tree_code

required

string (tree_code)

Example: hr_dept

Tree

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Change Tree

new_code

string (tree_code)

Tree Code

Responses

Request samples

Payload

Content type

application/json

{"new_code": "devops_department"
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Tree Versions

A tree by default has only one version. If required, you can create and maintain more than one tree version. Similar to any other version control system, versions of trees are maintained to track all the changes that a tree undergoes in its life cycle.

Get Tree Versions

Retrieve filtered list of tree versions.

Authorizations:

Scopes

path Parameters

tree_code

required

string (tree_code)

Example: hr_dept

Tree

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"version": "v1",
"name": "Version 1.0",
"description": "Default Version 1.0",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"v1"
]
},
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"levels": 0,
"nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_node_id": "9f988f1f-6565-4ac9-8571-60af9afd9fc1",
"child_nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"child_nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
]
}

Create Tree Version

Authorizations:

Scopes

path Parameters

tree_code

required

string (tree_code)

Example: hr_dept

Tree

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Create Tree Version

version	string (tree_version_code) Tree Version Code
name	string (tree_version_name) Tree Version Name
description	string (tree_version_description) Tree Version Description
	object (tree_version_metadata) Tree Version Metadata

Responses

Request samples

Payload

Content type

application/json

{"version": "v1",
"name": "Version 1.0",
"description": "Default Version 1.0",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"v1"
]
}
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"version": "v1",
"name": "Version 1.0",
"description": "Default Version 1.0",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"v1"
]
},
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"levels": 0,
"nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_node_id": "9f988f1f-6565-4ac9-8571-60af9afd9fc1",
"child_nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"child_nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Get Tree Version

Retrieve tree version details.

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"version": "v1",
"name": "Version 1.0",
"description": "Default Version 1.0",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"v1"
]
},
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"levels": 0,
"nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_node_id": "9f988f1f-6565-4ac9-8571-60af9afd9fc1",
"child_nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"child_nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Update Tree Version

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Update Tree Version

name	string (tree_version_name) Tree Version Name
description	string (tree_version_description) Tree Version Description
	object (tree_version_metadata) Tree Version Metadata
enabled	boolean (tree_version_enabled) Default: true Is tree version enabled?

Responses

Request samples

Payload

Content type

application/json

{"name": "Version 1.0",
"description": "Default Version 1.0",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"v1"
]
},
"enabled": true
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"version": "v1",
"name": "Version 1.0",
"description": "Default Version 1.0",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"v1"
]
},
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"levels": 0,
"nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_node_id": "9f988f1f-6565-4ac9-8571-60af9afd9fc1",
"child_nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"child_nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Delete Tree Version

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Clone Tree Version

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Clone Tree Version

version required	string (tree_version_code) Tree Version Code
name required	string (tree_version_name) Tree Version Name
description	string (tree_version_description) Tree Version Description
	object (tree_version_metadata) Tree Version Metadata

Responses

Request samples

Payload

Content type

application/json

{"version": "v1",
"name": "Version 1.0",
"description": "Default Version 1.0",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"v1"
]
}
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Change Tree Version Code

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Change Tree Version

new_version

string (tree_version_code)

Tree Version Code

Responses

Request samples

Payload

Content type

application/json

{"new_version": "version1"
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Tree Nodes

Each tree version contains at least one root node; that is, a member that has no superior. A node is a parent of another node if it is one step higher in the hierarchy and closer to the root node. The root node is the highest node of a tree. Child nodes branch off from the root node. Child nodes at the same level, branching off from a common parent node, are called siblings. Leaves are details branching off from a node but not extending further down the tree hierarchy.

Get Tree Nodes

Retrieve filtered list of tree nodes.

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_node_id": "9f988f1f-6565-4ac9-8571-60af9afd9fc1",
"child_nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"child_nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Create Tree Node

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Create Tree Node

code required	string (tree_node_code) Tree Node Code. It is unique withing the version.
name required	string (tree_node_name) Tree Node Name
description	string (tree_node_description) Tree Node Description
	object (tree_node_metadata) Lookup Metadata
parent_id	string <uuid> (tree_node_parent_id) Parent Tree Node Id

Responses

Request samples

Payload

Content type

application/json

{"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_node_id": "9f988f1f-6565-4ac9-8571-60af9afd9fc1",
"child_nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"child_nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Get Tree Node

Retrieve tree node details.

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version
tree_node_id required	string <uuid> (tree_node_id) Tree Node Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_node_id": "9f988f1f-6565-4ac9-8571-60af9afd9fc1",
"child_nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"child_nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Update Tree Node

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version
tree_node_id required	string <uuid> (tree_node_id) Tree Node Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Update Tree Node

code	string (tree_node_code) Tree Node Code. It is unique withing the version.
name	string (tree_node_name) Tree Node Name
description	string (tree_node_description) Tree Node Description
	object (tree_node_metadata) Lookup Metadata
parent_id	string <uuid> (tree_node_parent_id) Parent Tree Node Id
enabled	boolean (tree_node_enabled) Default: true Is tree node enabled?

Responses

Request samples

Payload

Content type

application/json

{"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"enabled": true
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_node_id": "9f988f1f-6565-4ac9-8571-60af9afd9fc1",
"child_nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"child_nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Delete Tree Node

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version
tree_node_id required	string <uuid> (tree_node_id) Tree Node Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Clone Tree Node

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version
tree_node_id required	string <uuid> (tree_node_id) Tree Node Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Clone Tree Node

code required	string (tree_node_code) Tree Node Code. It is unique withing the version.
name required	string (tree_node_name) Tree Node Name
description	string (tree_node_description) Tree Node Description
	object (tree_node_metadata) Lookup Metadata
parent_id	string <uuid> (tree_node_parent_id) Parent Tree Node Id

Responses

Request samples

Payload

Content type

application/json

{"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef"
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Translations

You can translate the tree, tree version, and tree nodes that you defined to the preferred language(s) without changing the language session of the application. When you edit a particular language entry, you can modify the translated name and description to the language in which you want the tree to appear. Once the updates are made, the end-users can view the lookup in the translated text.

Get Tree Translations

Retrieve filtered list of tree translations.

Authorizations:

Scopes

path Parameters

tree_code

required

string (tree_code)

Example: hr_dept

Tree

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "HR Department",
"description": "HR Department Hierarchy",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create Tree Translation

Authorizations:

Scopes

path Parameters

tree_code

required

string (tree_code)

Example: hr_dept

Tree

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Create Tree Translation

language	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Languages
name	string (label_name) Label Name
description	string (label_description) Label Description

Responses

Request samples

Payload

Content type

application/json

{"language": "en_US",
"name": "HR Department",
"description": "HR Department Hierarchy"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "HR Department",
"description": "HR Department Hierarchy",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Tree Translation

Retrieve tree translation details.

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
language required	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Language

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "HR Department",
"description": "HR Department Hierarchy",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Tree Translation

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
language required	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Language

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Update Tree Translation

name	string (label_name) Label Name
description	string (label_description) Label Description

Responses

Request samples

Payload

Content type

application/json

{"name": "HR",
"description": "Human Resources Department Tree"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "HR Department",
"description": "HR Department Hierarchy",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Tree Translation

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
language required	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Language

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Get Tree Version Translations

Retrieve filtered list of tree version translations.

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "HR Department V1",
"description": "HR Department Hierarchy Version 1",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create Tree Version Translation

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Create Tree Version Translation

language	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Languages
name	string (label_name) Label Name
description	string (label_description) Label Description

Responses

Request samples

Payload

Content type

application/json

{"language": "en_US",
"name": "HR Department V1",
"description": "HR Department Hierarchy Version 1"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "HR Department V1",
"description": "HR Department Hierarchy Version 1",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Tree Version Translation

Retrieve tree version translation details.

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version
language required	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Language

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "HR Department V1",
"description": "HR Department Hierarchy Version 1",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Tree Version Translation

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version
language required	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Language

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Update Tree Version Translation

name	string (label_name) Label Name
description	string (label_description) Label Description

Responses

Request samples

Payload

Content type

application/json

{"name": "HR Department V1",
"description": "HR Department Hierarchy Version 1"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "HR Department V1",
"description": "HR Department Hierarchy Version 1",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Tree Version Translation

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version
language required	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Language

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Get Tree Node Translations

Retrieve filtered list of tree node translations.

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version
tree_node_id required	string <uuid> (tree_node_id) Tree Node Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create Tree Node Translation

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version
tree_node_id required	string <uuid> (tree_node_id) Tree Node Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Create Tree Node Translation

language	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Languages
name	string (label_name) Label Name
description	string (label_description) Label Description

Responses

Request samples

Payload

Content type

application/json

{"language": "en_US",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Tree Node Translation

Retrieve tree node translation details.

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version
tree_node_id required	string <uuid> (tree_node_id) Tree Node Id
language required	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Language

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Tree Node Translation

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version
tree_node_id required	string <uuid> (tree_node_id) Tree Node Id
language required	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Language

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Update Tree Node Translation

name	string (label_name) Label Name
description	string (label_description) Label Description

Responses

Request samples

Payload

Content type

application/json

{"name": "Ankhbayar B",
"description": "Ankhbayar B, Head of HR"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Tree Node Translation

Authorizations:

Scopes

path Parameters

tree_code required	string (tree_code) Example: hr_dept Tree
tree_version required	string (tree_version_code) Example: v1 Tree Version
tree_node_id required	string <uuid> (tree_node_id) Tree Node Id
language required	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Language

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter. See https://developer.aircampi.com/api/query-fields"
}

Settings

Aircampi Tree's settings allow you to edit your server setup configuration and customize it. You can easily change the it by changing them when running Aircampi Tree.

Get Settings

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Responses

Response samples

Content type

application/json

{"environment": "development"
}

Update Settings

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Access Token

Request Body schema: application/json

Update Settings

environment

string

Default: "development"

Enum: "development" "staging" "production"

Environment

Responses

Request samples

Payload

Content type

application/json

{"environment": "development"
}

Response samples

Content type

application/json

{"environment": "development"
}

Health Check

The Health service is designed to allow you to both validate and monitor that your Aircampi Tree's instance and all of its internal components are up and responsive.

Check Health

Responses

Response samples

Content type

application/json

{"server_name": "Aircampi Tree",
"server_version": "0.1.0",
"server_status": "Active",
"server_description": "Aircampi Tree is a tree manager service that helps you to create and maintain hierarchical relationships, such as trees."
}

Tree Models

Tree
Trees
Tree Version
Tree Versions
Tree Node
Tree Nodes
Translation
Translations

Tree

Resource Type: Single Resource

Fields:

id
code
name
description
metadata
enabled
created_at
updated_at

Child Resources:

aggregations
versions

id	string <uuid> (tree_id) Tree Unique Identifier (ID)
code	string (tree_code) Tree Code
name	string (tree_name) Tree Name
description	string (tree_description) Tree Description
	object (tree_metadata) Tree Metadata
enabled	boolean (tree_enabled) Default: true Is tree enabled?
created_date	string <date-time> (created_at) Create at date and time
updated_date	string <date-time> (updated_at) Updated at date and time
	object (tree_aggregation) Tree Aggregation
	Array of objects (tree_version) Tree Versions in the collection

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "hr_dept",
"name": "HR Department",
"description": "Human Resources Department, Aircampi Inc.",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"hr"
],
"fields": [{"name": "department_id",
"value": 123456
},
{"name": "department_name",
"value": "HR department"
},
{"name": "manager_id",
"value": 32143415
}
]
},
"enabled": true,
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"versions": 0,
"nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"versions": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"version": "v1",
"name": "Version 1.0",
"description": "Default Version 1.0",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"v1"
]
},
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"levels": 0,
"nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_node_id": "9f988f1f-6565-4ac9-8571-60af9afd9fc1",
"child_nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"child_nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
]
}

Trees

Resource Type: Collection Resource

total_count	integer (Total Count) The total number of search records that match the query If you send request with query parameter ?total_count=true only. Otherwise the total_count is not included.
count	integer (Count) The number of items returned in the current range.
has_more	boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
limit	integer (Limit) The actual paging size used by the server.
offset	integer (Offset) Default: 10 The offset value used in the current page.
	Array of objects (tree) The trees in the collection.

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "hr_dept",
"name": "HR Department",
"description": "Human Resources Department, Aircampi Inc.",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"hr"
],
"fields": [{"name": "department_id",
"value": 123456
},
{"name": "department_name",
"value": "HR department"
},
{"name": "manager_id",
"value": 32143415
}
]
},
"enabled": true,
"created_date": "2019-08-24T14:15:22Z",
"updated_date": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"versions": 0,
"nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"versions": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"version": "v1",
"name": "Version 1.0",
"description": "Default Version 1.0",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"v1"
]
},
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"levels": 0,
"nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_node_id": "9f988f1f-6565-4ac9-8571-60af9afd9fc1",
"child_nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"child_nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": { },
"tags": [ ],
"fields": [ ]
},
"depth": 0,
"leaf": true,
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
]
}
]
}

Tree Version

Resource Type: Single Resource

Fields:

id
tree_id
version
name
description
metadata
enabled
created_at
updated_at

Child Resources:

aggregations
nodes

id	string <uuid> (tree_version_id) Tree Version Unique Identifier (ID)
tree_id	string <uuid> (tree_id) Tree Unique Identifier (ID)
version	string (tree_version_code) Tree Version Code
name	string (tree_version_name) Tree Version Name
description	string (tree_version_description) Tree Version Description
	object (tree_version_metadata) Tree Version Metadata
enabled	boolean (tree_version_enabled) Default: true Is tree version enabled?
created_by	string <uuid> (user_id) User Id
created_at	string <date-time> (created_at) Create at date and time
updated_by	string <uuid> (user_id) User Id
updated_at	string <date-time> (updated_at) Updated at date and time
	object (tree_version_aggregation) Tree Version Aggregation
	Array of objects (tree_node) Tree Nodes in the collection

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"version": "v1",
"name": "Version 1.0",
"description": "Default Version 1.0",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"v1"
]
},
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"levels": 0,
"nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_node_id": "9f988f1f-6565-4ac9-8571-60af9afd9fc1",
"child_nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"child_nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Tree Versions

Resource Type: Collection Resource

total_count	integer (Total Count) The total number of search records that match the query If you send request with query parameter ?total_count=true only. Otherwise the total_count is not included.
count	integer (Count) The number of items returned in the current range.
has_more	boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
limit	integer (Limit) The actual paging size used by the server.
offset	integer (Offset) Default: 10 The offset value used in the current page.
	Array of objects (tree_version) The tree's version in the collection.

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"version": "v1",
"name": "Version 1.0",
"description": "Default Version 1.0",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["department_tree",
"v1"
]
},
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"levels": 0,
"nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_node_id": "9f988f1f-6565-4ac9-8571-60af9afd9fc1",
"child_nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"child_nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
]
}

Tree Node

Resource Type: Single Resource

Fields:

id
tree_id
tree_version_id
code
name
description
metadata
depth
leaf
parent_id
enabled
created_at
updated_at

Child Resources:

aggregations
child_nodes

id	string <uuid> (tree_node_id) Tree Node Id
tree_id	string <uuid> (tree_id) Tree Unique Identifier (ID)
tree_version_id	string <uuid> (tree_version_id) Tree Version Unique Identifier (ID)
code	string (tree_node_code) Tree Node Code. It is unique withing the version.
name	string (tree_node_name) Tree Node Name
description	string (tree_node_description) Tree Node Description
	object (tree_node_metadata) Lookup Metadata
depth	integer Default: 0 Node Depth
leaf	boolean Is leaf node? There is no child when leaf.
parent_id	string <uuid> (tree_node_parent_id) Parent Tree Node Id
enabled	boolean (tree_node_enabled) Default: true Is tree node enabled?
created_by	string <uuid> (user_id) User Id
created_at	string <date-time> (created_at) Create at date and time
updated_by	string <uuid> (user_id) User Id
updated_at	string <date-time> (updated_at) Updated at date and time
	object (tree_node_aggregation) Tree Node Aggregation
	Array of objects (tree_child_node) Child Nodes in the collection

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_node_id": "9f988f1f-6565-4ac9-8571-60af9afd9fc1",
"child_nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"child_nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Tree Nodes

Resource Type: Collection Resource

total_count	integer (Total Count) The total number of search records that match the query If you send request with query parameter ?total_count=true only. Otherwise the total_count is not included.
count	integer (Count) The number of items returned in the current range.
has_more	boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
limit	integer (Limit) The actual paging size used by the server.
offset	integer (Offset) Default: 10 The offset value used in the current page.
	Array of objects (tree_node) The tree's nodes in the collection.

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_id": "f07488fc-5e0e-4ee8-a1d2-6e2f8b420128",
"tree_version_id": "20800cb6-c4ea-4c2a-b01a-49beac608a38",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"tree_node_id": "9f988f1f-6565-4ac9-8571-60af9afd9fc1",
"child_nodes": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"child_nodes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "123-456-789",
"name": "Ankhbayar",
"description": "Ankhbayar, Head of HR",
"metadata": {"label": {"label_id": "03e7493c-608b-4c34-83b8-041808788ef3"
},
"tags": ["+tenant1",
"+tenant2"
],
"fields": [{"name": "employee_number",
"value": 911
},
{"name": "job_title",
"value": "Head of Human Resources Department"
}
]
},
"depth": 0,
"leaf": true,
"enabled": true,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Translation

Resource Type: Single Resource

Fields:

id
label_id
language
name
description
created_at
updated_at

Child Resources: No child resources.

id	string <uuid> (id) Unique Identifier (ID)
label_id	string <uuid> (label_id) Label Id
language	string (language) Default: "en_US" Enum: "en_US" "en_UK" "mn_MN" Languages
name	string (label_name) Label Name
description	string (label_description) Label Description
created_by	string <uuid> (user_id) User Id
created_at	string <date-time> (created_at) Create at date and time
updated_by	string <uuid> (user_id) User Id
updated_at	string <date-time> (updated_at) Updated at date and time

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "HR Department",
"description": "HR Department Hierarchy",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Translations

Resource Type: Collection Resource

total_count	integer (Total Count) The total number of search records that match the query If you send request with query parameter ?total_count=true only. Otherwise the total_count is not included.
count	integer (Count) The number of items returned in the current range.
has_more	boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
limit	integer (Limit) The actual paging size used by the server.
offset	integer (Offset) Default: 10 The offset value used in the current page.
	Array of objects (tree_translation) The tree's translations in the collection.

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label_id": "03e7493c-608b-4c34-83b8-041808788ef3",
"language": "en_US",
"name": "HR Department",
"description": "HR Department Hierarchy",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Settings Models

Server Settings

Server Settings

Resource Type: Single Resource

Fields:

environment

Child Resources: No child resources.

environment

string

Default: "development"

Enum: "development" "staging" "production"

Environment

{"environment": "development"
}

Health Check Models

Health Check

Health Check

Resource Type: Single Resource

Fields:

server_name
server_version
server_status
server_description

Child Resources: No child resources.

server_name	string Name of server
server_version	string Version of server
server_status	string Default: "Active" Enum: "Active" "Warning" "Error" Status of server
server_description	string Description of server

{"server_name": "Aircampi Tree",
"server_version": "0.1.0",
"server_status": "Active",
"server_description": "Aircampi Tree is a tree manager service that helps you to create and maintain hierarchical relationships, such as trees."
}