Skip to content
API Reference
/
catalog
/
catalog_enrollment_pathways_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_enrollment_pathways_retrieve

Request

Search pathway enrollments. Requires user_id or username and pathway_id or slug.

Security
PlatformApiKeyAuthentication
Query
activeboolean

Whether the enrollment should be active

Default true
include_default_platformboolean

Include enrollments from default platform

include_metadataboolean

Include metadata in the response

Default true
orgstringnon-empty

Organization for the pathway

pathway_idstringnon-empty

Pathway ID for enrollment

pathway_keystringnon-empty

Pathway key for enrollment

pathway_uuidstringnon-empty

Pathway UUID for enrollment

platform_keystringnon-empty

Platform key for the pathway

slugstringnon-empty

Pathway slug for enrollment

user_idstringnon-empty

User ID for enrollment

usernamestringnon-empty

Username for enrollment

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/enrollment/pathways/?active=true&include_default_platform=true&include_metadata=true&org=string&pathway_id=string&pathway_key=string&pathway_uuid=string&platform_key=string&slug=string&user_id=string&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
user_idinteger
usernamestring
pathway_idstring
pathway_uuidstring
platform_keystring
orgstring
namestring
slugstring
createdstring or null(date-time)

Date when enrollment began/activated

endedstring or null(date-time)read-onlyrequired

Date when enrollment ended/deactivated

activeboolean

Whether the enrollment is active

metadataany or null
Response
application/json
{
  "user_id": 0,
  "username": "string",
  "pathway_id": "string",
  "pathway_uuid": "string",
  "platform_key": "string",
  "org": "string",
  "name": "string",
  "slug": "string",
  "created": "2019-08-24T14:15:22Z",
  "ended": "2019-08-24T14:15:22Z",
  "active": true,
  "metadata": null
}

catalog_enrollment_pathways_create

Request

Log user enrollment with a pathway.

Security
PlatformApiKeyAuthentication
Query
activeboolean

Whether the enrollment should be active

Default true
include_default_platformboolean

Include enrollments from default platform

include_metadataboolean

Include metadata in the response

Default true
orgstringnon-empty

Organization for the pathway

pathway_idstringnon-empty

Pathway ID for enrollment

pathway_keystringnon-empty

Pathway key for enrollment

pathway_uuidstringnon-empty

Pathway UUID for enrollment

platform_keystringnon-empty

Platform key for the pathway

slugstringnon-empty

Pathway slug for enrollment

user_idstringnon-empty

User ID for enrollment

usernamestringnon-empty

Username for enrollment

Body
user_idstring

User ID for enrollment

usernamestring

Username for enrollment

pathway_idstring

Pathway ID for enrollment

pathway_uuidstring

Pathway UUID for enrollment

pathway_keystring

Pathway key for enrollment

slugstring

Pathway slug for enrollment

orgstring

Organization for the pathway

platform_keystring

Platform key for the pathway

include_default_platformboolean

Include enrollments from default platform

include_metadataboolean

Include metadata in the response

Default true
activeboolean

Whether the enrollment should be active

Default true
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/enrollment/pathways/?active=true&include_default_platform=true&include_metadata=true&org=string&pathway_id=string&pathway_key=string&pathway_uuid=string&platform_key=string&slug=string&user_id=string&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_id": "string",
    "username": "string",
    "pathway_id": "string",
    "pathway_uuid": "string",
    "pathway_key": "string",
    "slug": "string",
    "org": "string",
    "platform_key": "string",
    "include_default_platform": true,
    "include_metadata": true,
    "active": true
  }'

Responses

Bodyapplication/json
user_idinteger
usernamestring
pathway_idstring
pathway_uuidstring
platform_keystring
orgstring
namestring
slugstring
createdstring or null(date-time)

Date when enrollment began/activated

endedstring or null(date-time)read-onlyrequired

Date when enrollment ended/deactivated

activeboolean

Whether the enrollment is active

Response
application/json
{
  "user_id": 0,
  "username": "string",
  "pathway_id": "string",
  "pathway_uuid": "string",
  "platform_key": "string",
  "org": "string",
  "name": "string",
  "slug": "string",
  "created": "2019-08-24T14:15:22Z",
  "ended": "2019-08-24T14:15:22Z",
  "active": true
}

catalog_enrollment_pathways_destroy

Request

Unenroll from a pathway. Deactivates enrollment.

Security
PlatformApiKeyAuthentication
Query
activeboolean

Whether the enrollment should be active

Default true
include_default_platformboolean

Include enrollments from default platform

include_metadataboolean

Include metadata in the response

Default true
orgstringnon-empty

Organization for the pathway

pathway_idstringnon-empty

Pathway ID for enrollment

pathway_keystringnon-empty

Pathway key for enrollment

pathway_uuidstringnon-empty

Pathway UUID for enrollment

platform_keystringnon-empty

Platform key for the pathway

slugstringnon-empty

Pathway slug for enrollment

user_idstringnon-empty

User ID for enrollment

usernamestringnon-empty

Username for enrollment

curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/enrollment/pathways/?active=true&include_default_platform=true&include_metadata=true&org=string&pathway_id=string&pathway_key=string&pathway_uuid=string&platform_key=string&slug=string&user_id=string&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
user_idinteger
usernamestring
pathway_idstring
pathway_uuidstring
platform_keystring
orgstring
namestring
slugstring
createdstring or null(date-time)

Date when enrollment began/activated

endedstring or null(date-time)read-onlyrequired

Date when enrollment ended/deactivated

activeboolean

Whether the enrollment is active

Response
application/json
{
  "user_id": 0,
  "username": "string",
  "pathway_id": "string",
  "pathway_uuid": "string",
  "platform_key": "string",
  "org": "string",
  "name": "string",
  "slug": "string",
  "created": "2019-08-24T14:15:22Z",
  "ended": "2019-08-24T14:15:22Z",
  "active": true
}

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