Skip to content
API Reference/
/
catalog_skills_reported_c...

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

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server
https://docs.ibl.ai/_mock/apis/ibl/
https://base.manager.iblai.app/

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

analytics

Operations

career

Operations

catalog

Operations

catalog_skills_reported_retrieve

Request

Retrieve reported skills for a user.

Security
PlatformApiKeyAuthentication
Query
user_idinteger

User ID

usernamestringnon-empty

Username

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/skills/reported/?user_id=0&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
user_idinteger
usernamestring
skillsArray of objects(Skill)required
skills[].​skill_idintegerrequired
skills[].​namestring or null
skills[].​slugstring or null
skills[].​platformstring or null
dataany or nullread-onlyrequired
Response
application/json
{
  "user_id": 0,
  "username": "string",
  "skills": [
    { … }
  ],
  "data": null
}

catalog_skills_reported_create

Request

Add or update reported skills for a user.

Security
PlatformApiKeyAuthentication
Query
user_idinteger

User ID

usernamestringnon-empty

Username

Body
required
user_idinteger

User ID

usernamestring

Username

skillsArray of objectsrequired

List of skills (can be skill IDs or objects with name, platform_key, etc.)

skills[].​property name*anyadditional property
dataany

Additional data

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/skills/reported/?user_id=0&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_id": 0,
    "username": "string",
    "skills": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "data": null
  }'

Responses

Bodyapplication/json
user_idinteger
usernamestring
skillsArray of objects(Skill)required
skills[].​skill_idintegerrequired
skills[].​namestring or null
skills[].​slugstring or null
skills[].​platformstring or null
dataany or nullread-onlyrequired
Response
application/json
{
  "user_id": 0,
  "username": "string",
  "skills": [
    { … }
  ],
  "data": null
}

catalog_suggestions_course_manage_retrieve

Request

API View for managing course suggestions.

This endpoint allows administrators to view, create, update, and delete course 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 course suggestions for a platform POST: Create or update a course suggestion DELETE: Remove a course suggestion

Request Body (POST): A JSON object containing:

  • platform_key (str, required): The platform for the suggestion
  • course_id (str, required): The course ID to suggest
  • user_id (str/int, required): The user to suggest the course 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 course suggestions: { "count": 10, "next": "https://example.com/api/catalog/suggestions/course/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": {}, "course_id": "course-v1:org+course+run", "course_name": "Introduction to Programming" }, ... ] }

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": {}, "course_id": "course-v1:org+course+run", "course_name": "Introduction to Programming" }

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/course/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(CourseSuggestionDetail)required

List of course 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[].​course_idstringrequired

The course ID being suggested

results[].​course_namestringrequired

The name of the course being suggested

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

core

Operations

credentials

Operations

custom-domains

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com