norm/Gainsight
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
691bf67219e6f47f08ae2dbe8bea7101ee7fd64d
Gainsight/Scripts/Migration_tool/api_docs.json

3870 lines
112 KiB
JSON
Raw Normal View History

New script for Karbon. Luminate and Williams-Sonoma template updates.
2024-08-27 17:02:16 -04:00
{
"swagger": "2.0",
"info": {
"title": "Data Migration",
"version": "1.0.0"
},
"host": "api.northpass.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/v2/migration/projects/{project_id}/items/{item_id}/activity_resources": {
"post": {
"tags": [
"Activity Resources"
],
"summary": "Create activity resources for the item",
"description": "Create resources for the item.\n",
"consumes": [
"application/json"
],
"produces": [
"text/html"
],
"parameters": [
{
"name": "body",
"in": "body",
"description": "",
"required": false,
"schema": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Data",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"required": true
},
"attributes": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"required": true
},
"display_name": {
"type": "string",
"required": true
},
"data": {
"type": "object",
"properties": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"body": {
"type": "string",
"required": true
},
"position": {
"type": "integer",
"required": true
},
"course_id": {
"type": "string",
"required": true
},
"section_id": {
"type": "string",
"required": true
},
"type": {
"type": "string",
"required": true
}
}
}
}
}
}
}
}
}
}
},
{
"name": "project_id",
"in": "path",
"description": "Project ID",
"required": true,
"type": "string"
},
{
"name": "item_id",
"in": "path",
"description": "Item ID",
"required": true,
"type": "string"
}
],
"responses": {
"201": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "text/html"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
}
}
},
"400": {
"description": "invalid params",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"errors": [
{
"data": {
"0": {
"display_name": [
"is missing"
]
}
}
},
{
"data": {
"0": {
"data": {
"course_id": [
"is missing"
]
}
}
}
},
{
"data": {
"1": {
"data": {
"section_id": [
"is missing"
]
}
}
}
}
]
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}/items/{item_id}/course_attempt_resources": {
"post": {
"tags": [
"Course Attempt Resources"
],
"summary": "Create course attempt resources for the item",
"description": "Create resources for the item.\n",
"consumes": [
"application/json"
],
"produces": [
"text/html"
],
"parameters": [
{
"name": "body",
"in": "body",
"description": "",
"required": false,
"schema": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Data",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"required": true
},
"attributes": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"required": true
},
"display_name": {
"type": "string",
"required": true
},
"data": {
"type": "object",
"properties": {
"learner_id": {
"type": "string",
"required": true
},
"course_id": {
"type": "string",
"required": true
},
"progress": {
"type": "integer",
"required": true
},
"enrolled_at": {
"type": "string",
"required": true
},
"started_at": {
"type": "string",
"required": true
},
"completed_at": {
"type": "string"
},
"completed_activities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"required": true
},
"completed_at": {
"type": "string",
"required": true
}
}
}
}
}
}
}
}
}
}
}
}
}
},
{
"name": "project_id",
"in": "path",
"description": "Project ID",
"required": true,
"type": "string"
},
{
"name": "item_id",
"in": "path",
"description": "Item ID",
"required": true,
"type": "string"
}
],
"responses": {
"201": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "text/html"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
}
}
},
"400": {
"description": "invalid params",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"errors": [
{
"data": {
"0": {
"display_name": [
"is missing"
]
}
}
},
{
"data": {
"0": {
"data": {
"completed_activities": [
"is missing"
]
}
}
}
},
{
"data": {
"1": {
"data": {
"learner_id": [
"is missing"
]
}
}
}
},
{
"data": {
"1": {
"data": {
"course_id": [
"is missing"
]
}
}
}
},
{
"data": {
"1": {
"data": {
"enrolled_at": [
"is missing"
]
}
}
}
},
{
"data": {
"1": {
"data": {
"started_at": [
"is missing"
]
}
}
}
},
{
"data": {
"1": {
"data": {
"completed_activities": {
"0": {
"id": [
"is missing"
]
}
}
}
}
}
},
{
"data": {
"1": {
"data": {
"completed_activities": {
"0": {
"completed_at": [
"is missing"
]
}
}
}
}
}
}
]
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}/items/{item_id}/course_resources": {
"post": {
"tags": [
"Course Resources"
],
"summary": "Create course resources for the item",
"description": "Create resources for the item.\n",
"consumes": [
"application/json"
],
"produces": [
"text/html"
],
"parameters": [
{
"name": "body",
"in": "body",
"description": "",
"required": false,
"schema": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Data",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"required": true
},
"attributes": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"required": true
},
"display_name": {
"type": "string",
"required": true
},
"data": {
"type": "object",
"properties": {
"name": {
"type": "string",
"required": true
},
"short_description": {
"type": "string",
"required": true
},
"full_description": {
"type": "string",
"required": true
},
"navigation_mode": {
"type": "string",
"required": true
}
}
}
}
}
}
}
}
}
}
},
{
"name": "project_id",
"in": "path",
"description": "Project ID",
"required": true,
"type": "string"
},
{
"name": "item_id",
"in": "path",
"description": "Item ID",
"required": true,
"type": "string"
}
],
"responses": {
"201": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "text/html"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
}
}
},
"400": {
"description": "invalid params",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"errors": [
{
"data": {
"0": {
"display_name": [
"is missing"
]
}
}
},
{
"data": {
"0": {
"data": {
"short_description": [
"is missing"
]
}
}
}
},
{
"data": {
"1": {
"data": {
"navigation_mode": [
"is missing"
]
}
}
}
}
]
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}/items/{item_id}/enrollment_resources": {
"post": {
"tags": [
"Enrollment Resources"
],
"summary": "Create enrollment resources for the item",
"description": "Create resources for the item.\n",
"consumes": [
"application/json"
],
"produces": [
"text/html"
],
"parameters": [
{
"name": "body",
"in": "body",
"description": "",
"required": false,
"schema": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Data",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"required": true
},
"attributes": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"required": true
},
"display_name": {
"type": "string",
"required": true
},
"data": {
"type": "object",
"properties": {
"enrolled_at": {
"type": "string",
"required": true
},
"course_id": {
"type": "string",
"required": true
},
"person_id": {
"type": "string",
"required": true
}
}
}
}
}
}
}
}
}
}
},
{
"name": "project_id",
"in": "path",
"description": "Project ID",
"required": true,
"type": "string"
},
{
"name": "item_id",
"in": "path",
"description": "Item ID",
"required": true,
"type": "string"
}
],
"responses": {
"201": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "text/html"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
}
}
},
"400": {
"description": "invalid params",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"errors": [
{
"data": {
"0": {
"display_name": [
"is missing"
]
}
}
},
{
"data": {
"0": {
"data": {
"person_id": [
"is missing"
]
}
}
}
},
{
"data": {
"1": {
"data": {
"course_id": [
"is missing"
]
}
}
}
}
]
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}/extraction_processes": {
"get": {
"tags": [
"Extraction processes"
],
"summary": "Get list of extraction processes",
"description": "Returns a list of extraction processes for a migration project.\n",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Migration project ID",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "max-age=0, private, must-revalidate"
}
},
"examples": {
"application/json": {
"data": [
{
"id": "cc09c826-2bfb-4499-bb91-635d6925a63a",
"type": "extraction_processes",
"attributes": {
"extraction_type": "courses",
"skilljar_configuration_id": 280,
"created_at": "2024-08-21T19:02:22Z"
},
"links": {
"processing_logs": {
"href": "http://example.org/v2/migration/projects/cd4c5460-d2b3-4e75-869f-3cf43a844d09/extraction_processes/cc09c826-2bfb-4499-bb91-635d6925a63a/processing_logs",
"methods": [
"get"
]
}
}
},
{
"id": "c08dfe88-ed6e-4f6f-aac2-224b44197632",
"type": "extraction_processes",
"attributes": {
"extraction_type": "people",
"skilljar_configuration_id": 280,
"created_at": "2024-08-21T19:02:22Z"
},
"links": {
"processing_logs": {
"href": "http://example.org/v2/migration/projects/cd4c5460-d2b3-4e75-869f-3cf43a844d09/extraction_processes/c08dfe88-ed6e-4f6f-aac2-224b44197632/processing_logs",
"methods": [
"get"
]
}
}
}
],
"links": {
"self": "http://example.org/v2/migration/projects/cd4c5460-d2b3-4e75-869f-3cf43a844d09/extraction_processes"
}
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}/items": {
"get": {
"tags": [
"Migration Items"
],
"summary": "Get migration project items",
"description": "Returns a list of project items for a migration project.\n",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Migration project ID",
"required": true,
"type": "string"
},
{
"name": "page",
"in": "query",
"description": "Page number",
"required": false,
"type": "string"
},
{
"name": "limit",
"in": "query",
"description": "Number of items per page",
"required": false,
"type": "string"
},
{
"name": "filter",
"in": "query",
"description": "Filter items by type",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "max-age=0, private, must-revalidate"
}
},
"examples": {
"application/json": {
"data": [
{
"id": "bfe74a2d-4280-4d2d-aa28-b4d4e5f02deb",
"type": "migration_items",
"attributes": {
"type": "courses",
"status": "pending",
"source": "manual",
"created_at": "2024-08-21T19:02:22Z"
},
"links": {
"self": "http://example.org/v2/migration/projects/2cba036e-0e3e-4c47-be46-b013af9fde1c/items/bfe74a2d-4280-4d2d-aa28-b4d4e5f02deb",
"resources": "http://example.org/v2/migration/projects/2cba036e-0e3e-4c47-be46-b013af9fde1c/items/bfe74a2d-4280-4d2d-aa28-b4d4e5f02deb/resources"
}
},
{
"id": "025b5852-d5d5-46a0-b3f1-a30f07145e42",
"type": "migration_items",
"attributes": {
"type": "sections",
"status": "pending",
"source": "manual",
"created_at": "2024-08-21T19:02:22Z"
},
"links": {
"self": "http://example.org/v2/migration/projects/2cba036e-0e3e-4c47-be46-b013af9fde1c/items/025b5852-d5d5-46a0-b3f1-a30f07145e42",
"resources": "http://example.org/v2/migration/projects/2cba036e-0e3e-4c47-be46-b013af9fde1c/items/025b5852-d5d5-46a0-b3f1-a30f07145e42/resources"
}
}
],
"links": {
"self": "http://example.org/v2/migration/projects/2cba036e-0e3e-4c47-be46-b013af9fde1c/items"
}
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
},
"post": {
"tags": [
"Migration Items"
],
"summary": "Create migration project item",
"description": "Create a project item for a migration project.\n",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Migration project ID",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "",
"required": false,
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Item type",
"enum": [
"courses",
"sections",
"activities"
]
}
},
"required": [
"type"
]
}
}
}
}
}
}
],
"responses": {
"201": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "max-age=0, private, must-revalidate"
}
},
"examples": {
"application/json": {
"data": {
"id": "ea454d76-bd8d-4a1f-a58c-a056135cc8c5",
"type": "migration_items",
"attributes": {
"type": "courses",
"status": "pending",
"source": "manual",
"created_at": "2024-08-21T19:02:22Z"
},
"links": {
"self": "http://example.org/v2/migration/projects/73515801-d968-485e-9884-82158234bcfe/items/ea454d76-bd8d-4a1f-a58c-a056135cc8c5",
"resources": "http://example.org/v2/migration/projects/73515801-d968-485e-9884-82158234bcfe/items/ea454d76-bd8d-4a1f-a58c-a056135cc8c5/resources"
}
},
"links": {
"self": "http://example.org/v2/migration/projects/73515801-d968-485e-9884-82158234bcfe/items"
}
}
}
},
"404": {
"description": "not found",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"errors": {
"status": "404",
"title": "Not Found",
"detail": "The resource you requested does not exist"
}
}
}
},
"422": {
"description": "unprocessable entity",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"errors": {
"status": "422",
"title": "Not Null Violation",
"detail": "A required field was not provided"
}
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}/items/{item_id}": {
"get": {
"tags": [
"Migration Items"
],
"summary": "Get migration project item",
"description": "Returns a project item for a migration project.\n",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Migration project ID",
"required": true,
"type": "string"
},
{
"name": "item_id",
"in": "path",
"description": "Migration item ID",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "max-age=0, private, must-revalidate"
}
},
"examples": {
"application/json": {
"data": {
"id": "b31552be-912a-45d1-9ed0-9e0c91b59579",
"type": "migration_items",
"attributes": {
"type": "courses",
"status": "pending",
"source": "manual",
"created_at": "2024-08-21T19:02:22Z"
},
"links": {
"self": "http://example.org/v2/migration/projects/d38744b9-dd06-4079-8063-e08922699291/items/b31552be-912a-45d1-9ed0-9e0c91b59579",
"resources": "http://example.org/v2/migration/projects/d38744b9-dd06-4079-8063-e08922699291/items/b31552be-912a-45d1-9ed0-9e0c91b59579/resources"
}
},
"links": {
"self": "http://example.org/v2/migration/projects/d38744b9-dd06-4079-8063-e08922699291/items/b31552be-912a-45d1-9ed0-9e0c91b59579"
}
}
}
},
"404": {
"description": "not found",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"errors": {
"status": "404",
"title": "Not Found",
"detail": "The resource you requested does not exist"
}
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
},
"delete": {
"tags": [
"Migration Items"
],
"summary": "Delete migration project item",
"description": "Delete a project item for a migration project.\n",
"consumes": [
"application/json"
],
"produces": [
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Migration project ID",
"required": true,
"type": "string"
},
{
"name": "item_id",
"in": "path",
"description": "Migration item ID",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
}
}
},
"404": {
"description": "not found",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"errors": {
"status": "404",
"title": "Not Found",
"detail": "The resource you requested does not exist"
}
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}/items/{item_id}/learning_path_attempt_resources": {
"post": {
"tags": [
"Learning Path Attempt Resources"
],
"summary": "Create learning_path attempt resources for the item",
"description": "Create resources for the item.\n",
"consumes": [
"application/json"
],
"produces": [
"text/html"
],
"parameters": [
{
"name": "body",
"in": "body",
"description": "",
"required": false,
"schema": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Data",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"required": true
},
"attributes": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"required": true
},
"display_name": {
"type": "string",
"required": true
},
"data": {
"type": "object",
"properties": {
"learner_id": {
"type": "string",
"required": true
},
"learning_path_id": {
"type": "string",
"required": true
},
"progress": {
"type": "integer",
"required": true
},
"enrolled_at": {
"type": "string",
"required": true
},
"started_at": {
"type": "string",
"required": true
},
"completed_at": {
"type": "string"
},
"completed_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resource_uuid": {
"type": "string",
"required": true
},
"resource_type": {
"type": "string",
"required": true
},
"completed_at": {
"type": "string",
"required": true
}
}
}
}
}
}
}
}
}
}
}
}
}
},
{
"name": "project_id",
"in": "path",
"description": "Project ID",
"required": true,
"type": "string"
},
{
"name": "item_id",
"in": "path",
"description": "Item ID",
"required": true,
"type": "string"
}
],
"responses": {
"201": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "text/html"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
}
}
},
"400": {
"description": "invalid params",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"errors": [
{
"data": {
"0": {
"display_name": [
"is missing"
]
}
}
},
{
"data": {
"0": {
"data": {
"completed_items": [
"is missing"
]
}
}
}
},
{
"data": {
"1": {
"data": {
"learner_id": [
"is missing"
]
}
}
}
},
{
"data": {
"1": {
"data": {
"learning_path_id": [
"is missing"
]
}
}
}
},
{
"data": {
"1": {
"data": {
"enrolled_at": [
"is missing"
]
}
}
}
},
{
"data": {
"1": {
"data": {
"started_at": [
"is missing"
]
}
}
}
},
{
"data": {
"1": {
"data": {
"completed_items": {
"0": {
"resource_id": [
"is missing"
]
}
}
}
}
}
},
{
"data": {
"1": {
"data": {
"completed_items": {
"0": {
"resource_type": [
"is missing"
]
}
}
}
}
}
},
{
"data": {
"1": {
"data": {
"completed_items": {
"0": {
"completed_at": [
"is missing"
]
}
}
}
}
}
}
]
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}/items/{item_id}/person_resources": {
"post": {
"tags": [
"Person Resources"
],
"summary": "Create person resources for the item",
"description": "Create resources for the item.\n",
"consumes": [
"application/json"
],
"produces": [
"text/html"
],
"parameters": [
{
"name": "body",
"in": "body",
"description": "",
"required": false,
"schema": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Data",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"required": true
},
"attributes": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"required": true
},
"display_name": {
"type": "string",
"required": true
},
"data": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"required": true
},
"last_name": {
"type": "string",
"required": true
},
"email": {
"type": "string",
"required": true
}
}
}
}
}
}
}
}
}
}
},
{
"name": "project_id",
"in": "path",
"description": "Project ID",
"required": true,
"type": "string"
},
{
"name": "item_id",
"in": "path",
"description": "Item ID",
"required": true,
"type": "string"
}
],
"responses": {
"201": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "text/html"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
}
}
},
"400": {
"description": "invalid params",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"errors": [
{
"data": {
"0": {
"display_name": [
"is missing"
]
}
}
},
{
"data": {
"0": {
"data": {
"email": [
"is missing"
]
}
}
}
}
]
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}/items/{item_id}/process_resources": {
"post": {
"tags": [
"Process resources"
],
"summary": "Process resources",
"description": "Processes resources for the given item.\n",
"consumes": [
"application/json"
],
"produces": [
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project ID",
"required": true,
"type": "string"
},
{
"name": "item_id",
"in": "path",
"description": "Item ID",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "",
"required": false,
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"properties": {
"resource_ids": {
"type": "array",
"description": "Resource IDs",
"items": {
"type": "string"
}
}
},
"required": [
"resource_ids"
]
}
}
}
}
}
}
],
"responses": {
"204": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}/extraction_processes/{extraction_process_id}/processing_logs": {
"get": {
"tags": [
"Processing log"
],
"summary": "Get processing log",
"description": "Returns processing log for an extraction process.\n",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Migration project ID",
"required": true,
"type": "string"
},
{
"name": "extraction_process_id",
"in": "path",
"description": "Extraction process ID",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "max-age=0, private, must-revalidate"
}
},
"examples": {
"application/json": {
"data": [
{
"id": null,
"type": "processing_logs",
"attributes": {
"message": "Process id: 935d497d-2339-4986-b505-ab12b0d876f6",
"timestamp": null
}
},
{
"id": "4baa1d27-6436-44d3-ae40-6fa36b28d8c9",
"type": "processing_logs",
"attributes": {
"message": "Extraction started",
"timestamp": "2021-01-01T00:00:00.000Z"
}
},
{
"id": "1474056a-83b1-4ec8-adfa-0eac9b4b156f",
"type": "processing_logs",
"attributes": {
"message": "Extracted courses from page: 1",
"timestamp": "2021-01-02T00:00:00.000Z"
}
}
]
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects": {
"get": {
"tags": [
"Migration projects"
],
"summary": "Get migration projects",
"description": "Returns migration projects.\n\nSearch by name\n",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "max-age=0, private, must-revalidate"
}
},
"examples": {
"application/json": {
"data": [
{
"id": "d9a6f94c-9523-4d64-beb5-17b822dae37c",
"type": "migration_projects",
"attributes": {
"name": "Project 1"
},
"links": {
"self": {
"href": "http://example.org/v2/migration/projects/d9a6f94c-9523-4d64-beb5-17b822dae37c",
"methods": [
"get",
"patch",
"delete"
]
},
"items": "http://example.org/v2/migration/projects/d9a6f94c-9523-4d64-beb5-17b822dae37c/items",
"start_migration": "http://example.org/v2/migration/projects/d9a6f94c-9523-4d64-beb5-17b822dae37c/start_migration"
}
},
{
"id": "04c06549-c606-4156-8e5c-5e4d57c9c508",
"type": "migration_projects",
"attributes": {
"name": "Project 2"
},
"links": {
"self": {
"href": "http://example.org/v2/migration/projects/04c06549-c606-4156-8e5c-5e4d57c9c508",
"methods": [
"get",
"patch",
"delete"
]
},
"items": "http://example.org/v2/migration/projects/04c06549-c606-4156-8e5c-5e4d57c9c508/items",
"start_migration": "http://example.org/v2/migration/projects/04c06549-c606-4156-8e5c-5e4d57c9c508/start_migration"
}
}
],
"links": {
"self": "http://example.org/v2/migration/projects"
}
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
},
"post": {
"tags": [
"Migration projects"
],
"summary": "Create migration project",
"description": "Create migration project.\n",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "body",
"in": "body",
"description": "",
"required": false,
"schema": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Migration project name"
}
},
"required": [
"name"
]
}
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "max-age=0, private, must-revalidate"
}
},
"examples": {
"application/json": {
"data": {
"id": "c3c10136-f38c-4370-a90a-25aec177f82c",
"type": "migration_projects",
"attributes": {
"name": "Migrating analytics"
},
"links": {
"self": {
"href": "http://example.org/v2/migration/projects/c3c10136-f38c-4370-a90a-25aec177f82c",
"methods": [
"get",
"patch",
"delete"
]
},
"items": "http://example.org/v2/migration/projects/c3c10136-f38c-4370-a90a-25aec177f82c/items",
"start_migration": "http://example.org/v2/migration/projects/c3c10136-f38c-4370-a90a-25aec177f82c/start_migration"
}
},
"links": {
"self": "http://example.org/v2/migration/projects"
}
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}": {
"get": {
"tags": [
"Migration projects"
],
"summary": "Get migration project",
"description": "Returns migration project.\n",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Migration project ID",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "max-age=0, private, must-revalidate"
}
},
"examples": {
"application/json": {
"data": {
"id": "2279b5af-5254-4eab-9f89-1f8d0597539c",
"type": "migration_projects",
"attributes": {
"name": "Project 1"
},
"links": {
"self": {
"href": "http://example.org/v2/migration/projects/2279b5af-5254-4eab-9f89-1f8d0597539c",
"methods": [
"get",
"patch",
"delete"
]
},
"items": "http://example.org/v2/migration/projects/2279b5af-5254-4eab-9f89-1f8d0597539c/items",
"start_migration": "http://example.org/v2/migration/projects/2279b5af-5254-4eab-9f89-1f8d0597539c/start_migration"
}
},
"links": {
"self": "http://example.org/v2/migration/projects/2279b5af-5254-4eab-9f89-1f8d0597539c"
}
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
},
"delete": {
"tags": [
"Migration projects"
],
"summary": "Delete migration project",
"description": "Delete migration project.\n",
"consumes": [
"application/json"
],
"produces": [
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Migration project ID",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
},
"patch": {
"tags": [
"Migration projects"
],
"summary": "Update migration project",
"description": "Update migration project.\n",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Migration project ID",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "",
"required": false,
"schema": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Migration project name"
}
},
"required": [
"name"
]
}
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "max-age=0, private, must-revalidate"
}
},
"examples": {
"application/json": {
"data": {
"id": "2469c9c2-48ff-4891-a705-4101d229c2b6",
"type": "migration_projects",
"attributes": {
"name": "Migrating analytics"
},
"links": {
"self": {
"href": "http://example.org/v2/migration/projects/2469c9c2-48ff-4891-a705-4101d229c2b6",
"methods": [
"get",
"patch",
"delete"
]
},
"items": "http://example.org/v2/migration/projects/2469c9c2-48ff-4891-a705-4101d229c2b6/items",
"start_migration": "http://example.org/v2/migration/projects/2469c9c2-48ff-4891-a705-4101d229c2b6/start_migration"
}
},
"links": {
"self": "http://example.org/v2/migration/projects/2469c9c2-48ff-4891-a705-4101d229c2b6"
}
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}/items/{item_id}/quiz_attempt_resources": {
"post": {
"tags": [
"Quiz Attempt Resources"
],
"summary": "Create quiz attempt resources for the item",
"description": "Create resources for the item.\n",
"consumes": [
"application/json"
],
"produces": [
"text/html"
],
"parameters": [
{
"name": "body",
"in": "body",
"description": "",
"required": false,
"schema": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Data",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"required": true
},
"attributes": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"required": true
},
"display_name": {
"type": "string",
"required": true
},
"data": {
"type": "object",
"properties": {
"learner_id": {
"type": "string",
"required": true
},
"course_attempt_id": {
"type": "string",
"required": true
},
"activity_id": {
"type": "string",
"required": true
},
"progress": {
"type": "integer",
"required": true
},
"completed_at": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
},
{
"name": "project_id",
"in": "path",
"description": "Project ID",
"required": true,
"type": "string"
},
{
"name": "item_id",
"in": "path",
"description": "Item ID",
"required": true,
"type": "string"
}
],
"responses": {
"201": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "text/html"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
}
}
},
"400": {
"description": "invalid params",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"errors": [
{
"data": {
"0": {
"display_name": [
"is missing"
]
}
}
},
{
"data": {
"0": {
"data": {
"course_attempt_id": [
"is missing"
]
}
}
}
},
{
"data": {
"1": {
"data": {
"learner_id": [
"is missing"
]
}
}
}
},
{
"data": {
"1": {
"data": {
"course_attempt_id": [
"is missing"
]
}
}
}
},
{
"data": {
"1": {
"data": {
"activity_id": [
"is missing"
]
}
}
}
},
{
"data": {
"1": {
"data": {
"progress": [
"is missing"
]
}
}
}
}
]
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}/items/{item_id}/resources": {
"get": {
"tags": [
"Resources"
],
"summary": "Get resources for the item",
"description": "Returns a list of resources for the item.\n",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project ID",
"required": true,
"type": "string"
},
{
"name": "item_id",
"in": "path",
"description": "Item ID",
"required": true,
"type": "string"
},
{
"name": "q",
"in": "query",
"description": "Search query",
"required": false,
"type": "string"
},
{
"name": "page",
"in": "query",
"description": "Page number",
"required": false,
"type": "string"
},
{
"name": "limit",
"in": "query",
"description": "Number of items per page",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "max-age=0, private, must-revalidate"
}
},
"examples": {
"application/json": {
"data": [
{
"id": "a4811296-dad8-42be-a288-7fe113bdd7fe",
"type": "migration_resources",
"attributes": {
"display_name": "Course 2",
"status": "pending"
}
},
{
"id": "cad4651a-f63c-4bfd-a2d9-d7a59d26239b",
"type": "migration_resources",
"attributes": {
"display_name": "Course 1",
"status": "pending"
}
}
],
"links": {
"self": "http://example.org/v2/migration/projects/7e6e16f3-8029-47ba-9743-fd10f1155af6/items/35dd263a-02ee-4c72-8a96-be299bdeabad/resources"
}
}
}
},
"404": {
"description": "not found",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"errors": {
"status": "404",
"title": "Not Found",
"detail": "The resource you requested does not exist"
}
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}/items/{item_id}/section_resources": {
"post": {
"tags": [
"Section Resources"
],
"summary": "Create section resources for the item",
"description": "Create resources for the item.\n",
"consumes": [
"application/json"
],
"produces": [
"text/html"
],
"parameters": [
{
"name": "body",
"in": "body",
"description": "",
"required": false,
"schema": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Data",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"required": true
},
"attributes": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"required": true
},
"display_name": {
"type": "string",
"required": true
},
"data": {
"type": "object",
"properties": {
"name": {
"type": "string",
"required": true
},
"position": {
"type": "integer",
"required": true
},
"course_id": {
"type": "string",
"required": true
}
}
}
}
}
}
}
}
}
}
},
{
"name": "project_id",
"in": "path",
"description": "Project ID",
"required": true,
"type": "string"
},
{
"name": "item_id",
"in": "path",
"description": "Item ID",
"required": true,
"type": "string"
}
],
"responses": {
"201": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "text/html"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
}
}
},
"400": {
"description": "invalid params",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"errors": [
{
"data": {
"0": {
"display_name": [
"is missing"
]
}
}
},
{
"data": {
"0": {
"data": {
"course_id": [
"is missing"
]
}
}
}
},
{
"data": {
"1": {
"data": {
"position": [
"is missing"
]
}
}
}
}
]
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}/skilljar_configuration": {
"get": {
"tags": [
"Skilljar configurations"
],
"summary": "Get Skilljar configuration",
"description": "Returns Skilljar configuration for a migration project.\n",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Migration project ID",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "max-age=0, private, must-revalidate"
}
},
"examples": {
"application/json": {
"data": {
"id": "70a8beef-cd24-41d3-8af4-5027d5fc373f",
"type": "skilljar_configurations",
"attributes": {
"api_key": "some_key",
"migration_project_id": "4111a689-bf58-45e0-b5f8-0103d3628cf4",
"domain": "extractor.example.com",
"email": "admin@example.com",
"password": "3d95659c5f19acb0"
}
},
"links": {
"self": "http://example.org/v2/migration/projects/4111a689-bf58-45e0-b5f8-0103d3628cf4/skilljar_configuration"
}
}
}
},
"404": {
"description": "not found",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"errors": {
"status": "404",
"title": "Not Found",
"detail": "The resource you requested does not exist"
}
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
},
"post": {
"tags": [
"Skilljar configurations"
],
"summary": "Create Skilljar configuration",
"description": "Creates Skilljar configuration for a migration project.\n",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Migration project ID",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "",
"required": false,
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"properties": {
"migration_project_id": {
"type": "string",
"description": "Migration project ID"
},
"api_key": {
"type": "string",
"description": "Skilljar API key"
},
"domain": {
"type": "string",
"description": "Skilljar domain"
},
"email": {
"type": "string",
"description": "Skilljar admin email"
},
"password": {
"type": "string",
"description": "Skilljar admin password"
}
},
"required": [
"migration_project_id",
"api_key",
"domain",
"email",
"password"
]
}
}
}
}
}
}
],
"responses": {
"404": {
"description": "not found",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"errors": {
"status": "404",
"title": "Not Found",
"detail": "The resource you requested does not exist"
}
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
},
"delete": {
"tags": [
"Skilljar configurations"
],
"summary": "Delete Skilljar configuration",
"description": "Deletes Skilljar configuration for a migration project.\n",
"consumes": [
"application/json"
],
"produces": [
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Migration project ID",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
}
}
},
"404": {
"description": "not found",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"errors": {
"status": "404",
"title": "Not Found",
"detail": "The resource you requested does not exist"
}
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
},
"patch": {
"tags": [
"Skilljar configurations"
],
"summary": "Update Skilljar configuration",
"description": "Updates Skilljar configuration for a migration project.\n",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Migration project ID",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "",
"required": false,
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"properties": {
"migration_project_id": {
"type": "string",
"description": "Migration project ID"
},
"api_key": {
"type": "string",
"description": "Skilljar API key"
},
"domain": {
"type": "string",
"description": "Skilljar domain"
},
"email": {
"type": "string",
"description": "Skilljar admin email"
},
"password": {
"type": "string",
"description": "Skilljar admin password"
}
},
"required": [
"migration_project_id",
"api_key",
"domain",
"email",
"password"
]
}
}
}
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "max-age=0, private, must-revalidate"
}
},
"examples": {
"application/json": {
"data": {
"id": "31370903-5d7b-4a9e-80fe-833e7306141d",
"type": "skilljar_configurations",
"attributes": {
"api_key": "new_key",
"migration_project_id": "fd53ba19-f249-4a9d-b34c-ce78775a084e",
"domain": "new.example.com",
"email": "admin@example.com",
"password": "b33a8be01842e87f"
}
},
"links": {
"self": "http://example.org/v2/migration/projects/fd53ba19-f249-4a9d-b34c-ce78775a084e/skilljar_configuration"
}
}
}
},
"404": {
"description": "not found",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"errors": {
"status": "404",
"title": "Not Found",
"detail": "The resource you requested does not exist"
}
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}/extract_course_attempts": {
"post": {
"tags": [
"Skilljar course attempts extraction"
],
"summary": "Extract course attempts",
"description": "Starts courses attempts extraction for the given project.\n",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Migration project ID",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"data": {
"id": "3713ec40-32d5-442e-bef0-8af3166cd0c4",
"type": "extraction_processes",
"attributes": {
"extraction_type": "course_attempts",
"skilljar_configuration_id": 285,
"created_at": "2024-08-21T19:02:22Z"
},
"links": {
"processing_logs": {
"href": "http://example.org/v2/migration/projects/92fa6f21-1dd8-45d9-8b78-063f5d178b57/extraction_processes/3713ec40-32d5-442e-bef0-8af3166cd0c4/processing_logs",
"methods": [
"get"
]
}
}
},
"links": {
"self": "http://example.org/v2/migration/projects/92fa6f21-1dd8-45d9-8b78-063f5d178b57/extract_course_attempts"
}
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}/extract_courses": {
"post": {
"tags": [
"Skilljar courses extraction"
],
"summary": "Extract courses",
"description": "Starts courses extraction for the given project.\n",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Migration project ID",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"data": {
"id": "7765c8d1-3a1b-4305-ae79-5835e9b0c9e2",
"type": "extraction_processes",
"attributes": {
"extraction_type": "courses",
"skilljar_configuration_id": 286,
"created_at": "2024-08-21T19:02:22Z"
},
"links": {
"processing_logs": {
"href": "http://example.org/v2/migration/projects/e88c0b9f-6b5d-4826-8b63-3399c201bef8/extraction_processes/7765c8d1-3a1b-4305-ae79-5835e9b0c9e2/processing_logs",
"methods": [
"get"
]
}
}
},
"links": {
"self": "http://example.org/v2/migration/projects/e88c0b9f-6b5d-4826-8b63-3399c201bef8/extract_courses"
}
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}/extract_enrollments": {
"post": {
"tags": [
"Skilljar enrollments extraction"
],
"summary": "Extract enrollments",
"description": "Starts enrollments extraction for the given project.\n",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Migration project ID",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"data": {
"id": "de2bf734-cd35-4593-af2c-8e49a32284e2",
"type": "extraction_processes",
"attributes": {
"extraction_type": "enrollments",
"skilljar_configuration_id": 287,
"created_at": "2024-08-21T19:02:22Z"
},
"links": {
"processing_logs": {
"href": "http://example.org/v2/migration/projects/d617b413-182e-4465-aefb-82ce8cbe7e6f/extraction_processes/de2bf734-cd35-4593-af2c-8e49a32284e2/processing_logs",
"methods": [
"get"
]
}
}
},
"links": {
"self": "http://example.org/v2/migration/projects/d617b413-182e-4465-aefb-82ce8cbe7e6f/extract_enrollments"
}
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}/extract_people": {
"post": {
"tags": [
"Skilljar people extraction"
],
"summary": "Extract people",
"description": "Starts people extraction for the given project.\n",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Migration project ID",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"data": {
"id": "66d1da6f-01ca-4b9c-9cab-df7c70c23860",
"type": "extraction_processes",
"attributes": {
"extraction_type": "people",
"skilljar_configuration_id": 288,
"created_at": "2024-08-21T19:02:22Z"
},
"links": {
"processing_logs": {
"href": "http://example.org/v2/migration/projects/64119307-318c-4e77-b2c7-a3a4b1e94b75/extraction_processes/66d1da6f-01ca-4b9c-9cab-df7c70c23860/processing_logs",
"methods": [
"get"
]
}
}
},
"links": {
"self": "http://example.org/v2/migration/projects/64119307-318c-4e77-b2c7-a3a4b1e94b75/extract_people"
}
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
},
"/v2/migration/projects/{project_id}/start_migration": {
"post": {
"tags": [
"Start migration"
],
"summary": "Start migration",
"description": "Starts migration for the given project.\n",
"consumes": [
"application/json"
],
"produces": [
"text/html"
],
"parameters": [
{
"name": "project_id",
"in": "path",
"description": "Project ID",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "text/html"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
}
}
},
"204": {
"description": "successful operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
}
}
},
"422": {
"description": "failed operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"errors": {
"status": "422",
"title": "Migration failed",
"detail": "There is no items to migrate in this project"
}
}
}
},
"404": {
"description": "failed operation",
"schema": {
"type": "object",
"properties": {
}
},
"headers": {
"content-type": {
"type": "string",
"x-example-value": "application/json; charset=utf-8"
},
"cache-control": {
"type": "string",
"x-example-value": "no-cache"
}
},
"examples": {
"application/json": {
"errors": {
"status": "404",
"title": "Not Found",
"detail": "The resource you requested does not exist"
}
}
}
}
},
"deprecated": false,
"security": [
{
"X-Api-Key": [
]
}
]
}
}
},
"securityDefinitions": {
"X-Api-Key": {
"type": "apiKey",
"name": "X-Api-Key",
"in": "header"
}
},
"tags": [
{
"name": "Activity Resources"
},
{
"name": "Course Attempt Resources"
},
{
"name": "Course Resources"
},
{
"name": "Enrollment Resources"
},
{
"name": "Extraction processes"
},
{
"name": "Migration Items"
},
{
"name": "Learning Path Attempt Resources"
},
{
"name": "Person Resources"
},
{
"name": "Process resources"
},
{
"name": "Processing log"
},
{
"name": "Migration projects"
},
{
"name": "Quiz Attempt Resources"
},
{
"name": "Resources"
},
{
"name": "Section Resources"
},
{
"name": "Skilljar configurations"
},
{
"name": "Skilljar course attempts extraction"
},
{
"name": "Skilljar courses extraction"
},
{
"name": "Skilljar enrollments extraction"
},
{
"name": "Skilljar people extraction"
},
{
"name": "Start migration"
}
]
}
Reference in New Issue Copy Permalink