Versions Compared

Old Version 5

changes.mady.by.user Russ Frisch

Saved on

compared with

New Version Current

changes.mady.by.user Russ Frisch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This API provides functionalities to manage people, projects, organizational hierarchy, and their relationships. Providing this data via these APIs can be useful for providing filters for Insights dashboards. You can create, read, and list data for each resource. Feel free to explore each endpoint section for further details.

Remember to authenticate generate an Opsera API token before accessing any of these endpoints. This API token must be included with all API calls as an Authorization header in the following format:

Code Block
Authorization: {opsera_api_token}

People

The People endpoint manages data about the users involved in your projects. Use these functions to create new people records, retrieve all people records, or access specific person details.

...

URL

METHOD

DESCRIPTION

Scope

REQUEST

RESPONSE

/api/v2/data/org-hierarchy

POST

Creates an organizational hierarchy mapping record representing the organizations, businesses, departments, groups, and/or teams hierarchy.

This is a convenience endpoint that creates a /mapping record where mappingType = "parent-child" and relationship = "org-hierarchy"

Note
Required Fields: parent, child. Representing the parent and child organization/business/department/group/team.
organization would represent the highest entities while team would represent the lowest level.

API Access

Code Block
languagejson
{
  "parent": "Opsera", // organization
  "parentType": "root"
  "child": "R&D", // business
  "childType": "Department"
}
Code Block
200 OK