LogoLogo
  • LEARN
    • Overview
    • Capabilities
      • Rich and Diverse Assets
      • Organised Collections
      • Asset Lifecycle Management
      • Powerful Discovery
      • Phygital Discovery
      • Observability
    • Technical Architecture
    • Product & Developer Guide
      • Content Service
        • Content APIs
          • Features
          • Architecture
          • Code Structure
          • Schemas
          • APIs
          • Jobs
            • Content publish
            • Asset enrichment
            • Audit event generator
            • Video stream generator
          • FAQs
            • Upload Content
        • Media APIs
          • Features
          • Architecture
          • Schemas
          • APIs
          • Jobs
            • Asset enrichment
            • Audit event generator
          • FAQs
        • Channel APIs
          • Architecture
          • Schema
          • APIs
          • Configuration
          • FAQs
        • License APIs
          • Architecture
          • Schema
          • APIs
          • Configuration
          • FAQs
        • Collection APIs
          • Features
          • Architecture
          • Schemas
          • APIs
          • Jobs
            • Content publish
            • Post publish processor
            • Audit event generator
          • FAQs
      • Search Service
        • Architecture
        • Code Structure
          • Configuration
        • APIs
        • Jobs
          • Search indexer
          • Audit history indexer
        • FAQs
      • Taxonomy Service (Taxonomy & Tagging)
        • Framework APIs
          • Architecture
          • Code Structure
            • Configuration
          • Schemas
          • APIs
          • Jobs
            • Audit event generator
          • FAQs
            • Create Framework
            • Add Content to Framework
        • Object Category APIs
          • Architecture
          • Code Structure
          • Schemas
          • APIs
          • Jobs
            • Audit event generator
          • Configuration
          • FAQs
      • DIAL Service
        • Architecture
        • APIs
        • Jobs
        • Configuration
        • FAQs
          • Link DIAL Code to a Book
      • Player
        • V1
          • Features
          • Architecture
          • Players
            • ECML Player - v1
              • Quiz
              • Create Content
            • Video Player v1
            • Epub Player - v1
            • PDF Player - v1
            • HTML-h5p Player - v1
          • Content import and preview folder creation
          • FAQs
        • V2
          • PDF Player
            • Features
            • Architecture
            • Configuration
            • FAQ's
          • Epub Player
            • Features
            • Architecture
            • Configuration
            • FAQ's
          • Video Player
            • Features
            • Architecture
            • Configuration
            • FAQ's
        • Telemetry Events
          • Offline Telemetry
          • Generate API keys
      • Editors
        • Architecture
        • Interactive Editor
          • Features
            • Content Editor
            • Adding Question Set
            • Concept Selector
            • Add Image
            • Add Video
            • Adding Math Function
            • Limited Publishing and Sharing
        • File Upload Editor
          • Features
          • FAQ's
            • Content Upload
        • Collection Editor - V1
        • Collection Editor - V2
          • Features
          • Architecture
          • APIs
          • FAQ's
        • How to contribute as a JS plugin
          • How do I think about a plugin?
          • Interactive Editor Plugin Guide
          • Using SDK to create and test the plugin
      • Other Knowlg Jobs
        • Configuration
        • FAQs
      • Other
        • Data Migration
        • Schema strucure
    • Product Roadmap
  • ENGAGE
    • Discuss
    • Contribute to SB Knowlg
  • USE
    • Overview
    • System requirements
    • Installation guide
      • Players
        • V1
          • How to setup
        • V2
          • Epub Player
          • Video Player
          • Pdf Player
      • Editors
        • Interactive Editor
        • File Upload Editor
        • Collection Editor - V1
        • Collection Editor - V2
        • Plugins
      • Services
        • Content Service
          • Configuration
        • Search Service
        • Taxonomy Service (Taxonomy & Tagging)
        • DIAL Service
        • Knowlg Jobs
    • Deployment
    • Release notes
      • Release - 6.2.0 (Ongoing)
      • Release - 6.1.0 (latest)
      • Release - 6.0.0
      • Release - 5.7.0
      • Release - 5.6.0
      • Release - 5.5.0
      • Release - 5.4.0
      • Release - 5.3.0
      • Release - 5.2.0
      • Release - 5.1.0
      • Release - 5.0.0
      • Release - 4.10.0
      • Release - 4.8.0
    • Breaking Changes
    • Deprecations
      • Release-5.2.0
      • Release-5.1.0
    • Release
    • USE
      • Infra Requirements
    • Additional Reading
      • Content Service Environment Variables
      • Import External Content
  • Archived
    • Powerful Discovery
      • Usecase
      • Sample data
Powered by GitBook
On this page
  • DIAL Service
  • Collection service
  • Content service
  • Channel Service
  • Media service
  • Assets search service
  • Framework Service
  • Object Category Service
  • User Service

Was this helpful?

Edit on GitHub
  1. LEARN
  2. Product & Developer Guide
  3. Editors
  4. Collection Editor - V2

APIs

PreviousArchitectureNextFAQ's

Last updated 1 year ago

Was this helpful?

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

API
Description

{host}/action/user/v1/search?fields=orgName

For searching a particular user of a channel.

It is used to log the data.

It is used to read a details.

The asset search service provides services to search and discover .

Fetching a specific

It is used to read of a primary category. (Ex. Digital textbook, Explanation Resourse, etc...)

The user service is used to fetch the list of users for . It's optional service when collaboration feature is disabled in the editor.

DIAL Service
Collection service
Content service
Channel Service
Media service
Assets search service
assets
Framework Service
Object Category Service
collaboration
channel
framework
object category defination
telemetry
User Service