APIs
This page provides an explanation of the list of APIs that are utilized by the collection editor.
The DIAL service is used to generate, link, and check the status of the DIAL code.
API | Description |
|---|---|
{host}/action/dialcode/v1/reserve/{collection_id} | To reserve DIAL codes for the collection. |
{host}/action/dialcode/v1/process/status/{process_id} | To check the status of QR Code images generation of the reserved DIAL codes . |
{host}/action/dialcode/v3/search | It is used for searching the DIAL codes of a channel. |
It is used to organize your assets in a multi-level hierarchy and creation processes like Draft, Review, and Publish
API | Description |
|---|---|
{host}/action/content/v3/hierarchy/update | It is used to update hierarchy of the collection. |
{host}/action/content/v3/hierarchy/{collection_id}?mode=edit | This is used to fetch the collection hierarchy in the draft/review status. |
{host}/action/content/v3/review/{collection_id} | It is used to send the collection for review. |
{host}/action/content/v3/reject/{collection_id} | To reject the collection which is up for review. |
{host}/action/content/v3/publish/{collection_id} | To publish the content which is up for review. |
It is used to fetch the content metadata.
API | Description |
|---|---|
{host}/action/content/v3/read/{content_id} | This is used to fetch the published content metadata. |
{host}/content/data/v1/telemetry |
It's used to fetch the channel details.
API | Description |
|---|---|
{host}/api/channel/v1/read/{channel_id} |
The asset manager for easy creation and discovery of assets (Images, Videos, etc…)
API | Description |
|---|---|
{host}/action/asset/v1/create | It is used to create asset(media files) viz images, videos |
{host}/action/content/v3/upload/url/{asset_id} | It is used to fetch the pre-signed cloud URL location to upload asset. |
{host}/action/asset/v1/upload/{asset_id} | It is used to upload the asset artifact to the pre-signed cloud URL location. |
API | Description |
|---|---|
{host}/action/composite/v3/search | Used for fetching objects such as Collection, Content, Asset, etc... |
The framework service provides the ability to organize and manage. It is used to identify the “relevant” learning assets to be shown for users.
API | Description |
|---|---|
{host}/api/framework/v1/read/{framework_id} |
It is used to configure fields displayed in a form used in editors for the creation, modification, and viewing of an asset
API | Description |
|---|---|
{host}/action/object/category/definition/v1/read?fields=objectMetadata,forms,name | It is used to read object category defination of a primary category. (Ex. Digital textbook, Explanation Resourse, etc...) |
The user service is used to fetch the list of users for collaboration. It's optional service when collaboration feature is disabled in the editor.
API | Description |
|---|---|
{host}/action/user/v1/search?fields=orgName | For searching a particular user of a channel. |
Last modified 1mo ago