catalog_suggestions_pathway_user

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

career

Operations

catalog

Operations

catalog_suggestions_pathway_manage_group_destroy

Request

API View for managing pathway group suggestions.

This endpoint allows administrators to view, create, and delete pathway suggestions for groups of users within a platform.

Query Parameters (GET): platform_key (str, required): The platform to retrieve group suggestions for platform_org (str, optional): The organization identifier for the platform query (str, optional): Search term to filter group suggestions sort (str, optional): Field to sort results by (default: 'id') department_mode (bool, optional): Filter suggestions by department admin access page (int, optional): Page number for pagination page_size (int, optional): Number of items per page

Methods: GET: Retrieve a paginated list of pathway group suggestions for a platform POST: Create or update a pathway group suggestion DELETE: Remove a pathway group suggestion

Request Body (POST): A JSON object containing:

platform_key (str, required): The platform for the group suggestion
pathway_id (str, required): The pathway ID to suggest
group_id (str/int, required): The group to suggest the pathway to
accepted (bool, optional): Whether the suggestion is accepted
visible (bool, optional): Whether the suggestion is visible
metadata (dict, optional): Additional suggestion metadata

Query Parameters (DELETE): suggestion_id (int, required): The ID of the group suggestion to delete

Returns: GET: A paginated JSON response containing pathway group suggestions: { "count": 5, "next": "https://example.com/api/catalog/suggestions/pathway/group/?page=2", "previous": null, "results": [ { "id": 123, "group_id": 789, "group_name": "Engineering Team", "platform_key": "platform1", "accepted": false, "visible": true, "created": "2023-06-15T14:30:00Z", "modified": "2023-06-15T14:30:00Z", "metadata": {}, "pathway_id": "pathway-v1:org+pathway+run", "pathway_uuid": "12345678-1234-5678-1234-567812345678", "pathway_name": "Data Science Pathway", "pathway_platform_key": "platform1", "user_count": 25 }, ... ] }

POST: A JSON response containing the created/updated group suggestion: { "id": 123, "group_id": 789, "group_name": "Engineering Team", "platform_key": "platform1", "accepted": false, "visible": true, "created": "2023-06-15T14:30:00Z", "modified": "2023-06-15T14:30:00Z", "metadata": {}, "pathway_id": "pathway-v1:org+pathway+run", "pathway_uuid": "12345678-1234-5678-1234-567812345678", "pathway_name": "Data Science Pathway", "pathway_platform_key": "platform1", "user_count": 25 }

DELETE: A success response with status 200

Error Responses: 400 Bad Request: If required parameters are missing or invalid, or if group suggestion operations fail 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to manage group suggestions 500 Internal Server Error: If an unexpected error occurs

Access Control:

Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
Platform admins can manage group suggestions for their platform
Department admins can manage group suggestions for their departments
DM admins can manage all group suggestions

Security

PlatformApiKeyAuthentication

Query

department_modeboolean

Flag to ensure department admins can call the API

Default false

pageinteger

Page number for pagination

page_sizeinteger

Number of items per page

platform_keystringnon-emptyrequired

The platform to retrieve group suggestions for

platform_orgstringnon-empty

The organization identifier for the platform

querystringnon-empty

Search term to filter group suggestions

sortstringnon-empty

Field to sort results by

Default "id"

suggestion_idintegerrequired

The ID of the group suggestion to delete

curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/suggestions/pathway/manage/group/?department_mode=false&page=0&page_size=0&platform_key=string&platform_org=string&query=string&sort=id&suggestion_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success - group suggestion deleted

catalog_suggestions_pathway_user_retrieve

Request

API View for retrieving pathway suggestions for a specific user.

This endpoint allows users to view pathway suggestions that have been made for them, with support for filtering by platform and pagination.

Query Parameters: user (str, required): Username or user ID to retrieve suggestions for platform_key (str, optional): Filter suggestions by platform key platform_org (str, optional): Filter suggestions by platform organization sort (str, optional): Field to sort results by (default: '-id') page (int, optional): Page number for pagination page_size (int, optional): Number of items per page

Methods: GET: Retrieve a paginated list of pathway suggestions for a user

Returns: GET: A paginated JSON response containing pathway suggestions: { "count": 10, "next": "https://example.com/api/catalog/suggestions/pathway/user/?page=2", "previous": null, "results": [ { "id": 123, "user_id": 456, "username": "student1", "name": "Student Name", "platform_key": "platform1", "accepted": false, "visible": true, "created": "2023-06-15T14:30:00Z", "modified": "2023-06-15T14:30:00Z", "metadata": {}, "pathway_id": "pathway-v1:org+pathway+run", "pathway_uuid": "12345678-1234-5678-1234-567812345678", "pathway_name": "Data Science Pathway", "pathway_platform_key": "platform1" }, ... ] }

Error Responses: 400 Bad Request: If required parameters are missing or invalid, or if suggestion retrieval fails 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to access this resource 500 Internal Server Error: If an unexpected error occurs

Access Control:

Requires IsDMAdmin, IsPlatformAdminReadOnly, or IsEdxUserReadOnly permission
Users can view their own suggestions
Platform admins can view suggestions for users in their platform (read-only)
DM admins can view all suggestions

Security

PlatformApiKeyAuthentication

Query

emailstring(email)non-empty

Email to retrieve suggestions for

pageinteger

Page number for pagination

page_sizeinteger

Number of items per page

platform_keystringnon-empty

Filter suggestions by platform key

platform_orgstringnon-empty

Filter suggestions by platform organization

sortstringnon-empty

Field to sort results by

Default "-id"

user_idinteger

User ID to retrieve suggestions for

usernamestringnon-emptyrequired

Username or user ID to retrieve suggestions for

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/suggestions/pathway/user/?email=user%40example.com&page=0&page_size=0&platform_key=string&platform_org=string&sort=-id&user_id=0&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

countintegerrequired

Total number of results

next_pagestring or null(uri)required

URL for next page of results

previous_pagestring or null(uri)required

URL for previous page of results

resultsArray of objects(PathwaySuggestionDetail)required

List of pathway suggestions

results[].idintegerrequired

The unique identifier for the suggestion

results[].user_idintegerrequired

The ID of the user receiving the suggestion

results[].usernamestringrequired

The username of the user receiving the suggestion

results[].namestringrequired

The full name of the user receiving the suggestion

results[].platform_keystringrequired

The platform key associated with the suggestion

results[].acceptedbooleanrequired

Whether the suggestion has been accepted by the user

results[].visiblebooleanrequired

Whether the suggestion is visible to the user

results[].createdstring(date-time)required

When the suggestion was created

results[].modifiedstring(date-time)required

When the suggestion was last modified

results[].metadataobjectrequired

Additional metadata for the suggestion

results[].metadata.property name*anyadditional property

results[].pathway_idstringrequired

The pathway ID being suggested

results[].pathway_uuidstringrequired

The UUID of the pathway being suggested

results[].pathway_namestringrequired

The name of the pathway being suggested

results[].pathway_platform_keystringrequired

The platform key associated with the pathway

Response

application/json

{
  "count": 0,
  "next_page": "http://example.com",
  "previous_page": "http://example.com",
  "results": [
    { … }
  ]
}

catalog_suggestions_program_manage_retrieve

Request

API View for managing program suggestions.

This endpoint allows administrators to view, create, update, and delete program suggestions for users within a platform.

Query Parameters (GET): platform_key (str, required): The platform to retrieve suggestions for platform_org (str, optional): The organization identifier for the platform query (str, optional): Search term to filter suggestions sort (str, optional): Field to sort results by (default: '-id') department_mode (bool, optional): Filter suggestions by department admin access page (int, optional): Page number for pagination page_size (int, optional): Number of items per page

Methods: GET: Retrieve a paginated list of program suggestions for a platform POST: Create or update a program suggestion DELETE: Remove a program suggestion

Request Body (POST): A JSON object containing:

platform_key (str, required): The platform for the suggestion
program_key (str, required): The program key to suggest
user_id (str/int, required): The user to suggest the program to
accepted (bool, optional): Whether the suggestion is accepted
visible (bool, optional): Whether the suggestion is visible
metadata (dict, optional): Additional suggestion metadata

Query Parameters (DELETE): suggestion_id (int, required): The ID of the suggestion to delete

Returns: GET: A paginated JSON response containing program suggestions: { "count": 10, "next": "https://example.com/api/catalog/suggestions/program/manage/?page=2", "previous": null, "results": [ { "id": 123, "user_id": 456, "username": "student1", "name": "Student Name", "platform_key": "platform1", "accepted": false, "visible": true, "created": "2023-06-15T14:30:00Z", "modified": "2023-06-15T14:30:00Z", "metadata": {}, "program_key": "program-v1:org+program+run", "program_name": "Data Science Program" }, ... ] }

POST: A JSON response containing the created/updated suggestion: { "id": 123, "user_id": 456, "username": "student1", "name": "Student Name", "platform_key": "platform1", "accepted": false, "visible": true, "created": "2023-06-15T14:30:00Z", "modified": "2023-06-15T14:30:00Z", "metadata": {}, "program_key": "program-v1:org+program+run", "program_name": "Data Science Program" }

DELETE: A success response with status 200

Error Responses: 400 Bad Request: If required parameters are missing or invalid, or if suggestion operations fail 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to manage suggestions 500 Internal Server Error: If an unexpected error occurs

Access Control:

Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
Platform admins can manage suggestions for their platform
Department admins can manage suggestions for their departments
DM admins can manage all suggestions

Security

PlatformApiKeyAuthentication

Query

department_modeboolean

Filter suggestions by department admin access

pageinteger

Page number for pagination

page_sizeinteger

Number of items per page

platform_keystringnon-emptyrequired

The platform to retrieve suggestions for

platform_orgstringnon-empty

The organization identifier for the platform

querystringnon-empty

Search term to filter suggestions

sortstringnon-empty

Field to sort results by

Default "-id"

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/suggestions/program/manage/?department_mode=true&page=0&page_size=0&platform_key=string&platform_org=string&query=string&sort=-id' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

countintegerrequired

Total number of results

next_pagestring or null(uri)required

URL for next page of results

previous_pagestring or null(uri)required

URL for previous page of results

resultsArray of objects(ProgramSuggestionDetail)required

List of program suggestions

results[].idintegerrequired

The unique identifier for the suggestion

results[].user_idintegerrequired

The ID of the user receiving the suggestion

results[].usernamestringrequired

The username of the user receiving the suggestion

results[].namestringrequired

The full name of the user receiving the suggestion

results[].platform_keystringrequired

The platform key associated with the suggestion

results[].acceptedbooleanrequired

Whether the suggestion has been accepted by the user

results[].visiblebooleanrequired

Whether the suggestion is visible to the user

results[].createdstring(date-time)required

When the suggestion was created

results[].modifiedstring(date-time)required

When the suggestion was last modified

results[].metadataobjectrequired

Additional metadata for the suggestion

results[].metadata.property name*anyadditional property

results[].program_keystringrequired

The program key being suggested

results[].program_namestringrequired

The name of the program being suggested

Response

application/json

{
  "count": 0,
  "next_page": "http://example.com",
  "previous_page": "http://example.com",
  "results": [
    { … }
  ]
}

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

search

Operations

skills

Operations

ibl-data-manager (3.59.0-ai-plus)

ai-account

ai-analytics

ai-bot

ai-finetuning

ai-index

ai-marketing

ai-media

ai-mentor

ai-prompt

career

catalog

catalog_suggestions_pathway_manage_group_destroy

Request

Responses

Was this helpful?

catalog_suggestions_pathway_user_retrieve

Request

Responses

Was this helpful?

catalog_suggestions_program_manage_retrieve

Request

Responses

Was this helpful?

core

credentials

features

media

notifications

scim

commerce

recommendations

reports

search

skills