Skip to content
API Reference
/
catalog
/
catalog_programs_list

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_pathways_destroy

Request

Remove a pathway from the database.

Security
PlatformApiKeyAuthentication
Query
item_idstringnon-empty

Item ID associated with the pathway

namestringnon-empty

Pathway name

pathway_idstringnon-emptyrequired

Pathway ID to delete

pathway_uuidstringnon-empty

Pathway UUID

platform_keystringnon-empty

Platform key

slugstringnon-empty

Pathway slug (case-insensitive)

user_idintegerrequired

User ID of the pathway owner

usernamestringnon-empty

Username of the pathway owner

visibleboolean

Whether the pathway is visible

curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/pathways/?item_id=string&name=string&pathway_id=string&pathway_uuid=string&platform_key=string&slug=string&user_id=0&username=string&visible=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired

Number of pathways deleted

typeobjectrequired

Types of objects deleted

type.​property name*anyadditional property
Response
application/json
{
  "count": 0,
  "type": {
    "property1": null,
    "property2": null
  }
}

catalog_programs_list

Request

Retrieve programs matching query parameters. Limited parameters include program_id, name, slug, enabled, and org.

Security
PlatformApiKeyAuthentication
Query
course_idstringnon-empty

Course ID contained in the program

enabledboolean

Whether the program is enabled

namestringnon-empty

Program name

orgstringnon-empty

Organization of the program

program_idstringnon-empty

Program ID

slugstringnon-empty

Program slug (case-insensitive)

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/programs/?course_id=string&enabled=true&name=string&org=string&program_id=string&slug=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
idintegerread-onlyrequired
institutionobjectread-onlyrequired
institution.​idintegerread-onlyrequired
institution.​namestring<= 100 charactersrequired
institution.​institution_typestring(InstitutionTypeEnum)
  • university - University
  • college - College
  • institute - Institute
  • academy - Academy
  • other - Other
Enum"university""college""institute""academy""other"
institution.​locationstring or null<= 100 characters
institution.​websitestring or null(uri)<= 255 characters
institution.​accreditationstring or null<= 100 characters
institution.​established_yearinteger or null[ 0 .. 2147483647 ]
institution.​dataany or null

Metadata

institution.​metadataany or null

Metadata

institution.​created_atstring(date-time)
institution.​updated_atstring(date-time)read-onlyrequired
namestring<= 100 charactersrequired
program_typestring(ProgramTypeEnum)required
  • bachelors - Bachelor's Degree
  • masters - Master's Degree
  • phd - PhD
  • diploma - Diploma
  • certificate - Certificate
  • ungraded - Ungraded
  • other - Other
Enum"bachelors""masters""phd""diploma""certificate""ungraded""other"
durationinteger[ 0 .. 2147483647 ]required

Duration in months

descriptionstring or null
dataany or null

Metadata

metadataany or null

Metadata

created_atstring(date-time)
updated_atstring(date-time)read-onlyrequired
]
Response
application/json
[
  {
    "id": 0,
    "institution": { … },
    "name": "string",
    "program_type": "bachelors",
    "duration": 2147483647,
    "description": "string",
    "data": null,
    "metadata": null,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]

catalog_programs_create

Request

Add or update a program. Accepts a list of courses and updates or creates a program.

Security
PlatformApiKeyAuthentication
Body
required
program_idstringrequired

Program ID

program_keystring

Program key

namestringrequired

Program name

slugstring

Program slug

orgstring

Organization

platform_keystring

Platform key

enabledboolean

Whether the program is enabled

Default true
course_listArray of objectsrequired

List of courses in the program with course_id and optional position

course_list[].​property name*anyadditional property
program_typestring

Program type

dataany

Additional program data

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

Responses

Bodyapplication/json
idintegerread-onlyrequired
institutionobjectread-onlyrequired
institution.​idintegerread-onlyrequired
institution.​namestring<= 100 charactersrequired
institution.​institution_typestring(InstitutionTypeEnum)
  • university - University
  • college - College
  • institute - Institute
  • academy - Academy
  • other - Other
Enum"university""college""institute""academy""other"
institution.​locationstring or null<= 100 characters
institution.​websitestring or null(uri)<= 255 characters
institution.​accreditationstring or null<= 100 characters
institution.​established_yearinteger or null[ 0 .. 2147483647 ]
institution.​dataany or null

Metadata

institution.​metadataany or null

Metadata

institution.​created_atstring(date-time)
institution.​updated_atstring(date-time)read-onlyrequired
namestring<= 100 charactersrequired
program_typestring(ProgramTypeEnum)required
  • bachelors - Bachelor's Degree
  • masters - Master's Degree
  • phd - PhD
  • diploma - Diploma
  • certificate - Certificate
  • ungraded - Ungraded
  • other - Other
Enum"bachelors""masters""phd""diploma""certificate""ungraded""other"
durationinteger[ 0 .. 2147483647 ]required

Duration in months

descriptionstring or null
dataany or null

Metadata

metadataany or null

Metadata

created_atstring(date-time)
updated_atstring(date-time)read-onlyrequired
Response
application/json
{
  "id": 0,
  "institution": {
    "id": 0,
    "name": "string",
    "institution_type": "university",
    "location": "string",
    "website": "http://example.com",
    "accreditation": "string",
    "established_year": 2147483647,
    "data": null,
    "metadata": null,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "name": "string",
  "program_type": "bachelors",
  "duration": 2147483647,
  "description": "string",
  "data": null,
  "metadata": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

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