Loading ...

REST API: Content | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 134

REST API: Content

0 
 /5
0 (0votes)
Open API Guide

Create, manage, and organize articles, blogs, wikis, ideas, and other content types. Manage attachments, bookmarks, content categories, likes, follows, and content workflows. Every content type supports rich metadata and multi-threaded commenting.

Available Endpoints

Method Endpoint Description
POST Add Attachment /api/content/{ContentID}/attachments Add a attachment to content. List of supported entities: Articles, Blogs, Events, Forum Topics, Forum Posts, Ideas, Videos, Wikis.
POST Add Featured Image /api/content/{ContentID}/image Set the featured image for content
POST Add Photos /api/albums/{AlbumID}/photos Add photos to an existing photo album
GET Check Idea Stage Availability /api/content/idea/stub/availability Checks if the idea stage is available or not
PUT Copy Content /api/content/{contentid}/move Copy content to a different space. Supported for articles, blogs, CMS pages, files and folders, photos and albums, videos, wikis.
PUT Copy Multiple Content /api/content/move Copy multiple pieces of content to a different space. Supported for articles, blogs, CMS pages, files and folders, photos and albums, videos, wikis.
POST Create Content /api/content Create a piece of content. List of supported entities: Articles, Blogs, CMS Pages, Wikis, Albums, Ideas, Forums, Forum Groups, Forum Topics, Forum Posts.
POST Create Content Category /api/content/categories Create a content category. List of supported entities: Articles, Blogs, Videos, CMS Pages, and Ideas.
POST Create Video /api/videos Upload and create a new video entry on the intranet. Videos are hosted within the platform's media library and can be embedded in content, spaces, and wall posts.
DELETE Delete Attachment /api/content/{ContentID}/attachments/{AttachmentID} Provides an automated mechanism for removing delete attachment data from the system.. List of supported entities: Articles, Blogs, Forum Topics, Forum Posts, Ideas, and Cases.
DELETE Delete Content /api/content/{contentid} Provides an automated mechanism for removing delete content data from the system.. Moves stuff to the "Trash" to keep your community clean of outdated or irrelevant information. Essential for content moderation and site maintenance.
DELETE Delete Content Category /api/content/categories/{categoryID} Provides an automated mechanism for removing delete content category data from the system.. List of supported entities: Articles, Blogs, Videos, CMS Pages, and Ideas.
DELETE Delete Featured Image /api/content/{contentid}/image Provides an automated mechanism for removing delete content image data from the system.
POST Downvote Idea /api/content/{ContentID}/votedown Technical reference for the Vote Down endpoint, providing programmatic access to vote down functionality.
GET Get Attachment /api/content/{ContentID}/attachments/{AttachmentID} Enables administrators and developers to programmatically retrieve a specific attachment on content.
GET Get Attachments /api/content/{ContentID}/attachments Enables administrators and developers to programmatically retrieve the attachments on a specific content.
GET Get Content /api/content/{ContentID} Read a specific article, blog, or wiki. This pulls everything—the title, the full body, and the metadata—using just the ContentID. Use this to render content in your own mobile apps or custom intranet portals.
GET Get Content Categories /api/content/categories Enables administrators and developers to programmatically retrieve a list of content categories. List of supported entities: Articles, Blogs, Videos, CMS Pages, and Ideas.
GET Get Content Category /api/content/categories/{CategoryID} Enables administrators and developers to programmatically retrieve a specific content category. List of supported entities: Articles, Blogs, Videos, CMS Pages, and Ideas.
GET Get Content History /api/content/{ContentID}/history/version/{VersionID} Get a specific version of a content item. Supported content types include Articles, Blogs, Files, Ideas, and Wikis.
GET Get Content List /api/content/list Enables administrators and developers to programmatically retrieve a list of content. List of supported entities: Articles, Blogs, CMS Pages, Wikis, Files, Videos, Ideas, Photos, Albums, Forums, Forum Groups, Forum Topics, Forum Posts.
GET Get Content Read Report /api/content/{ContentID}/readreport Enables administrators and developers to programmatically retrieve a list of people who viewed and confirmed they read content. Supported content types: Articles, blogs, CMS pages, files, ideas, videos, wiki pages.
GET Get Content Read Status /api/content/{ContentID}/version/{VersionID}/readstatus Enables administrators and developers to programmatically retrieve a user's content read status on content marked as required reading. List of supported entities: Articles, Blogs, CMS Pages, Wikis, Files, Videos, Ideas.
GET Get Idea Stages /api/content/stages Gets the idea stages of a space.
GET Get Idea Vote Count /api/content/{ContentID}/votes Gets the vote count of an idea.
GET Get Multiple Content /api/content Gets multiple pieces of content by content ID. List of supported entities: Articles, Blogs, CMS Pages, Wikis, Files, Videos, Ideas, Photos, Albums, Forums, Forum Topics, Forum Posts.
GET Get My Idea Vote /api/content/{ContentID}/votes/me Gets the current user's vote for an idea.
GET Get Queued Workflow Content /api/content/workflow/queued Enables administrators and developers to programmatically retrieve a list of content under workflow.
GET Get Related Articles /api/content/{ContentID}/related Enables administrators and developers to programmatically retrieve Related Articles. List of supported entities: Articles.
GET Get Required Reading /api/content/required Used to get the required reading content for user.
GET Get Unread Contents /api/content/unseen Find articles your users haven't read yet. This helps prioritize the most important "new" stuff for each person. Use this to drive engagement by showing "Fresh Content" or "Unread" lists on your home page widget.
GET Get Video Player HTML /api/video/player/html Returns video player HTML based on the parameter specified in the url.
POST Increase View Count /api/content/{contentID}/views Increase the view count on content.
PUT Move Content /api/content/{ContentID}/move Move content to a different space. Supported for articles, blogs, CMS pages, files and folders, photos and albums, videos, wikis. Valid for version 8.0 and above.
PUT Move Multiple Content /api/content/move Copy multiple pieces of content to a different space. Supported for articles, blogs, CMS pages, files and folders, photos and albums, videos, wikis.
PUT Set Content Read Status /api/content/{ContentID}/version/{VersionID}/readstatus Sets the read status on content marked as required reading. List of supported entities: Articles, Blogs, CMS Pages, Wikis, Files, Videos, Ideas.
PUT Set Content Status /api/content/{ContentID}/status Set the publication status of existing content. List of supported entities: Articles, Blogs, CMS Pages, Wikis, Files, Videos, Ideas, Photos, Albums, Forums, Forum Groups, Forum Topics, and Forum Posts.
PUT Update Content /api/content/{ContentID} Edit an existing piece of content. Update a typo, add more info to a Wiki, or refresh an old Blog post without losing its original URL or ID. This keeps your community information fresh and accurate.
PUT Update Content Category /api/content/categories/{CategoryID} Supports the synchronization and modification of update content category properties via the API.. List of supported entities: Articles, Blogs, Videos, CMS Pages, and Ideas.
PUT Update Content Multiple /api/content/multiple You can update existing multiple contents in a single request. For example, set the expiration dates of multiple articles at once.
PUT Update Video /api/videos/{ContentID} Update an existing video
PUT Update Wiki Sort Order /api/content/orderandparent Supports the synchronization and modification of update content sort order and parent content id properties via the API.
POST Upvote Idea /api/content/{ContentID}/voteup Technical reference for the Vote Up endpoint, providing programmatic access to vote up functionality.

Wiki Index

Pages