Skip to content
API Reference/
/
ai_mentor_orgs_users_supp...

ibl-data-manager (4.84.1-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_mentor_orgs_users_support_tickets_list

Request

ViewSet for managing Human Support Tickets.

This ViewSet provides endpoints to retrieve, create, and update Human Support Tickets.

Permissions: Platform Admins:

  • Platform admins are able to update the ticket status, and view all tickets for the tenant.
  • Platform admins can only update the subject, description and status fields. Students:
  • Students are only able to view their own created tickets.
  • students can modify only the subject and description entries

Field Updates:

  • subject: Modifiable by both student and platform admin
  • description: Modifiable by only student.
  • status: Modifiable by only platform admin.
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
mentor_idnumber
pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

sessionstring(uuid)
statusstring
  • open - Open
  • in_progress - In Progress
  • closed - Closed
Enum"closed""in_progress""open"
usernamestring
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/support-tickets/?mentor_id=0&page=0&page_size=0&session=497f6eca-6276-4993-bfeb-53cbbbba6f08&status=closed&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
Example: 123
nextstring or null(uri)
Example: "http://api.example.org/accounts/?page=4"
previousstring or null(uri)
Example: "http://api.example.org/accounts/?page=2"
resultsArray of objects(HumanSupportTicket)required
results[].​idintegerread-onlyrequired
results[].​usernamestringread-onlyrequired
results[].​emailstringread-onlyrequired
results[].​full_namestringread-onlyrequired
results[].​userinteger[ 0 .. 2147483647 ]read-onlyrequired

edX user ID

results[].​sessionstring(uuid)read-onlyrequired
results[].​subjectstring<= 255 charactersrequired
results[].​descriptionstringrequired
results[].​statusstring(HumanSupportTicketStatusEnum)
  • open - Open
  • in_progress - In Progress
  • closed - Closed
Enum"open""in_progress""closed"
results[].​mentor_idstringread-onlyrequired
results[].​created_atstring(date-time)read-onlyrequired
results[].​updated_atstring(date-time)read-onlyrequired
results[].​resolved_atstring or null(date-time)read-onlyrequired
Response
application/json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    { … }
  ]
}

ai_mentor_orgs_users_support_tickets_retrieve

Request

ViewSet for managing Human Support Tickets.

This ViewSet provides endpoints to retrieve, create, and update Human Support Tickets.

Permissions: Platform Admins:

  • Platform admins are able to update the ticket status, and view all tickets for the tenant.
  • Platform admins can only update the subject, description and status fields. Students:
  • Students are only able to view their own created tickets.
  • students can modify only the subject and description entries

Field Updates:

  • subject: Modifiable by both student and platform admin
  • description: Modifiable by only student.
  • status: Modifiable by only platform admin.
Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this human support ticket.

orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/support-tickets/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

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

edX user ID

sessionstring(uuid)read-onlyrequired
subjectstring<= 255 charactersrequired
descriptionstringrequired
statusstring(HumanSupportTicketStatusEnum)
  • open - Open
  • in_progress - In Progress
  • closed - Closed
Enum"open""in_progress""closed"
mentor_idstringread-onlyrequired
created_atstring(date-time)read-onlyrequired
updated_atstring(date-time)read-onlyrequired
resolved_atstring or null(date-time)read-onlyrequired
Response
application/json
{
  "id": 0,
  "username": "string",
  "email": "string",
  "full_name": "string",
  "user": 2147483647,
  "session": "3f2c4c37-8bf1-47a5-bf05-0490dc5c033d",
  "subject": "string",
  "description": "string",
  "status": "open",
  "mentor_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "resolved_at": "2019-08-24T14:15:22Z"
}

ai_mentor_orgs_users_support_tickets_update

Request

ViewSet for managing Human Support Tickets.

This ViewSet provides endpoints to retrieve, create, and update Human Support Tickets.

Permissions: Platform Admins:

  • Platform admins are able to update the ticket status, and view all tickets for the tenant.
  • Platform admins can only update the subject, description and status fields. Students:
  • Students are only able to view their own created tickets.
  • students can modify only the subject and description entries

Field Updates:

  • subject: Modifiable by both student and platform admin
  • description: Modifiable by only student.
  • status: Modifiable by only platform admin.
Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this human support ticket.

orgstringrequired
user_idstringrequired
Body
required
subjectstring<= 255 charactersrequired
descriptionstringrequired
statusstring(HumanSupportTicketStatusEnum)
  • open - Open
  • in_progress - In Progress
  • closed - Closed
Enum"open""in_progress""closed"
curl -i -X PUT \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/support-tickets/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "subject": "string",
    "description": "string",
    "status": "open"
  }'

Responses

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

edX user ID

sessionstring(uuid)read-onlyrequired
subjectstring<= 255 charactersrequired
descriptionstringrequired
statusstring(HumanSupportTicketStatusEnum)
  • open - Open
  • in_progress - In Progress
  • closed - Closed
Enum"open""in_progress""closed"
mentor_idstringread-onlyrequired
created_atstring(date-time)read-onlyrequired
updated_atstring(date-time)read-onlyrequired
resolved_atstring or null(date-time)read-onlyrequired
Response
application/json
{
  "id": 0,
  "username": "string",
  "email": "string",
  "full_name": "string",
  "user": 2147483647,
  "session": "3f2c4c37-8bf1-47a5-bf05-0490dc5c033d",
  "subject": "string",
  "description": "string",
  "status": "open",
  "mentor_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "resolved_at": "2019-08-24T14:15:22Z"
}

ai-prompt

Operations

analytics

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

custom-domains

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com