openapi: 3.1.0
info:
  title: Helpcenter KbCategory API
  version: 1.0.0
tags:
- name: KbCategory
paths:
  /api/v1/kbCategory/{categoryId}/repositionArticles:
    get:
      tags:
      - KbCategory
      summary: Get articles for manual sorting
      description: This API lists the positions of help articles to enable manual sorting. Only leaf categories that have a maximum of 1000 articles can be repositioned.
      operationId: getArticlesForRepositioning
      parameters:
      - $ref: '#/components/parameters/categoryId'
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '204':
          $ref: ./Common.json#/components/responses/emptyResponse
        '200':
          $ref: ./Article.json#/components/responses/listAllArticleForRepositioning
      security:
      - iam-oauth2-schema:
        - Desk.articles.READ
      x-audience:
      - external-public
    post:
      tags:
      - KbCategory
      summary: Update article position
      description: This API helps you manually sort articles in your knowledge base. Only leaf categories that have a maximum of 1000 articles can be repositioned.
      operationId: updateKBArticlesRepositioning
      parameters:
      - $ref: '#/components/parameters/categoryId'
      - $ref: ./Common.json#/components/parameters/orgId
      requestBody:
        $ref: ./Article.json#/components/requestBodies/articleIdsJson
      responses:
        '422':
          $ref: ./Common.json#/components/responses/invalidDataErrorResponse
        '204':
          $ref: ./Common.json#/components/responses/emptyResponse
      security:
      - iam-oauth2-schema:
        - Desk.articles.UPDATE
      x-audience:
      - external-public
components:
  parameters:
    categoryId:
      name: categoryId
      in: path
      description: To get individual category details
      required: true
      style: simple
      explode: false
      schema:
        type:
        - string
        - 'null'
        - integer
        format: int64
        description: To get individual category details
        pattern: ([0-9]+)
  securitySchemes:
    iam-oauth2-schema:
      $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema
x-entity: Helpcenter