Edit Article Order

Overview

  • This API edits the order of articles in a topic.
  • This API is used to put specified articles to top/bottom of the list of the articles.
  • This feature is used for article display in SelfService portals. See Get Article-Order API description for more info on this functionality.
  • This API does not add new articles to a topic but merely rearranges the existing ones.
  • It can be used for both creating new order when none have been established yet, and modifying existing order. Since previously existing order will be overwritten with this request, the full list of desired articles in both top and bottom lists should be supplied with each request.

Permissions

  • The user sending the request should be from the same or shared department as the topic.

Preconditions

  • As this API does not add new articles to a topic, all articles supplied in the request body must already be added to the specified topic.
SecurityoAuthUser
Request
path Parameters
ID
required
string

Topic ID

Examples:
202200000002268
Request Body schema: application/json
object (Articles)
object (Articles)
Responses
204

No content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

412

Preconditions failed

500

Internal server error

put/topics/{ID}/articleorder
Request samples
application/json
{
  • "topList": {
    },
  • "bottomList": {
    }
}
Response samples
application/json
{
  • "code": "400-101",
  • "developerMessage": "Unsupported query parameter(s) supplied: '<query_parameter>'."
}