Getting a List of Assigned Development Plans
POST /api/v3/developmentplan/v1/enrolled-plans
Permissions to Run the Request
Account Owner and Account Administrators
Request Headers and Parameters
| Header | Description |
|---|---|
| Authorization (required) | Access token. You can obtain a token by making a request. |
| Content-Type: application/json (required) | Property for processing a request in JSON |
| Accept: application/json (required) | Property for processing a request in JSON |
| Parameter | Description |
| pageSize | Number of records returned per request |
| pageToken | Token for retrieving the next page of results |
| ids | Development plan IDs |
| typeIds | Development plan type IDs |
| employeeIds | IDs of users who have been assigned development plans |
| mentorIds | Mentor IDs |
| startDateFrom | Start date of the period for filtering development plans by their scheduled start date |
| startDateTo | End date of the period for filtering development plans by their scheduled start date |
| endDateFrom | Start date of the period for filtering development plans by their scheduled completion date |
| endDateTo | End date of the period for filtering development plans by their scheduled completion date |
| statuses [] | Development plan statuses:
|
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| items[] | Array of objects | List of assigned development plans |
| nextPageToken | string | Token for retrieving the next page of results |
Elements of items[] array
| Parameter | Type | Description |
|---|---|---|
| id | string (UUID) | Development plan ID |
| title | string | Development plan name |
| typeId | string (UUID) | Development plan type ID |
| employeeId | string (UUID) | ID of the user who has been assigned the development plan |
| mentorId | string (UUID) | Mentor ID |
| startDate | string (date) | Scheduled start date of the development plan |
| endDate | string (date) | Scheduled completion date of the development plan |
| status | string | Development plan status:
|
| progress [] | object | Information about the development plan progress |
| decision [] | object | Information about the development plan result |
progress object
| Parameter | Type | Description |
|---|---|---|
| completedTasksCount | integer | Number of completed tasks |
| totalTasksCount | integer | Total number of tasks in the development plan |
Response Codes
| Code | Text | Description |
|---|---|---|
| 200 | ОК | The request has been successfully processed |
| 400 | Bad Request | The request contains invalid parameters or has an invalid format |
| 401 | Unauthorized | Authorization failed. The access token is missing, invalid, or expired. |
| 403 | Permission Denied | No permission to run this request. Only the Account Owner and Account Administrators can run this request. |
Sample Response
{
"items": [
{
"id": "f01048c8-d387-af10-d8f8-6d43d98ce6dd",
"title": "string",
"typeId": "64bdab4c-e35a-7304-c8d0-c45bac8b9a58",
"employeeId": "1edea4f4-110f-c1ac-3e07-6ed64cff0b76",
"mentorId": "a4053e97-99d8-c6d5-695f-9fa3a8c9771f",
"startDate": "1961-01-23",
"endDate": "1956-04-05",
"status": "IN_PROGRESS",
"progress": {
"completedTasksCount": 3663,
"totalTasksCount": 5208
},
"decision": {
"title": "string",
"value": "ACCEPTED"
}
},
{
"id": "1920e65d-64c7-b36d-ee30-190541de3587",
"title": "string",
"typeId": "8d7e430b-4ab4-21c1-8413-40e358c04951",
"employeeId": "d0f7e495-7c70-61ad-721d-837032ad6b0e",
"mentorId": "07ab5e2f-c3b5-d1c7-4f0d-be954dd03b0e",
"startDate": "1979-07-18",
"endDate": "2015-09-12",
"status": "WAITING_DECISION",
"progress": {
"completedTasksCount": 3916,
"totalTasksCount": 6379
},
"decision": {
"title": "string",
"value": "ACCEPTED"
}
}
],
"nextPageToken": "string"
}
CODE