Skip to content
API Reference
/
catalog
/
catalog_search_programs_create

ibl-data-manager (3.59.0-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

career

Operations

catalog

Operations

catalog_roles_reported_create

Request

Add or update reported roles for a user.

Security
PlatformApiKeyAuthentication
Query
user_idinteger

User ID

usernamestringnon-empty

Username

Body
required
user_idinteger

User ID

usernamestring

Username

rolesArray of objectsrequired

List of roles (can be role IDs or objects with name, platform_key, etc.)

roles[].​property name*anyadditional property
dataany

Additional data

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

Responses

Bodyapplication/json
user_idinteger
usernamestring
rolesArray of objects(Role)required
roles[].​idintegerread-onlyrequired
roles[].​namestring or nullread-onlyrequired

The display name of the role.

roles[].​slugstring or nullread-onlyrequired

An additional unique slug field.

roles[].​platform_keystring
roles[].​skillsArray of objects(Skill)required
roles[].​skills[].​idintegerread-onlyrequired
roles[].​skills[].​namestring or nullread-onlyrequired

Display name

roles[].​skills[].​platform_keystring
roles[].​skills[].​slugstring or null^[-a-zA-Z0-9_]+$read-onlyrequired

An additional unique slug field. (Optional)

roles[].​skills[].​dataany or nullread-onlyrequired

Metadata

roles[].​dataany or nullread-onlyrequired

Metadata

dataany or nullread-onlyrequired
Response
application/json
{
  "user_id": 0,
  "username": "string",
  "roles": [
    { … }
  ],
  "data": null
}

catalog_search_programs_create

Request

POST Retrieve programs matching query.

Params: query: The search term used to filter programs. org: The organization to which the programs belong.

Returns: A JSON response containing a list of programs that match the search criteria.

Error Conditions:

  • If the request data is malformed or missing required fields, a 400 Bad Request may be returned.
  • If there is an issue with the database query, a 500 Internal Server Error may be returned.

Side Effects:

  • None

Special Return Codes:

  • A 200 status code indicates successful retrieval of programs matching the query.
Security
PlatformApiKeyAuthentication
Query
orgstringnon-empty

The organization to which the programs belong

querystringnon-empty

The search term used to filter programs

Default ""
Body
required
course_listArray of objects(ProgramCoursePosition)required
course_list[].​course_idstring
course_list[].​namestring
course_list[].​slugstring
program_idstring<= 255 charactersrequired

A unique program ID identifiable by edX.

namestring<= 255 characters

The verbose name of the program.

enabledboolean

Select if this program should be enabled.

slugstring or null<= 255 characters^[-a-zA-Z0-9_]+$

An additional unique slug field. (Optional)

orgstring
dataany or null

Metadata

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/search/programs/?org=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "course_list": [
      {
        "course_id": "string",
        "name": "string",
        "slug": "string"
      }
    ],
    "program_id": "string",
    "name": "string",
    "enabled": true,
    "slug": "string",
    "org": "string",
    "data": null
  }'

Responses

Bodyapplication/json
course_listArray of objects(ProgramCoursePosition)required
course_list[].​course_idstring
course_list[].​namestring
course_list[].​slugstring
course_list[].​positionintegerread-onlyrequired
program_idstring<= 255 charactersrequired

A unique program ID identifiable by edX.

program_keystringread-onlyrequired
namestring<= 255 characters

The verbose name of the program.

enabledboolean

Select if this program should be enabled.

slugstring or null<= 255 characters^[-a-zA-Z0-9_]+$

An additional unique slug field. (Optional)

orgstring
platform_keystringread-onlyrequired
program_typestringread-onlyrequired
dataany or null

Metadata

Response
application/json
{
  "course_list": [
    { … }
  ],
  "program_id": "string",
  "program_key": "string",
  "name": "string",
  "enabled": true,
  "slug": "string",
  "org": "string",
  "platform_key": "string",
  "program_type": "string",
  "data": null
}

catalog_skills_retrieve

Request

Retrieve skills matching query. Limited parameters.

Security
PlatformApiKeyAuthentication
Query
idinteger

Skill ID

namestringnon-empty

Skill name

name__iexactstringnon-empty

Exact match for skill name (case insensitive)

pageinteger

Page number for pagination

page_sizeinteger

Number of items per page

platform_keystringnon-empty

Platform key

slugstringnon-empty

Skill slug

sortstringnon-empty

Field to sort results by

Default "id"
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/skills/?id=0&name=string&name__iexact=string&page=0&page_size=0&platform_key=string&slug=string&sort=id' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
next_pagestringrequired
previous_pagestringrequired
resultsArray of objects(Skill)read-onlyrequired
results[].​idintegerread-onlyrequired
results[].​namestring or nullread-onlyrequired

Display name

results[].​platform_keystring
results[].​slugstring or null^[-a-zA-Z0-9_]+$read-onlyrequired

An additional unique slug field. (Optional)

results[].​dataany or nullread-onlyrequired

Metadata

countintegerread-onlyrequired
Response
application/json
{
  "next_page": "string",
  "previous_page": "string",
  "results": [
    { … }
  ],
  "count": 0
}

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

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