Skip to content

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
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

career_orgs_education_users_update

Request

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
usernamestringrequired
Bodyrequired
institution_idintegerwrite-onlyrequired
degreestring or null<= 100 characters
field_of_studystring or null<= 100 characters
start_datestring(date)required
end_datestring or null(date)
gradestring or null(decimal)^-?\d{0,1}(?:\.\d{0,2})?$
activitiesstring or null<= 255 characters
descriptionstring or null
dataany or null

Metadata

metadataany or null

Metadata

created_atstring(date-time)
is_currentboolean or null
curl -i -X PUT \
  'https://docs.ibl.ai/_mock/apis/ibl/api/career/orgs/{org}/education/users/{username}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "institution_id": 0,
    "degree": "string",
    "field_of_study": "string",
    "start_date": "2019-08-24",
    "end_date": "2019-08-24",
    "grade": "string",
    "activities": "string",
    "description": "string",
    "data": null,
    "metadata": null,
    "created_at": "2019-08-24T14:15:22Z",
    "is_current": true
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
userinteger[ 0 .. 2147483647 ]read-onlyrequired

edX user ID

user_infoobjectread-onlyrequired
user_info.​idinteger[ 0 .. 2147483647 ]required

edX user ID

user_info.​usernamestring or null<= 100 characters

edX username

user_info.​emailstring(email)required
user_info.​activebooleanrequired
user_info.​edx_dataanyrequired
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
degreestring or null<= 100 characters
field_of_studystring or null<= 100 characters
start_datestring(date)required
end_datestring or null(date)
gradestring or null(decimal)^-?\d{0,1}(?:\.\d{0,2})?$
activitiesstring or null<= 255 characters
descriptionstring or null
dataany or null

Metadata

metadataany or null

Metadata

created_atstring(date-time)
updated_atstring(date-time)read-onlyrequired
is_currentboolean or null
Response
application/json
{ "id": 0, "user": 2147483647, "user_info": { "id": 2147483647, "username": "string", "email": "user@example.com", "active": true, "edx_data": null }, "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" }, "degree": "string", "field_of_study": "string", "start_date": "2019-08-24", "end_date": "2019-08-24", "grade": "string", "activities": "string", "description": "string", "data": null, "metadata": null, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "is_current": true }

career_orgs_education_users_destroy

Request

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
usernamestringrequired
curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/career/orgs/{org}/education/users/{username}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

career_orgs_experience_users_retrieve

Request

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
usernamestringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/career/orgs/{org}/experience/users/{username}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idintegerread-onlyrequired
userinteger[ 0 .. 2147483647 ]read-onlyrequired

edX user ID

user_infoobjectread-onlyrequired
user_info.​idinteger[ 0 .. 2147483647 ]required

edX user ID

user_info.​usernamestring or null<= 100 characters

edX username

user_info.​emailstring(email)required
user_info.​activebooleanrequired
user_info.​edx_dataanyrequired
companyobjectread-onlyrequired
company.​idintegerread-onlyrequired
company.​userinteger[ 0 .. 2147483647 ]read-onlyrequired

edX user ID

company.​user_infoobjectread-onlyrequired
company.​user_info.​idinteger[ 0 .. 2147483647 ]required

edX user ID

company.​user_info.​usernamestring or null<= 100 characters

edX username

company.​user_info.​emailstring(email)required
company.​user_info.​activebooleanrequired
company.​user_info.​edx_dataanyrequired
company.​namestring<= 100 charactersrequired
company.​industrystring or null<= 100 characters
company.​websitestring or null(uri)<= 255 characters
company.​logo_urlstring or null(uri)<= 255 characters
company.​dataany or null

Metadata

company.​metadataany or null

Metadata

company.​created_atstring(date-time)
company.​updated_atstring(date-time)read-onlyrequired
titlestring<= 100 charactersrequired
employment_typestring or null<= 50 characters
locationstring or null<= 100 characters
start_datestring(date)required
end_datestring or null(date)
is_currentboolean
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, "user": 2147483647, "user_info": { "id": 2147483647, "username": "string", "email": "user@example.com", "active": true, "edx_data": null }, "company": { "id": 0, "user": 2147483647, "user_info": {}, "name": "string", "industry": "string", "website": "http://example.com", "logo_url": "http://example.com", "data": null, "metadata": null, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }, "title": "string", "employment_type": "string", "location": "string", "start_date": "2019-08-24", "end_date": "2019-08-24", "is_current": true, "description": "string", "data": null, "metadata": null, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations