Versions Compared

Old Version 3

changes.mady.by.user Russ Frisch

Saved on

compared with

New Version 4

changes.mady.by.user Russ Frisch

Saved on

Key

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

...

URL

METHOD

DESCRIPTION

Scope

REQUEST

RESPONSE

/api/v2/data/mapping

POST

Creates a mapping record representing the relationship between the project and people.

Note
Required Fields: attribute1, attribute2. Representing either the project or person which will be associated to either a project or person.
mappingType: Identifies the type of mapping.
Supported types: "project-people", "parent-child"
relationship: Identifies the type of relationship.
Supported types: "many-to-many", "many-to-one", "one-to-one", "one-to-many", "org-hierarchy"

API Access

Code Block
languagejson
{
  "attribute1": "2322345", // project.projectId
  "attribute2": "jd@opsera.io", // people.email
  "mappingType": "project-people",
  "relationship": "many-to-many",
}
Code Block
200 OK

/api/v2/data/mappings

GET

Lists all mapping records for which you have access.

API Access

Code Block
languagejson
{
  "count": 1,
  "data": [
    {
      "id": "fec3d924-b2b6-41ad-8231-43e1fc0957e6"
      "attribute1": "John",
      "attribute2": "Doe",
      "mappingType": "project-member",
      "relationship": "many-to-many",
    },
  ]
}

/api/v2/data/mapping/{id}

GET

Gets the mapping record associated with the given email address.

API Access

Code Block
languagejson
{
  "id": "fec3d924-b2b6-41ad-8231-43e1fc0957e6"
  "attribute1": "John",
  "attribute2": "Doe",
  "mappingType": "project-member",
  "relationship": "many-to-many",
}

...

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
  "child": "R&D", // business
}
Code Block
200 OK