Project / People / Organizational Hierarchy Mapping API
- Russ Frisch
- 1 Introduction
- 2 People
- 3 Projects
- 3.1 Required Fields: projectId, projectName
- 3.2 externalId: Id for relating this person back to the original data source.
- 3.3 organization/business/department/group/team: Use these fields for associating organizational hierarchy metadata.
- 3.4 assets: A project can represent 1 or more repositories and/or services
- 4 People / Project Relationship Mapping
- 5 Organizational Hierarchy Mapping
Introduction
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 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:
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 |
|---|---|---|---|---|---|
| POST | Creates a new record representing a user that is associated with any projects. Required Fields: emailexternalId: Id for relating this person back to the original data source.organization/business/department/group/team: Use these fields for associating organizational hierarchy metadata.
|
| {
"firstName": "John",
"lastName": "Doe",
"displayName": "John Doe",
"email": "jd@opsera.io",
"externalId": "25ce97e1-549b-4f31-bd01-80490847f8a6",
"organization": "Opsera",
"business": "Engineering",
"department": "Platform",
"group": "Phase 2",
"team": "AOD"
} | 200 OK |
| GET | Lists all people records for which you have access. |
| Â | |
| GET | Gets the people record associated with the given email address. |
 |  |
Projects
The Project endpoint manages data about the relevant projects. Use these functions to create new project records, retrieve all project records, or access specific project details.
URL | METHOD | DESCRIPTION | Scope | REQUEST | RESPONSE |
|---|---|---|---|---|---|
| POST | Creates a new record representing a project that is associated with any users. Â Â Â |
| ||
| GET | Lists all project records for which you have access. |
| Â | |
| GET | Gets the project record associated with the given email address. |
 |  |
People / Project Relationship Mapping
The Mappings endpoint bridges the gap between people and projects. Use these functions to assign individuals to projects and retrieve information about existing assignments.
URL | METHOD | DESCRIPTION | Scope | REQUEST | RESPONSE |
|---|---|---|---|---|---|
| POST | Creates a mapping record representing the relationship between the project and people. Â Â Â Â Â |
| ||
| GET | Lists all mapping records for which you have access. |
| Â | |
| GET | Gets the mapping record associated with the given email address. |
 |  |
Organizational Hierarchy Mapping
URL | METHOD | DESCRIPTION | Scope | REQUEST | RESPONSE |
|---|---|---|---|---|---|
| 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      |
|