Skip to content
API Reference
/
catalog
/
catalog_metadata_program_retrieve

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_metadata_course_create_2

Request

Update metadata for a course.

Security
PlatformApiKeyAuthentication
Path
fieldstring^\w+$required
Query
course_idstringnon-emptyrequired

The course ID to get metadata for

Body
required
course_idstringrequired

The course ID to update metadata for

metadataanyrequired

The metadata to update

updateboolean

Whether to update (True) or overwrite (False) existing metadata

Default true
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/metadata/course/{field}/?course_id=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "course_id": "string",
    "metadata": null,
    "update": true
  }'

Responses

No response body

catalog_metadata_program_retrieve

Request

Retrieve metadata for a specified program

Security
PlatformApiKeyAuthentication
Query
orgstringnon-empty

The organization associated with the program

platform_keystringnon-empty

Platform key identifier (alternative to org)

program_idstringnon-emptyrequired

The unique identifier for the program

program_keystringnon-empty

Program key (alternative to program_id + org)

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/metadata/program/?org=string&platform_key=string&program_id=string&program_key=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
namestring or null

Program name

descriptionstring or null

Program description

enabledboolean or null

Whether the program is enabled

slugstring or null

Program slug

skillsArray of strings

List of associated skills

platform_keystring or null

Platform key

Response
application/json
{
  "name": "string",
  "description": "string",
  "enabled": true,
  "slug": "string",
  "skills": [
    "string"
  ],
  "platform_key": "string"
}

catalog_metadata_program_create

Request

Update metadata for a specified program

Security
PlatformApiKeyAuthentication
Query
orgstringnon-empty

The organization associated with the program

platform_keystringnon-empty

Platform key identifier (alternative to org)

program_idstringnon-emptyrequired

The unique identifier for the program

program_keystringnon-empty

Program key (alternative to program_id + org)

Body
required
program_idstringrequired

The unique identifier for the program

orgstring

The organization associated with the program

platform_keystring

Platform key identifier (alternative to org)

program_keystring

Program key (alternative to program_id + org)

metadataobjectrequired

Metadata to update for the program

metadata.​property name*anyadditional property
updateboolean

Whether to update existing metadata

Default true
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/metadata/program/?org=string&platform_key=string&program_id=string&program_key=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "program_id": "string",
    "org": "string",
    "platform_key": "string",
    "program_key": "string",
    "metadata": {
      "property1": null,
      "property2": null
    },
    "update": true
  }'

Responses

Bodyapplication/json
namestring or null

Program name

descriptionstring or null

Program description

enabledboolean or null

Whether the program is enabled

slugstring or null

Program slug

skillsArray of strings

List of associated skills

platform_keystring or null

Platform key

Response
application/json
{
  "name": "string",
  "description": "string",
  "enabled": true,
  "slug": "string",
  "skills": [
    "string"
  ],
  "platform_key": "string"
}

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