The Perform & Engage 365 API enables you to:
- Get a list of talent mapping cycles
- Get the details of a particular talent mapping cycle by its ID
- Get a list of reviews for a talent mapping cycle
- Get the details of a particular review by its ID
Get a list of talent mapping cycles
GET /api/v2/talent_mapping_cycles/
This request enables you to get a list of talent mapping cycles.
Optional query parameters
- name (string). The talent mapping cycle name or part of its name.
- limit (integer). The maximum number of talent mapping cycles in the response.
- offset (integer). The initial index from which the results are returned in the response.
Request example
GET /api/v2/talent_mapping_cycles/?name=Q1
Response body parameters
The response body includes:
- count (integer). The number of results.
- next and previous (strings). URLs to the next and previous pages (if you used pagination in the original request).
-
results (array). The list of talent mapping cycles. Each talent mapping cycle has these parameters:
- api_id (string). The talent mapping cycle ID. You can use this ID to get more details about the talent mapping cycle.
- name (string). The talent mapping cycle name.
-
potentials (array) and perfomances (array). The lists contain values used to review the employees' potential and performance, respectively. Each value from these lists has these parameters:
- sort_order (integer). The parameter shows how the potential or performance is arranged on the talent map.
- value (integer). The potential or performance value.
- name (string). The potential or performance name.
-
fields (array). The list of additional fields from the talent mapping cycle. Each element has these parameters:
- sort_order (integer). The parameter shows how the additional field is arranged on the talent map.
- name (string). The additional field name.
- status (string). The current talent mapping cycle status.
Response body example
The successful 200 response returns the body similar to this:
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"api_id": "9a7ae213-e227-46c1-8622-9aec5c66f43a",
"name": "Q1",
"template": {
"api_id": "337e40c0-054b-4d4f-ae62-6864ddf02aa4",
"name": "Talent Mapping",
"potentials": [
{
"sort_order": 0,
"value": 1,
"name": "Low"
},
{
"sort_order": 1,
"value": 2,
"name": "Moderate"
},
{
"sort_order": 2,
"value": 3,
"name": "High"
}
],
"performances": [
{
"sort_order": 0,
"value": 1,
"name": "Low"
},
{
"sort_order": 1,
"value": 2,
"name": "Moderate"
},
{
"sort_order": 2,
"value": 3,
"name": "High"
}
],
"fields": [
{
"sort_order": 0,
"name": "Risk of loss"
},
{
"sort_order": 1,
"name": "Impact of loss"
}
]
},
"status": "Active"
}
]
}
Get the details of a particular talent mapping cycle by its ID
GET /api/v2/talent_mapping_cycles/{api_id}/
After getting the talent mapping cycle api_id in the response to the previous request, you can use this ID to get information about the talent mapping cycle.
Required path parameter
- api_id (string). The talent mapping cycle ID you can get by sending the GET /api/v2/talent_mapping_cycles/ request.
Request example
GET /api/v2/talent_mapping_cycles/9a7ae213-e227-46c1-8622-9aec5c66f43a/
Response body parameters
The GET api/v2/talent_mapping_cycles/{api_id}/ response includes the same parameters as the results array in the GET /api/v2/talent_mapping_cycles/ response.
Response body example
The successful 200 response returns the body similar to this:
{
"api_id": "9a7ae213-e227-46c1-8622-9aec5c66f43a",
"name": "Q1",
"template": {
"api_id": "337e40c0-054b-4d4f-ae62-6864ddf02aa4",
"name": "Talent Mapping",
"potentials": [
{
"sort_order": 0,
"value": 1,
"name": "Low"
},
{
"sort_order": 1,
"value": 2,
"name": "Moderate"
},
{
"sort_order": 2,
"value": 3,
"name": "High"
}
],
"performances": [
{
"sort_order": 0,
"value": 1,
"name": "Low"
},
{
"sort_order": 1,
"value": 2,
"name": "Moderate"
},
{
"sort_order": 2,
"value": 3,
"name": "High"
}
],
"fields": [
{
"sort_order": 0,
"name": "Risk of loss"
},
{
"sort_order": 1,
"name": "Impact of loss"
}
]
},
"status": "Active"
}
Get a list of reviews for a talent mapping cycle
GET /api/v2/talent_mapping_cycles/{cycle_api_id}/users/
This request enables you to get a list of users reviewed by a particular talent mapping cycle, along with the results of the review.
Required path parameter
- cycle_api_id (string). The talent mapping cycle ID you can get by sending the GET /api/v2/talent_mapping_cycles/ request.
Optional query parameters
- person_name (string). The case-insensitive full name or part of the name of the user reviewed by the talent mapping cycle.
- performance (string) and potential (string). The level of the user's performance and potential in the talent mapping cycle.
- limit (integer). The maximum number of users in the response.
- offset (integer). The initial index from which the results are returned in the response.
Request example
GET /api/v2/talent_mapping_cycles/9a7ae213-e227-46c1-8622-9aec5c66f43a/ users/?performance=Moderate&potential=Moderate
Response body parameters
The response body includes:
- count (integer). The number of results.
- next and previous (strings). URLs to the next and previous pages (if you used pagination in the original request).
-
results (array). The list of reviews for the talent mapping cycle. Each review has these parameters:
- api_id (string). The review ID. You can use this ID to get more details about the review.
-
person (object). The user's details include these parameters:
- api_id (string). The user's ID.
- name (string). The user's full name.
- email (string). The user's email address.
- department (string). The user's department.
- person_properties (array). The user's properties as the name and value pairs of string parameters. For example, it could be the user's role at the company.
- performance (string) and potential (string). The level of the user's performance and potential in the talent mapping cycle.
- data (array). The list of custom talent mapping cycle fields as the field and value pairs of string parameters.
Response body example
The successful 200 response returns the body similar to this:
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"api_id": "8ac868ce-97e2-4076-b03c-a3b772544c03",
"person": {
"api_id": "580:4aeb7ade-f9b7-4b13-b9f3-b0ac7ead5610",
"name": "Test User",
"email": "test@test.net",
"department": "R&D",
"person_properties": [
{
"name": "Role",
"value": "Director of Engineering"
}
]
},
"performance": "Moderate",
"potential": "Moderate",
"data": [
{
"field": "Team engagement",
"value": "High"
}
]
}
]
}
Get the details of a particular review by its ID
GET /api/v2/talent_mapping_cycles/{cycle_api_id}/users/{api_id}/
After getting the talent mapping cycle review api_id in the response to the previous request, you can use this ID to get information about the review.
Required path parameters
- api_id (string). The review ID you can get by sending the GET /api/v2/talent_mapping_cycles/{cycle_api_id}/users/ request.
- cycle_api_id (string). The talent mapping cycle ID you can get by sending the GET /api/v2/talent_mapping_cycles/ request.
Request example
GET /api/v2/talent_mapping_cycles/f7462ff0-81ca-4def-a841-18ee14f6ace0/ users/bf6d91f6-74d9-47f7-8592-4b2ba6a23778/
Response body parameters
The GET api/v2/talent_mapping_cycles/{cycle_api_id}/users/{api_id}/ response includes the same parameters as the results array in the GET /api/v2/talent_mapping_cycles/{cycle_api_id}/users/ response, but only for one review, the ID of which you specified in the request query parameters.
Response body example
The successful 200 response returns the body similar to this:
{
"api_id": "8ac868ce-97e2-4076-b03c-a3b772544c03",
"person": {
"api_id": "580:4aeb7ade-f9b7-4b13-b9f3-b0ac7ead5610",
"name": "Test User",
"email": "test@test.net",
"department": "R&D",
"person_properties": [
{
"name": "Role",
"value": "Director of Engineering"
}
]
},
"performance": "Moderate",
"potential": "Moderate",
"data": [
{
"field": "Team engagement",
"value": "High"
}
]
}
Comments
Article is closed for comments.