{
  "opencollection": "1.0.0",
  "info": {
    "name": "Helpcenter ArticleFeedback API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "ArticleFeedback",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List feedback comments on article translation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/articles/:articleId/translations/:locale/feedbacks",
            "params": [
              {
                "name": "createdTimeRange",
                "value": "",
                "type": "query",
                "description": "Key that filters comments created within a specific date and time range. Enter the dates in the ISO date format of 'yyyy-MM-ddThh:mm:ss.SSSZ,yyyy-MM-ddThh:mm:ss.SSSZ'"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of comments to list. Default value is 10."
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the comments must be fetched. Default value is 1."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Key that sorts the comments based on a specific attribute: createdTime. To sort the comments in descending order, append a '-' before the value"
              },
              {
                "name": "articleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "locale",
                "value": "",
                "type": "path",
                "description": "Locale of an article translation in which feedback comments to be fetched"
              }
            ]
          },
          "docs": "This API lists a particular number of comments received on a translation of an article, based on the limit defined."
        },
        {
          "info": {
            "name": "Get details of feedback comment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/articleFeedbacks/:feedbackId",
            "params": [
              {
                "name": "feedbackId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API fetches the details of a particular feedback comment."
        },
        {
          "info": {
            "name": "Delete feedback comment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v1/articleFeedbacks/:feedbackId",
            "params": [
              {
                "name": "feedbackId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This API deletes a particular feedback comment from an article."
        },
        {
          "info": {
            "name": "List feedback comments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/articleFeedbacks",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of comments to list. Default value is 10."
              },
              {
                "name": "rootCategoryIds",
                "value": "",
                "type": "query",
                "description": "Filter article feedback comments based on rootCategoryIds"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Index number, starting from which the comments must be fetched. Default value is 1."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Key that sorts the comments based on a specific attribute: createdTime. To sort the comments in descending order, append a '-' before the value."
              },
              {
                "name": "departmentIds",
                "value": "",
                "type": "query",
                "description": "Filter article feedback comments based on department ids"
              },
              {
                "name": "locale",
                "value": "",
                "type": "path",
                "description": "Locale of an article translation in which feedback comments to be fetched"
              },
              {
                "name": "timeRange",
                "value": "",
                "type": "query",
                "description": "Key that filters comments created within a specific date and time range. Enter the time limit in the formats of !@LAST_24_HRS,@! !@LAST_7_DAYS,@! !@LAST_30_DAYS,@! !@LAST_365_DAYS@! and !@yyyy-MM-ddThh:mm:ss.SSSZ,yyyy-MM-ddThh:mm:ss.SSSZ@!. Default value : LAST_7_DAYS."
              }
            ]
          },
          "docs": "This API lists a particular number of comments received on an article, based on the limit defined."
        },
        {
          "info": {
            "name": "Convert feedback comment into ticket",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v1/articleFeedbacks/:feedbackId/addAsTicket",
            "params": [
              {
                "name": "feedbackId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API adds a feedback comment as a ticket in your help desk portal and assigns it to the author of the article."
        }
      ]
    }
  ],
  "bundled": true
}