Organizational Hierarchies

API endpoints for organizational hierarchy operations.

Learn more about Organizational Hierarchy Mapping.

Create a New Org Hierarchy

post

This endpoint creates an organizational hierarchy mapping record representing the organizations, businesses, departments, groups, and/or teams hierarchy. For more details, refer to the Opsera API Documentation.

Use Cases

• Organizational Structure Definition: Establish the hierarchy of your organization by defining relationships between entities.

• Data Integration: Synchronize organizational hierarchies with other systems that require up-to-date structural information.

• Access Control: Set up hierarchies that can be used to manage permissions and access rights within your organization.

---

Required Access

• Authentication: Bearer token is required.

• API Scope: api

• Site Roles:

  • Opsera Administrator

  • Administrator

  • Power User

---

Important Notes!

• Mandatory Fields: Both parent and child fields are required to establish the hierarchy.

• Entity Existence: Ensure that the entities you are linking (parent and child) already exist in the system.

• Type Validation: The parentType and childType fields should accurately reflect the types of the entities (e.g., "department", "team", "group").

• Relationship Definition: The relationship and mappingType are set to predefined constants and may not need to be modified.

Authorizations

bearerAuth

AuthorizationstringRequired

API authentication using Bearer tokens. Include your API token in the Authorization header: Authorization: Bearer <your-api-token>

Tokens can be obtained from the Opsera platform's API token management interface.

Body

application/json

parentstringRequired

The unique identifier of the parent entity.

Example: department-id-123

parentTypestringOptional

The type of the parent entity.

Example: department

childstringRequired

The unique identifier of the child entity.

Example: team-id-456

childTypestringOptional

The type of the child entity.

Example: team

Responses

201

Org hierarchy created successfully.

application/json

400

Bad Request - Invalid or missing input data.

application/json

401

Unauthorized - Authentication failed or insufficient permissions.

application/json

403

Forbidden - Access is denied.

application/json

500

Internal Server Error - An unexpected error occurred.

application/json

post

/api/v2/data/org-hierarchy

HTTPcURLJavaScriptPython

POST /api/v2/data/org-hierarchy HTTP/1.1
Host: api.[organization].opsera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "parent": "department-id-123",
  "parentType": "department",
  "child": "team-id-456",
  "childType": "team"
}

{
  "data": {
    "id": "<mapping-id>",
    "attribute1": "Opsera",
    "attribute2": "R&D",
    "attributes": {
      "parentType": "root",
      "childType": "Department"
    },
    "relationship": "org-hierarchy",
    "mappingType": "parent-child",
    "createdAt": "2023-11-01T12:00:00.000Z"
  }
}