Skip to content
API Reference
/
catalog
/
catalog_milestones_completions_resource_manage_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_milestones_completions_program_query_retrieve

Request

Retrieve program completion information

Security
PlatformApiKeyAuthentication
Query
program_keystringnon-emptyrequired

The unique identifier for the program

user_idinteger

The user identifier (either user_id or username required)

usernamestringnon-empty

The username (either user_id or username required)

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

Responses

Bodyapplication/json
countintegerrequired

Total number of courses in the program

completion_percentagenumber(double)required

Overall completion percentage for the program (0.0 to 1.0)

Response
application/json
{
  "count": 0,
  "completion_percentage": 0.1
}

catalog_milestones_completions_resource_manage_retrieve

Request

Retrieve completion info for resource/user

Security
PlatformApiKeyAuthentication
Query
resource_idintegerrequired

The unique identifier for the resource

user_idintegerrequired

The ID of the user

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/milestones/completions/resource/manage/?resource_id=0&user_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
completion_percentagenumber or null(double)

Completion percentage

completedboolean or null

Whether completable is completed

Default false
last_updatedstring(date-time)read-onlyrequired

Last update timestamp

completion_datestring or null(date-time)

Completion timestamp

completion_dataany or null

Completion metadata

skill_points_computedboolean or null

Whether skill points have been evaluated

Default false
resource_idintegerrequired

The unique identifier for the resource

resource_typestringrequired

The type of resource

user_idintegerrequired

The user identifier

usernamestringread-onlyrequired

The username associated with the completion

Response
application/json
{
  "completion_percentage": 0.1,
  "completed": false,
  "last_updated": "2019-08-24T14:15:22Z",
  "completion_date": "2019-08-24T14:15:22Z",
  "completion_data": null,
  "skill_points_computed": false,
  "resource_id": 0,
  "resource_type": "string",
  "user_id": 0,
  "username": "string"
}

catalog_milestones_completions_resource_manage_create

Request

Create or update completion information for a specific resource and user

Security
PlatformApiKeyAuthentication
Query
resource_idintegerrequired

The unique identifier for the resource

user_idintegerrequired

The ID of the user

Body
required
resource_idintegerrequired

The unique identifier for the resource

user_idintegerrequired

The ID of the user

completedboolean

Whether the resource is completed

completion_percentagenumber or null(double)

Percentage of completion (0.0-1.0)

completion_datestring or null(date-time)

When the resource was completed

completion_dataany

Additional completion metadata

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/milestones/completions/resource/manage/?resource_id=0&user_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "resource_id": 0,
    "user_id": 0,
    "completed": true,
    "completion_percentage": 0.1,
    "completion_date": "2019-08-24T14:15:22Z",
    "completion_data": null
  }'

Responses

Bodyapplication/json
completion_percentagenumber or null(double)

Completion percentage

completedboolean or null

Whether completable is completed

Default false
last_updatedstring(date-time)read-onlyrequired

Last update timestamp

completion_datestring or null(date-time)

Completion timestamp

completion_dataany or null

Completion metadata

skill_points_computedboolean or null

Whether skill points have been evaluated

Default false
resource_idintegerrequired

The unique identifier for the resource

resource_typestringrequired

The type of resource

user_idintegerrequired

The user identifier

usernamestringread-onlyrequired

The username associated with the completion

Response
application/json
{
  "completion_percentage": 0.1,
  "completed": false,
  "last_updated": "2019-08-24T14:15:22Z",
  "completion_date": "2019-08-24T14:15:22Z",
  "completion_data": null,
  "skill_points_computed": false,
  "resource_id": 0,
  "resource_type": "string",
  "user_id": 0,
  "username": "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