Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Use Cases
  • Create Articles with Attachments
• Learn More
  • Work with your REST Client
  • Manage Collections
  • Configure Cross-Origin Resource Sharing
  • Access Metadata
• Reference
  • Error Messages
  • REST Resource Types
  • Status Codes
  • Supported Data Types
  • Supported HTTP Methods
  • Supported Media Types
  • Supported Query Parameters
  • Terminology
  • Use JSON Web Token for Authorization
  • URL Paths
  • Custom HTTP Headers
  • Language and Locale
• Change History

Tasks

• Content (IM)
  • Article Status
    • Create an article status
    • Delete an article status
    • Get all article statuses
    • Get an article status
    • Set article status
    • Update an article status
  • Categories
    • Get a category
    • Get all categories
    • Get children categories
  • Content
    • Check in content
    • Check out content
    • Clear content check out
    • Create content
    • Create content from import
    • Delete all versions of a content in a locale
    • Delete content
    • Find article by answer ID
    • Get aggregate rating result
    • Get all categories assigned to content
    • Get all content
    • Get all translated content
    • Get all translated content by answer ID
    • Get all translated content by doc ID
    • Get all translated content by version ID
    • Get all user groups assigned to content
    • Get all versions of content
    • Get all versions of content by doc ID
    • Get all views assigned to content
    • Get article by answer ID
    • Get content
    • Get content by doc ID
    • Get content by version ID
    • Get history of content
    • Get history of content by doc ID
    • Get rating results of content
    • Publish all version of content in a locale
    • Publish all versions of content in all locales
    • Publish content
    • Rate content
    • Translate content
    • Unpublish all version of content in a locale
    • Unpublish all versions of content in all locales
    • Unpublish content
    • Update content
    • Update content by version ID
    • Update content from import
    • Update content owner
  • Content Types
    • Get a content type
    • Get all content types
    • Get all user groups assigned to content type
    • Get categories
    • Get public document count
  • Data Forms
    • Get a data form
  • Languages
    • Get a language
    • Get all languages
    • Get all locales assigned to language
  • Locales
    • Get a locale
    • Get all locales
  • Repositories
    • Get all categories assigned to a view
    • Get all locales assigned to a repository
  • User Groups
    • Create a user group
    • Delete user group
    • Get a user group
    • Get a user group by reference key
    • Get all user groups
    • Update a user group
  • User Key Values
    • Create a user key value
    • Delete a user key value
    • Get a user key value
    • Get all user key values
    • Update a user key value
  • Users
    • Get all authoring locales assigned
    • Get all user key values assigned
    • Get users
    • Update all content locales
    • Update all custom key values
  • Views
    • Get all categories assigned
    • Get all user groups assigned
    • Get all views
    • Get view
• Search
  • Search
    • Answer
    • Ask question
    • Initial screen
    • Navigate
    • Page results