{ "openapi" : "3.1.0", "info" : { "title" : "Article", "version" : "1.0.0" }, "paths" : { "/api/v1/articles/updateMany" : { "post" : { "tags" : [ "Article" ], "summary" : "Update Articles", "description" : "Simultaneously updates certain properties of multiple articles. _Note_: The properties that can be bulk updated are: categoryId and, status.", "operationId" : "updateManyArticles", "x-mcp-group" : [ "KB Admin", "Manage KB Moderation", "Manage KB Templates", "Manage KB Articles" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/articleUpdateJson" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ] } ] } }, "/api/v1/articleTags" : { "get" : { "tags" : [ "Article" ], "summary" : "Get Tags Associated with Articles", "description" : "Retrieves tags associated with articles, with pagination support.", "operationId" : "getArticleTags", "x-mcp-group" : [ "Tags Management", "KB Admin", "KB Dashboard", "Manage KB Templates", "View KB Templates", "Manage KB Articles", "View KB Articles", "View KB" ], "parameters" : [ { "name" : "searchString", "in" : "query", "required" : false, "schema" : { "type" : [ "string" ], "pattern" : "[a-z0-9\\_\\-\\+\\%\\P{InBasicLatin}\\s]+", "x-regex-name" : "vaildtag" }, "style" : "form", "explode" : true, "description" : "Keyword for searching tags" }, { "name" : "rootCategoryIds", "in" : "query", "required" : false, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "maxItems" : 10 }, "style" : "form", "explode" : true, "description" : "Filters by root category IDs" }, { "name" : "departmentIds", "in" : "query", "required" : false, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "maxItems" : 10 }, "style" : "form", "explode" : true, "description" : "Filters by department IDs" }, { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "limit", "in" : "query", "description" : "Number of tags to fetch", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "null", "integer" ], "format" : "int32", "maximum" : 50, "minimum" : 1, "pattern" : "([0-9]+)" } }, { "name" : "from", "in" : "query", "description" : "Index number starting from which the tags must be fetched", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "null", "integer" ], "format" : "int32", "minimum" : 1, "pattern" : "([0-9]+)" } } ], "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse" }, "200" : { "$ref" : "#/components/responses/articleTagsResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.articles.READ" ] } ] } }, "/api/v1/articles" : { "get" : { "tags" : [ "Article" ], "summary" : "List articles", "description" : "This API fetches a specific number of articles from your knowledge base, based on the limit defined.", "operationId" : "getArticles", "x-mcp-group" : [ "KB Admin", "KB Dashboard", "Manage KB Category", "View KB Category", "Manage KB Moderation", "View KB Moderation", "Manage KB Recyclebin", "View KB Recyclebin", "Manage KB Templates", "View KB Templates", "Manage KB Articles", "View KB Articles", "Manage KB Feedbacks", "View KB Feedbacks", "View KB" ], "parameters" : [ { "name" : "permission", "in" : "query", "description" : "Permission of the article.Values allowed are
ALL

REGISTEREDUSERS

AGENTS", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "array" ], "description" : "Access permission for the article. Values allowed are: @ALL@, @REGISTEREDUSERS@, and @AGENTS@", "items" : { "type" : [ "string" ], "enum" : [ "ALL", "REGISTEREDUSERS", "AGENTS" ] }, "uniqueItems" : true } }, { "name" : "authorId", "in" : "query", "description" : "ID of article owner", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "ID of article owner" } }, { "name" : "limit", "in" : "query", "description" : "Number of tags to fetch", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer", "string", "null" ], "format" : "int32", "description" : "Number of articles to fetch", "maximum" : 50, "minimum" : 1, "pattern" : "([0-9]+)" } }, { "name" : "from", "in" : "query", "description" : "Index number starting from which the tags must be fetched", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer", "string", "null" ], "format" : "int32", "description" : "Index number starting from which the articles must be fetched.", "minimum" : 1, "pattern" : "([0-9]+)", "default" : 1 } }, { "name" : "categoryId", "in" : "query", "description" : "ID of the category to which the article belongs", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "ID of the category to which the article belongs" } }, { "name" : "status", "in" : "query", "description" : "Publishing status of the article. Values allowed are Draft, Published, Review, Expired, Unpublished", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "array" ], "description" : "Publishing status of the article. Values allowed are @Draft@, @Published@, @Review@, @Expired@, @Unpublished@", "items" : { "type" : [ "string" ], "enum" : [ "Draft", "Published", "Review", "Expired", "Unpublished" ] }, "uniqueItems" : true } }, { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "sortBy", "in" : "query", "description" : "Key that sorts the articles based on a specific attribute: !@createdTime,@! or !@modifiedTime@! or !@likeCount@! or !@viewCount@! or !@feedbackCount@! or !@dislikeCount@! or !@positionArticle@!", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "description" : "Key that sorts the articles based on a specific attribute: !@createdTime,@! or !@modifiedTime@! or !@likeCount@! or !@viewCount@! or !@feedbackCount@! or !@dislikeCount@! or !@positionArticle@!", "enum" : [ "createdTime", "modifiedTime", "likeCount", "viewCount", "feedbackCount", "dislikeCount", "-createdTime", "-modifiedTime", "-likeCount", "-viewCount", "-feedbackCount", "-dislikeCount" ] } }, { "name" : "modifiedTimeRange", "in" : "query", "description" : "Key that filters articles modified 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'", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "null" ], "description" : "Key that filters articles modified 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'", "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null" } }, { "name" : "expiryTimeRange", "in" : "query", "description" : "Key that filters articles which will expire 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'", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "null" ], "description" : "Key that filters articles which will expire 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'", "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z)),(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null" } }, { "name" : "isTemplate", "in" : "query", "description" : "Is it a template", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean", "default" : false, "description" : "To search the article template" } } ], "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse" }, "200" : { "$ref" : "#/components/responses/listAllNewArticle" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.articles.READ" ] } ] }, "post" : { "tags" : [ "Article" ], "summary" : "Create article", "description" : "Creates a new article in the knowledge base.", "operationId" : "createArticle", "x-mcp-group" : [ "KB Admin", "Manage KB Templates", "Manage KB Articles" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "templateId", "in" : "header", "description" : "ID of the template mapped with the article", "required" : false, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } } ], "requestBody" : { "$ref" : "#/components/requestBodies/addArticleJson" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "#/components/responses/articleCUDJson" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.articles.CREATE" ] } ] } }, "/api/v1/articles/{id}" : { "get" : { "tags" : [ "Article" ], "summary" : "Get article", "description" : "This API fetches an article from your knowledge base.", "operationId" : "getArticle", "x-mcp-group" : [ "KB Admin", "KB Dashboard", "Manage KB Category", "View KB Category", "Manage KB Moderation", "View KB Moderation", "Manage KB Recyclebin", "View KB Recyclebin", "Manage KB Templates", "View KB Templates", "Manage KB Articles", "View KB Articles", "Manage KB Feedbacks", "View KB Feedbacks", "View KB" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "include", "in" : "query", "description" : "Additional information to include in the response. Possible values: secondaryTitles, quickEdit, followersCount, articleSummary", "required" : false, "style" : "simple", "explode" : false, "schema" : { "type" : "array", "items" : { "type" : [ "string", "null" ], "enum" : [ "secondaryTitles", "quickEdit", "followersCount", "articleSummary" ] }, "uniqueItems" : true } }, { "name" : "version", "in" : "query", "description" : "Version number of the article", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "description" : "Version number of the article", "maxLength" : 100, "minLength" : 0 } } ], "responses" : { "200" : { "$ref" : "#/components/responses/getArticleNewJson" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.articles.READ" ] } ] }, "patch" : { "tags" : [ "Article" ], "summary" : "Update Article", "description" : "Updates an existing article in the knowledge base.", "operationId" : "updateArticle", "x-mcp-group" : [ "KB Admin", "Manage KB Moderation", "Manage KB Templates", "Manage KB Articles" ], "parameters" : [ { "description" : "Unique ID of the article to be updated", "name" : "id", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "$ref" : "./Common.json#/components/schemas/articleIdInPathSchema" } }, { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "templateId", "in" : "header", "description" : "ID of the template mapped with the article", "required" : false, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } } ], "requestBody" : { "$ref" : "#/components/requestBodies/updateArticleJson" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "#/components/responses/articleCUDJson" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ] } ] } }, "/api/v1/articles/checkPermalinkAvailability" : { "post" : { "tags" : [ "Article" ], "summary" : "Validate permalink", "description" : "This API validates if a permalink is available for a help article.", "operationId" : "checkArticlePermalinkAvailability", "x-mcp-group" : [ "KnowledgeBase_Publishing", "KB Admin", "Manage KB Templates", "Manage KB Articles" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/validatePermalinkRequestBody" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "#/components/responses/validatePermalinkResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.articles.READ" ] } ] } }, "/api/v1/articles/count" : { "get" : { "tags" : [ "Article" ], "summary" : "Get article count", "description" : "This API returns the number of articles published in the knowledge base of your help desk portal.", "operationId" : "getArticleCount", "x-mcp-group" : [ "KB Admin", "KB Dashboard", "Manage KB Category", "View KB Category", "Manage KB Templates", "View KB Templates", "Manage KB Articles", "View KB Articles", "View KB" ], "parameters" : [ { "name" : "permission", "in" : "query", "description" : "Permission of the article.Values allowed are
ALL

REGISTEREDUSERS

AGENTS", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "array" ], "description" : "Access permission for the article. Values allowed are: @ALL@, @REGISTEREDUSERS@, and @AGENTS@", "items" : { "type" : [ "string" ], "enum" : [ "ALL", "REGISTEREDUSERS", "AGENTS" ] }, "uniqueItems" : true } }, { "name" : "authorId", "in" : "query", "description" : "ID of article owner", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "ID of article owner" } }, { "name" : "categoryId", "in" : "query", "description" : "ID of the category to which the article belongs", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "ID of the category to which the article belongs" } }, { "name" : "status", "in" : "query", "description" : "Publishing status of the article. Values allowed are Draft, Published, Review, Expired, Unpublished", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "array" ], "description" : "Publishing status of the article. Values allowed are @Draft@, @Published@, @Review@, @Expired@, @Unpublished@", "items" : { "type" : [ "string" ], "enum" : [ "Draft", "Published", "Review", "Expired", "Unpublished" ] }, "uniqueItems" : true } }, { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "isTemplate", "in" : "query", "description" : "Is it a template", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean", "default" : false, "description" : "To search the article template" } } ], "responses" : { "200" : { "$ref" : "#/components/responses/articlesCountJson" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.articles.READ" ] } ] } }, "/api/v1/convertCloudDocumentToHtml" : { "post" : { "tags" : [ "Article" ], "summary" : "Import File from Cloud", "description" : "Imports files from a cloud storage provider and converts them into HTML for publishing as articles.", "operationId" : "importFileFromCloudAndConvertToHtml", "x-mcp-group" : [ "KB Admin", "Manage KB Templates", "Manage KB Articles" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/convertCloudDocumentContentToHtmlRequestBody" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse" }, "200" : { "$ref" : "#/components/responses/convertFileToHtmlJson" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.articles.CREATE" ] } ] } }, "/api/v1/articles/preview" : { "post" : { "tags" : [ "Article" ], "summary" : "Preview article", "description" : "This API shows a preview of help articles, through which you can check the content for formatting, alignment, and grammar/spelling errors and get the look and feel of the help article even before publishing it.", "operationId" : "previewArticle", "x-mcp-group" : [ "KB Admin", "Manage KB Templates", "Manage KB Articles" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/previewJson" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "#/components/responses/previewJson" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ] } ] } }, "/api/v1/articles/uploadExternalImagesToGallery" : { "post" : { "tags" : [ "Article" ], "summary" : "Migrate External Images to KB Gallery", "description" : "Migrates external image URLs embedded in the provided article HTML content to the knowledge base gallery. Note: Images matching the specified class name can be excluded from migration.", "operationId" : "migrateExternalImagesToKbGallery", "x-mcp-group" : [ "KB Admin", "Manage KB Templates", "Manage KB Articles" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/updateExternalImageUrlsPayload" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse" }, "200" : { "$ref" : "#/components/responses/externalImageUrlMigrationResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ] } ] } }, "/api/v1/articles/moveToTrash" : { "post" : { "tags" : [ "Article" ], "summary" : "Move articles to trash", "description" : "This API moves articles to the Recycle Bin", "operationId" : "deleteArticle", "x-mcp-group" : [ "KB Admin", "Manage KB Recyclebin", "Manage KB Templates", "Manage KB Articles" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/trashArticles_articleIdsJson" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.articles.DELETE" ] } ] } }, "/api/v1/tickets/{ticketId}/articleSuggestion" : { "get" : { "tags" : [ "Article" ], "summary" : "Get Suggested Articles for Ticket", "description" : "Retrieves help articles relevant to resolving a ticket, with pagination support.", "operationId" : "suggestArticlesForTicket", "x-mcp-group" : [ "KB Admin", "Manage KB Articles", "View KB Articles", "View KB" ], "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Number of tags to fetch", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer", "string", "null" ], "format" : "int32", "description" : "Number of articles to fetch", "maximum" : 50, "minimum" : 1, "pattern" : "([0-9]+)" } }, { "name" : "from", "in" : "query", "description" : "Index number starting from which the tags must be fetched", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer", "string", "null" ], "format" : "int32", "description" : "Index number starting from which the articles must be fetched.", "minimum" : 1, "pattern" : "([0-9]+)", "default" : 1 } }, { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "departmentId", "in" : "query", "description" : "ID of the department from which help articles must be fetched. Note: Provide 0 to fetch help articles from all departments.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "description" : "ID of the department to which the help article belongs. If you want to include help articles from all departments, pass 0 as the value of this key", "pattern" : "([0-9]+)" } }, { "name" : "ticketId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } } ], "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "./ArticleTranslation.json#/components/responses/translationListWithRecycleBinEntityWrapper" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.articles.READ" ] } ] } }, "/api/v1/articles/stopAutoTranslate" : { "post" : { "tags" : [ "Article" ], "summary" : "Stop Article Auto-Translation", "description" : "Stops auto-translation jobs that are currently in progress for one or more articles.", "operationId" : "stopArticleAutoTranslation", "x-mcp-group" : [ "KB Admin", "Manage KB Articles" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/autoTranslationMassActionJson" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "./KBTranslationMassActionResponse.json#/components/responses/kbTranslationMassActionResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ] } ] } }, "/api/v1/articles/scheduleAutoTranslate" : { "post" : { "tags" : [ "Article" ], "summary" : "Restart Article Auto-Translation", "description" : "Restarts auto-translation jobs that have previously failed for one or more articles.", "operationId" : "restartArticleAutoTranslation", "x-mcp-group" : [ "KnowledgeBase_Publishing", "KB Admin", "Manage KB Articles" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/autoTranslationMassActionJson" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "./KBTranslationMassActionResponse.json#/components/responses/kbTranslationMassActionResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ] } ] } }, "/api/v1/articles/{articleId}/history" : { "get" : { "tags" : [ "Article" ], "summary" : "Get Article History", "description" : "Retrieves the event history of an article, with pagination support.", "operationId" : "getArticleHistory", "x-mcp-group" : [ "KB Admin", "Manage KB Articles", "View KB Articles", "View KB" ], "parameters" : [ { "name" : "from", "in" : "query", "description" : "Index number starting from which the history entries must be fetched", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "description" : "Index number starting from which the history entries must be fetched", "default" : 1, "minimum" : 1 } }, { "name" : "limit", "in" : "query", "description" : "Number of history entries to fetch", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "description" : "Number of history entries to fetch", "default" : 10, "minimum" : 1, "maximum" : 100 } }, { "name" : "events", "in" : "query", "description" : "Filters history by event type. Multiple values can be provided by separating them with commas. Possible values: CREATED, SEO_INFO_ADDED, TAGS_ADDED, ATTACHMENT_ADDED, ATTACHMENT_REMOVED, TAGS_EDITED, STATUS_CHANGED, DISPALY_PERMISSION_CHANGED, PERMALINK_EDITED, OWNER_CHANGED, SECTION_CHANGED, TITLE_EDITED, SEO_INFO_EDITED, VERSION_CREATED, MOVED_TO_TRASH, RESTORED, ATTACHMENT_MODIFIED, VERSION_REVERTED, TAGS_DELETED, COMMENTS_ADDED, COMMENTS_EDITED, COMMENTS_DELETED, VERSION_UPDATED, VERSION_QUICKEDIT, VERSION_DELETED, SEO_TITLE_CHANGED, SEO_KEYWORDS_CHANGED, SEO_DESCRIPTION_CHANGED, SEO_STATUS_CHANGED", "required" : false, "style" : "form", "explode" : false, "schema" : { "description" : "Filters history by event type. Multiple values can be provided by separating them with commas. Possible values: CREATED, SEO_INFO_ADDED, TAGS_ADDED, ATTACHMENT_ADDED, ATTACHMENT_REMOVED, TAGS_EDITED, STATUS_CHANGED, DISPALY_PERMISSION_CHANGED, PERMALINK_EDITED, OWNER_CHANGED, SECTION_CHANGED, TITLE_EDITED, SEO_INFO_EDITED, VERSION_CREATED, MOVED_TO_TRASH, RESTORED, ATTACHMENT_MODIFIED, VERSION_REVERTED, TAGS_DELETED, COMMENTS_ADDED, COMMENTS_EDITED, COMMENTS_DELETED, VERSION_UPDATED, VERSION_QUICKEDIT, VERSION_DELETED, SEO_TITLE_CHANGED, SEO_KEYWORDS_CHANGED, SEO_DESCRIPTION_CHANGED, SEO_STATUS_CHANGE", "type" : [ "array" ], "items" : { "type" : "string", "pattern" : "[A-Z_]{0,30}", "enum" : [ "CREATED", "SEO_INFO_ADDED", "TAGS_ADDED", "ATTACHMENT_ADDED", "ATTACHMENT_REMOVED", "TAGS_EDITED", "STATUS_CHANGED", "DISPALY_PERMISSION_CHANGED", "PERMALINK_EDITED", "OWNER_CHANGED", "SECTION_CHANGED", "TITLE_EDITED", "SEO_INFO_EDITED", "VERSION_CREATED", "MOVED_TO_TRASH", "RESTORED", "ATTACHMENT_MODIFIED", "VERSION_REVERTED", "TAGS_DELETED", "COMMENTS_ADDED", "COMMENTS_EDITED", "COMMENTS_DELETED", "VERSION_UPDATED", "VERSION_QUICKEDIT", "VERSION_DELETED", "SEO_TITLE_CHANGED", "SEO_KEYWORDS_CHANGED", "SEO_DESCRIPTION_CHANGED", "SEO_STATUS_CHANGED" ] }, "maxItems" : 10, "uniqueItems" : true } }, { "name" : "userIds", "description" : "Filters history by user who performed the action", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "maxItems" : 10 } }, { "name" : "fromTime", "in" : "query", "description" : "Filters events from this time. Time should be in GMT format", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "null" ], "description" : "Filters events from this time. Time should be in GMT format", "maxLength" : 100, "minLength" : 0, "pattern" : "(([1-3])([0-9]{3})(-)([0-1])([0-9])(-)([0-3])([0-9])(\\ )([0-2])([0-9])(\\:)([0-6])([0-9]))|(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null" } }, { "name" : "toTime", "in" : "query", "description" : "Filters events up to this time. Time should be in GMT format", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "null" ], "description" : "Filters events up to this time. Time should be in GMT format.", "maxLength" : 100, "minLength" : 0, "pattern" : "(([1-3])([0-9]{3})(-)([0-1])([0-9])(-)([0-3])([0-9])(\\ )([0-2])([0-9])(\\:)([0-6])([0-9]))|(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null" } }, { "name" : "articleId", "in" : "path", "description" : "Unique ID of the article", "required" : true, "style" : "simple", "explode" : true, "schema" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "200" : { "$ref" : "#/components/responses/getArticleHistoryResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.articles.READ" ] } ] } }, "/api/v1/articles/{articleId}/insights" : { "get" : { "tags" : [ "Article" ], "summary" : "Get Article Insights", "description" : "Retrieves basic insight metrics for a specific article.", "operationId" : "getArticleInsights", "x-mcp-group" : [ "KnowledgeBase_Publishing", "KB Admin", "KB Dashboard", "Manage KB Articles", "View KB Articles", "View KB" ], "parameters" : [ { "name" : "articleId", "in" : "path", "description" : "Unique ID of the article", "required" : true, "style" : "simple", "explode" : true, "schema" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "200" : { "$ref" : "#/components/responses/getArticleInsightsResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.articles.READ" ] } ] } }, "/api/v1/articles/shareDocsWorkspace" : { "post" : { "tags" : [ "Article" ], "summary" : "Share docs workspace", "description" : "Shares docs workspace.", "operationId" : "shareDocsWorkspace", "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "templateId", "in" : "header", "description" : "ID of the template mapped with the article", "required" : false, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } } ], "requestBody" : { "$ref" : "#/components/requestBodies/addArticleJson" }, "responses" : { "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" }, "200" : { "$ref" : "./Common.json#/components/responses/emptyResponse" }, "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.articles.UPDATE" ] } ] } }, "/api/v1/articles/countByCategoryIds" : { "get" : { "tags" : [ "Article" ], "summary" : "Get Article Count By Category IDs", "description" : "This API retrieves the count of articles grouped by specified category IDs.", "operationId" : "getArticleCountByCategoryIds", "parameters" : [ { "name" : "rootCategoryIds", "in" : "query", "description" : "Comma-separated list of root category IDs to fetch article counts for", "required" : false, "style" : "form", "explode" : false, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "maxItems" : 50 } }, { "name" : "categoryIds", "in" : "query", "description" : "Category ids", "required" : false, "style" : "form", "explode" : false, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "maxItems" : 50 } }, { "name" : "permission", "in" : "query", "description" : "Access permission for the article. Values allowed are: ALL_USERS, REGISTERED_USERS, AGENTS_ONLY", "required" : false, "style" : "form", "explode" : false, "schema" : { "type" : [ "array" ], "items" : { "type" : "string", "enum" : [ "ALL_USERS", "REGISTERED_USERS", "AGENTS_ONLY", "ALL", "REGISTEREDUSERS", "AGENTS" ] }, "maxItems" : 3 } }, { "name" : "status", "in" : "query", "description" : "Publishing status of the article. Values allowed are: Draft, Published, Review, Expired", "required" : false, "style" : "form", "explode" : false, "schema" : { "type" : [ "array" ], "items" : { "type" : "string", "enum" : [ "DRAFT", "PUBLISH", "REVIEW", "EXPIRED", "Draft", "Published", "Review", "Expired" ] }, "maxItems" : 4 } }, { "name" : "groupIds", "in" : "query", "description" : "Group category ids", "required" : false, "style" : "form", "explode" : false, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "maxItems" : 10 } }, { "name" : "locale", "in" : "query", "description" : "Locale of the translation", "required" : false, "style" : "form", "explode" : false, "schema" : { "type" : [ "array" ], "items" : { "type" : "string", "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)" }, "maxItems" : 5 } }, { "name" : "categoryPresence", "in" : "query", "description" : "Is category present / not trashed flag", "required" : false, "schema" : { "type" : "boolean" } }, { "name" : "articlePresence", "in" : "query", "description" : "Is article present / not trashed flag", "required" : false, "schema" : { "type" : "boolean" } }, { "name" : "categoryStatus", "in" : "query", "description" : "Status of category. Values allowed are: SHOW_IN_HELPCENTER, HIDE_IN_HELPCENTER, DISABLED", "required" : false, "style" : "form", "explode" : false, "schema" : { "type" : [ "array" ], "items" : { "type" : "string", "enum" : [ "SHOW_IN_HELPCENTER", "HIDE_IN_HELPCENTER", "DISABLED" ] }, "maxItems" : 3 } }, { "name" : "translationOwnerIds", "in" : "query", "description" : "Translation owner ids", "required" : false, "style" : "form", "explode" : false, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "maxItems" : 5 } }, { "name" : "articleOwnerIds", "in" : "query", "description" : "Article owner ids", "required" : false, "style" : "form", "explode" : false, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "maxItems" : 5 } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "200" : { "$ref" : "#/components/responses/articleCountByCategoryIdsResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.articles.READ" ] } ] } } }, "components" : { "schemas" : { "repositionJson" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "webUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "title" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0 }, "authorId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "articleNumber" : { "$ref" : "./ArticleTranslation.json#/components/schemas/articleNumber" } }, "required" : [ "authorId", "id", "title", "webUrl", "articleNumber" ] }, "repositioningData" : { "type" : [ "array", "null" ], "items" : { "$ref" : "#/components/schemas/repositionJson" } }, "articleIdsData" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "availableLocaleTranslationsObjectNew" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "latestVersionStatus" : { "type" : [ "string", "null" ], "enum" : [ "Published", "Draft", "Review", "Expired", "Unpublished", "Auto-translate Pending" ], "maxLength" : 100, "minLength" : 0 }, "isTrashed" : { "type" : [ "boolean", "null" ] }, "translationId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "latestVersion" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "isLocked" : { "type" : [ "boolean", "null" ] }, "latestPublishedVersion" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "href" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "locale" : { "type" : [ "string", "null" ], "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ], "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)", "maxLength" : 100, "minLength" : 0 }, "authorId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "translationState" : { "type" : [ "string", "null" ], "enum" : [ "OUTDATED", "UP-TO-DATE", "AUTO-TRANSLATE INPROGRESS", "AUTO-TRANSLATE FAILED" ], "maxLength" : 100, "minLength" : 0 }, "status" : { "type" : [ "string", "null" ], "enum" : [ "Published", "Draft", "Review", "Expired", "Unpublished", "Auto-translate Pending" ], "maxLength" : 100, "minLength" : 0 } }, "required" : [ "authorId", "href", "isLocked", "isTrashed", "latestPublishedVersion", "latestVersion", "latestVersionStatus", "locale", "status", "translationId", "translationState" ] }, "availableLocaleTranslationsNew" : { "type" : [ "array", "null" ], "items" : { "$ref" : "#/components/schemas/availableLocaleTranslationsObjectNew" } }, "seo" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "keywords" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "isEnabled" : { "type" : [ "boolean", "null" ] }, "description" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "title" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 } }, "required" : [ "description", "isEnabled", "keywords", "title" ] }, "metrics" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "feedbackCount" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" }, "templateUsageCount" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" }, "unlikeCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "lastUsageTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "dislikeCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "likeCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "viewCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "lastActivityTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "usageCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "dislikeCount", "feedbackCount", "lastActivityTime", "lastUsageTime", "likeCount", "templateUsageCount", "unlikeCount", "usageCount", "viewCount" ] }, "getArticleNewJson" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "modifiedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "departmentId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "dislikeCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "modifierId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "likeCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "ownerId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "latestVersionModifierId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "translationState" : { "type" : [ "string", "null" ], "enum" : [ "OUTDATED", "UP-TO-DATE", "AUTO-TRANSLATE INPROGRESS", "AUTO-TRANSLATE FAILED" ], "maxLength" : 100, "minLength" : 0 }, "isTrashed" : { "type" : [ "boolean", "null" ] }, "isTemplate" : { "type" : [ "boolean", "null" ] }, "isLocked" : { "type" : [ "boolean", "null" ] }, "createdTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "translationSource" : { "$ref" : "./ArticleTranslation.json#/components/schemas/translationSourceJson" }, "latestVersionStatus" : { "type" : [ "string", "null" ], "enum" : [ "Published", "Draft", "Review", "Expired", "Unpublished" ], "maxLength" : 100, "minLength" : 0 }, "author" : { "$ref" : "./ArticleTranslation.json#/components/schemas/author" }, "reviewedBy" : { "$ref" : "./ArticleTranslation.json#/components/schemas/reviewedBy" }, "currentVersion" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "commentCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "tags" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-z0-9_\\-+%\\P{InBasicLatin}\\s]+" }, "uniqueItems" : false }, "sourceLocale" : { "type" : [ "string", "null" ], "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ], "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)", "maxLength" : 100, "minLength" : 0 }, "translationId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "webUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "feedbackCount" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" }, "latestPublishedVersion" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "position" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" }, "metrics" : { "$ref" : "#/components/schemas/metrics" }, "templateUsageCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "templateUsedUsersCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "templateLastUpdatedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "permalink" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*" }, "latestVersionModifiedBy" : { "$ref" : "./ArticleTranslation.json#/components/schemas/modifiedBy" }, "status" : { "type" : [ "string", "null" ], "enum" : [ "Published", "Draft", "Review", "Expired", "Unpublished" ], "maxLength" : 100, "minLength" : 0 }, "attachments" : { "$ref" : "./ArticleTranslation.json#/components/schemas/attachmentArr" }, "reviewedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "creatorId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "locale" : { "type" : [ "string", "null" ], "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ], "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)", "maxLength" : 100, "minLength" : 0 }, "title" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0 }, "expiryDate" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "modifiedBy" : { "$ref" : "./ArticleTranslation.json#/components/schemas/modifiedBy" }, "viewCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "seo" : { "$ref" : "#/components/schemas/seo" }, "owner" : { "$ref" : "./ArticleTranslation.json#/components/schemas/owner" }, "summary" : { "type" : [ "string", "null" ], "maxLength" : 65553, "minLength" : 0 }, "isFollowing" : { "type" : [ "boolean", "null" ] }, "isArticleSummaryPresent" : { "description" : "Indicates whether an article summary is present. Possible values: • true = summary is present • false = summary is not present", "type" : [ "boolean", "null" ] }, "myVote" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "permission" : { "type" : [ "string", "null" ], "enum" : [ "ALL", "REGISTEREDUSERS", "AGENTS" ], "maxLength" : 100, "minLength" : 0 }, "authorId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "usageCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "rootCategoryId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "answer" : { "type" : [ "string", "null" ], "maxLength" : 16777215, "minLength" : 0 }, "createdBy" : { "$ref" : "./ArticleTranslation.json#/components/schemas/createdBy" }, "latestVersion" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "portalUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "attachmentCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "availableLocaleTranslations" : { "$ref" : "#/components/schemas/availableLocaleTranslationsNew" }, "category" : { "$ref" : "./ArticleTranslation.json#/components/schemas/category" }, "categoryId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "articleNumber" : { "$ref" : "./ArticleTranslation.json#/components/schemas/articleNumber" } }, "required" : [ "answer", "attachmentCount", "attachments", "author", "authorId", "availableLocaleTranslations", "category", "categoryId", "commentCount", "createdBy", "createdTime", "creatorId", "currentVersion", "departmentId", "dislikeCount", "expiryDate", "feedbackCount", "id", "isFollowing", "isArticleSummaryPresent", "isLocked", "isTemplate", "isTrashed", "latestPublishedVersion", "latestVersion", "latestVersionModifiedBy", "latestVersionModifierId", "latestVersionStatus", "likeCount", "locale", "metrics", "modifiedBy", "modifiedTime", "modifierId", "myVote", "owner", "ownerId", "permalink", "permission", "portalUrl", "position", "reviewedBy", "reviewedTime", "rootCategoryId", "seo", "sourceLocale", "status", "summary", "tags", "templateLastUpdatedTime", "templateUsageCount", "templateUsedUsersCount", "title", "translationId", "translationSource", "translationState", "usageCount", "viewCount", "webUrl", "articleNumber" ] }, "articleCommonJson" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "summary" : { "type" : [ "string", "null" ], "maxLength" : 65553, "minLength" : 0 }, "modifiedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "latestVersionStatus" : { "type" : [ "string", "null" ], "enum" : [ "Published", "Draft", "Review", "Expired", "Unpublished" ], "maxLength" : 100, "minLength" : 0 }, "permission" : { "type" : [ "string", "null" ], "enum" : [ "ALL", "REGISTEREDUSERS", "AGENTS" ], "maxLength" : 100, "minLength" : 0 }, "title" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0 }, "authorId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "latestVersion" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "webUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "createdTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "latestPublishedVersion" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "articleNumber" : { "$ref" : "./ArticleTranslation.json#/components/schemas/articleNumber" }, "permalink" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*" }, "status" : { "type" : [ "string", "null" ], "enum" : [ "Published", "Draft", "Review", "Expired", "Unpublished" ], "maxLength" : 100, "minLength" : 0 } }, "required" : [ "authorId", "createdTime", "id", "latestPublishedVersion", "latestVersion", "latestVersionStatus", "modifiedTime", "permalink", "permission", "status", "summary", "title", "webUrl", "articleNumber" ] }, "articleNewJson" : { "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/articleCommonJson" }, { "type" : [ "object", "null" ], "properties" : { "departmentId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "creatorId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "modifierId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "dislikeCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "likeCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "locale" : { "type" : [ "string", "null" ], "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ], "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)" }, "ownerId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "latestVersionModifierId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "translationState" : { "type" : [ "string", "null" ], "enum" : [ "OUTDATED", "UP-TO-DATE", "AUTO-TRANSLATE INPROGRESS", "AUTO-TRANSLATE FAILED" ] }, "isTrashed" : { "type" : [ "boolean", "null" ] }, "isTemplate" : { "type" : [ "boolean", "null" ] }, "templateUsageCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "templateUsedUsersCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "templateLastUpdatedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "isLocked" : { "type" : [ "boolean", "null" ] }, "modifiedBy" : { "$ref" : "./ArticleTranslation.json#/components/schemas/modifiedBy" }, "viewCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "translationSource" : { "$ref" : "./ArticleTranslation.json#/components/schemas/translationSourceJson" }, "owner" : { "$ref" : "./ArticleTranslation.json#/components/schemas/owner" }, "author" : { "$ref" : "./ArticleTranslation.json#/components/schemas/author" }, "usageCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "commentCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "rootCategoryId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "sourceLocale" : { "type" : [ "string", "null" ], "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ], "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)" }, "translationId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "createdBy" : { "$ref" : "./ArticleTranslation.json#/components/schemas/createdBy" }, "portalUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "feedbackCount" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" }, "attachmentCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "availableLocaleTranslations" : { "$ref" : "#/components/schemas/availableLocaleTranslationsNew" }, "position" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" }, "category" : { "$ref" : "./ArticleTranslation.json#/components/schemas/category" }, "categoryId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "latestVersionModifiedBy" : { "$ref" : "./ArticleTranslation.json#/components/schemas/modifiedBy" } }, "required" : [ "attachmentCount", "author", "availableLocaleTranslations", "category", "category", "categoryId", "commentCount", "createdBy", "creatorId", "departmentId", "dislikeCount", "feedbackCount", "isLocked", "isTemplate", "isTrashed", "latestVersionModifiedBy", "latestVersionModifierId", "likeCount", "locale", "modifiedBy", "modifierId", "owner", "ownerId", "portalUrl", "position", "rootCategoryId", "sourceLocale", "templateLastUpdatedTime", "templateUsageCount", "templateUsedUsersCount", "translationId", "translationSource", "translationState", "usageCount", "viewCount" ], "additionalProperties" : false }, { "$ref" : "./Article.json#/components/schemas/articleCommonJson" }, { "type" : [ "null", "object" ], "properties" : { "departmentId" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "creatorId" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "modifierId" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "dislikeCount" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "likeCount" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "locale" : { "type" : [ "string", "null" ], "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)" }, "ownerId" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "latestVersionModifierId" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "translationState" : { "type" : [ "string", "null" ], "enum" : [ "OUTDATED", "UP-TO-DATE", "AUTO-TRANSLATE INPROGRESS", "AUTO-TRANSLATE FAILED" ], "maxLength" : 100, "minLength" : 0 }, "isTrashed" : { "type" : [ "boolean", "null" ] }, "isTemplate" : { "type" : [ "boolean", "null" ] }, "templateUsageCount" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "templateUsedUsersCount" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "templateLastUpdatedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "isLocked" : { "type" : [ "boolean", "null" ] }, "modifiedBy" : { "$ref" : "./ArticleTranslation.json#/components/schemas/modifiedBy" }, "viewCount" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "articleNumber" : { "$ref" : "./ArticleTranslation.json#/components/schemas/articleNumber" }, "translationSource" : { "$ref" : "./ArticleTranslation.json#/components/schemas/translationSourceJson" }, "owner" : { "$ref" : "./ArticleTranslation.json#/components/schemas/owner" }, "author" : { "$ref" : "./ArticleTranslation.json#/components/schemas/author" }, "usageCount" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "commentCount" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "rootCategoryId" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "sourceLocale" : { "type" : [ "string", "null" ], "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)" }, "translationId" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "createdBy" : { "$ref" : "./ArticleTranslation.json#/components/schemas/createdBy" }, "portalUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "feedbackCount" : { "type" : [ "string", "null", "integer" ], "format" : "int32", "pattern" : "([0-9]+)" }, "attachmentCount" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "availableLocaleTranslations" : { "$ref" : "./Article.json#/components/schemas/availableLocaleTranslationsNew" }, "position" : { "type" : [ "string", "null", "integer" ], "format" : "int32", "pattern" : "([0-9]+)" }, "category" : { "$ref" : "./ArticleTranslation.json#/components/schemas/category" }, "categoryId" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "latestVersionModifiedBy" : { "$ref" : "./ArticleTranslation.json#/components/schemas/modifiedBy" } }, "required" : [ "attachmentCount", "author", "availableLocaleTranslations", "category", "category", "categoryId", "commentCount", "createdBy", "creatorId", "departmentId", "dislikeCount", "feedbackCount", "isLocked", "isTemplate", "isTrashed", "latestVersionModifiedBy", "latestVersionModifierId", "likeCount", "locale", "modifiedBy", "modifierId", "owner", "ownerId", "portalUrl", "position", "rootCategoryId", "sourceLocale", "templateLastUpdatedTime", "templateUsageCount", "templateUsedUsersCount", "translationId", "translationSource", "translationState", "usageCount", "viewCount" ] } ] }, "datanew" : { "type" : [ "array", "null" ], "items" : { "$ref" : "#/components/schemas/articleNewJson" } }, "imagesUrlsArray" : { "description" : "List of external image URLs found in the translation content", "type" : [ "array", "null" ], "items" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" } }, "articleHistoryCommentEntry" : { "type" : "object", "additionalProperties" : true, "properties" : { "id" : { "description" : "Unique ID of the comment", "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "isTrashed" : { "description" : "Indicates whether the comment is in the Recycle Bin. Possible values: true = in Recycle Bin, false = not in Recycle Bin.", "type" : [ "boolean", "null" ] }, "isPublic" : { "description" : "Indicates whether the comment is public. Possible values: true = public, false = private.", "type" : [ "boolean", "null" ] }, "status" : { "description" : "Status of the comment", "type" : [ "string", "null" ] }, "ticketId" : { "description" : "Unique ID of the associated ticket", "type" : [ "null", "string", "integer" ] }, "ticket" : { "description" : "Details of the associated ticket", "type" : [ "null", "object", "string" ] } } }, "articleHistoryEventEntry" : { "type" : "object", "additionalProperties" : true, "properties" : { "articleId" : { "description" : "Unique ID of the article", "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "event" : { "description" : "Type of event that occurred", "type" : "string" }, "eventTime" : { "description" : "Time when the event occurred", "type" : "string", "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "locale" : { "description" : "Language code of the affected translation", "type" : [ "string", "null" ] }, "addedCommentId" : { "description" : "Unique ID of the comment", "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "newStatus" : { "type" : [ "string", "null" ] }, "oldStatus" : { "type" : [ "string", "null" ] }, "addedTags" : { "type" : [ "array", "null" ], "items" : { "type" : "string" } }, "newPermalink" : { "type" : [ "string", "null" ] }, "newTitle" : { "type" : [ "string", "null" ] }, "oldDisplayPermission" : { "type" : [ "string", "null" ] }, "newDisplayPermission" : { "type" : [ "string", "null" ] }, "newSection" : { "type" : [ "string", "null" ] }, "oldSection" : { "type" : [ "string", "null" ] }, "oldOwner" : { "type" : [ "string", "null" ] }, "newOwner" : { "type" : [ "string", "null" ] }, "createdVersion" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "user" : { "type" : [ "null", "object" ], "additionalProperties" : true, "properties" : { "id" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "name" : { "type" : [ "string", "null" ] }, "photoURL" : { "type" : [ "string", "null" ] } } }, "addedTranslations" : { "type" : [ "string", "null" ], "description" : "Comma separated list of locales for which translations are added in this event." } }, "required" : [ "articleId", "event" ] }, "articleHistoryResponseJson" : { "type" : "object", "additionalProperties" : false, "description" : "List of history event entries", "properties" : { "comments" : { "type" : "array", "description" : "List of comments associated with the article", "items" : { "$ref" : "#/components/schemas/articleHistoryCommentEntry" } }, "data" : { "type" : "array", "description" : "List of history events associated with the article", "items" : { "$ref" : "#/components/schemas/articleHistoryEventEntry" } } }, "required" : [ "comments", "data" ] }, "articleInsightsResponseJson" : { "type" : "object", "additionalProperties" : false, "description" : "Article metrics / insights (sample-aligned with API_REPORT getArticleInsights).", "properties" : { "feedbackCount" : { "description" : "Number of feedback entries", "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "lastLikedTime" : { "description" : "Time when the article was last liked", "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "dislikeCount" : { "description" : "Number of dislikes", "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "lastUsageTime" : { "description" : "Time when the article was last used", "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "likeCount" : { "description" : "Number of likes", "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "attachmentCount" : { "description" : "Number of attachments", "type" : [ "integer", "null", "string" ], "format" : "int64", "pattern" : "([0-9]+)" }, "viewCount" : { "description" : "Number of times the article was viewed", "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "lastActivityTime" : { "description" : "Time of the last activity", "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "lastDislikedTime" : { "description" : "Time when the article was last disliked", "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "usageCount" : { "description" : "Number of times the article was used", "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "commentCount" : { "description" : "Number of comments", "type" : [ "integer", "null", "string" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "attachmentCount", "commentCount", "dislikeCount", "feedbackCount", "lastActivityTime", "likeCount", "usageCount", "viewCount" ] }, "articleCountByCategoryIdsObj" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "rootCategoryId" : { "description" : "Unique ID of the root category", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "categories" : { "description" : "List of categories with article counts under the root category", "type" : [ "array", "null" ], "items" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "id" : { "description" : "Unique ID of the category", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "articlesCount" : { "description" : "Number of articles in the category", "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" } } } } } } }, "responses" : { "listAllArticleForRepositioning" : { "description" : "listAllArticleForRepositioning template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "data" : { "$ref" : "#/components/schemas/repositioningData" } }, "required" : [ "data" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "data" : [ { "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Solutions/dv/22372000000281023", "id" : "22372000000281023", "articleNumber" : "106", "title" : "Importance of a Knowledge Base", "authorId" : "4000000012931" }, { "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Solutions/dv/22372000000209871", "id" : "22372000000209871", "articleNumber" : "107", "title" : "Importance of a Knowledge Base", "authorId" : "4000000012931" } ] } } } } } }, "articleCUDJson" : { "description" : "articleCUDJson template definitions", "content" : { "application/json" : { "schema" : { "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/getArticleNewJson" }, { "type" : [ "object", "null" ], "properties" : { "quickEdit" : { "$ref" : "./ArticleTranslation.json#/components/schemas/quickEditResponseTemplate" } }, "required" : [ "quickEdit" ], "additionalProperties" : false }, { "$ref" : "./Article.json#/components/schemas/getArticleNewJson" }, { "type" : [ "null", "object" ], "properties" : { "quickEdit" : { "$ref" : "./ArticleTranslation.json#/components/schemas/quickEditResponseTemplate" } }, "required" : [ "quickEdit" ] } ] }, "examples" : { "Valid responses Definitions" : { "value" : { "isTemplate" : false, "modifiedTime" : 1592999203000, "departmentId" : "24073000000006907", "dislikeCount" : "0", "modifierId" : "4000000000059", "likeCount" : "0", "latestVersionModifierId" : "4000000000060", "ownerId" : "4000000000059", "translationState" : "UP-TO-DATE", "isTrashed" : false, "quickEdit" : { "modifierId" : null, "modifiedBy" : null }, "createdTime" : 1592999203000, "id" : "4000000019059", "translationSource" : null, "latestVersionStatus" : "Published", "author" : { "photoURL" : null, "name" : "Hill", "id" : "4000000000059", "status" : "ACTIVE", "zuid" : "234543" }, "reviewedBy" : { "photoURL" : null, "name" : "Hill", "id" : "4000000000059", "status" : "ACTIVE", "zuid" : "234543" }, "currentVersion" : "1.0", "commentCount" : "0", "tags" : [ "first ticket" ], "sourceLocale" : "en", "translationId" : "4000000017294", "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Solutions/dv/4000000019059/en", "feedbackCount" : "0", "latestPublishedVersion" : "1.0", "metrics" : { "feedbackCount" : "0", "unlikeCount" : "0", "dislikeCount" : "0", "lastUsageTime" : null, "likeCount" : "0", "viewCount" : "0", "lastActivityTime" : null, "usageCount" : "0" }, "position" : "28", "permalink" : "answering-your-first-ticket", "latestVersionModifiedBy" : { "photoURL" : null, "name" : "will smith", "id" : "4000000000060", "status" : "ACTIVE", "zuid" : "234544" }, "status" : "Draft", "attachments" : [ ], "reviewedTime" : 1592999203000, "creatorId" : "4000000000059", "locale" : "en", "title" : "Answering your first ticket.", "expiryDate" : null, "modifiedBy" : { "photoURL" : null, "name" : "Hill", "id" : "4000000000059", "status" : "ACTIVE", "zuid" : "234543" }, "viewCount" : "0", "seo" : { "keywords" : "helpcenter, knowledge base", "isEnabled" : true, "description" : "Knowledge base", "title" : "Helpcenter and knowledge base" }, "owner" : { "photoURL" : null, "name" : "Hill", "id" : "4000000000059", "status" : "ACTIVE", "zuid" : "234543" }, "summary" : "Zoho Desk packs a bunch of features that are expressly there to help you respond to tickets smartly. The first of these, you've already discovered: Auto-Suggest Articles. Zoho Desk pulls up relevant articles on the ticket's content—so you can save ...", "isFollowing" : true, "isArticleSummaryPresent" : true, "myVote" : null, "permission" : "AGENTS", "authorId" : "22372000000094004", "usageCount" : "0", "rootCategoryId" : "4000000017276", "answer" : "The knowledge base is a key component of a good help center. This is where you can share the basics of using your products or services to your customers. Help articles and FAQs are great assets when it comes to answering the most fundamental questions your customers might have regarding your offerings. Help articles also ease the burden of your customer support agents by enabling self-service.", "createdBy" : { "photoURL" : null, "name" : "Hill", "id" : "4000000000059", "status" : "ACTIVE", "zuid" : "234543" }, "latestVersion" : "1.0", "portalUrl" : "https://desk.zoho.com/portal/zylker/en/kb/articles/answering-your-first-ticket", "attachmentCount" : "0", "availableLocaleTranslations" : [ { "latestVersionStatus" : "Published", "translationId" : "24073000007814015", "isTrashed" : false, "latestVersion" : "1.0", "isLocked" : false, "latestPublishedVersion" : "1.0", "href" : "https://desk.zoho.com/api/v1/articles/24073000007814013/translations/en?orgId=123456", "authorId" : "24073000000095005", "locale" : "en", "translationState" : "UP-TO-DATE", "status" : "Published" } ], "category" : { "name" : "General", "id" : "4000000017287", "locale" : "en" }, "categoryId" : "22372000000094160", "templateUsageCount" : "2", "templateUsedUsersCount" : "2", "templateLastUpdatedTime" : "2019-12-31T09:45:52.000Z" } } } } } }, "articleTagsResponse" : { "description" : "List of tag strings matching the search criteria", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "data" : { "description" : "List of tag strings matching the search criteria", "type" : [ "array", "null" ], "items" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-z0-9_\\-+%\\P{InBasicLatin}\\s]+" }, "uniqueItems" : false } }, "required" : [ "data" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "data" : [ "set conditions in merge", "conditional function in merge", "conditional text in mail merge" ] } } } } } }, "getArticleNewJson" : { "description" : "getArticleNewJson template definitions", "content" : { "application/json" : { "schema" : { "allOf" : [ { "type" : [ "object" ], "properties" : { "quickEdit" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 2, "minProperties" : 2, "properties" : { "modifierId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "modifiedBy" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 5, "minProperties" : 5, "properties" : { "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" }, "name" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0 }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "status" : { "type" : [ "string", "null" ], "enum" : [ "ACTIVE", "DISABLED", "LICENSE_DOWNGRADED", "DELETED", "ANONYMIZED", "CLOSED" ] }, "zuid" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" } }, "required" : [ "id", "name", "photoURL", "status", "zuid" ] } }, "required" : [ "modifiedBy", "modifierId" ] }, "secondaryTitles" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0 }, "uniqueItems" : false }, "followersCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "articleSummary" : { "description" : "Details of the article summary", "$ref" : "./ArticleTranslation.json#/components/schemas/articleSummary" } }, "additionalProperties" : false }, { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "modifiedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "departmentId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "dislikeCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "modifierId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "likeCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "ownerId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "latestVersionModifierId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "translationState" : { "type" : [ "string", "null" ], "enum" : [ "OUTDATED", "UP-TO-DATE", "AUTO-TRANSLATE INPROGRESS", "AUTO-TRANSLATE FAILED" ] }, "isTrashed" : { "type" : [ "boolean", "null" ] }, "isTemplate" : { "type" : [ "boolean", "null" ] }, "isLocked" : { "type" : [ "boolean", "null" ] }, "createdTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "translationSource" : { "$ref" : "./ArticleTranslation.json#/components/schemas/translationSourceJson" }, "latestVersionStatus" : { "type" : [ "string", "null" ], "enum" : [ "Published", "Draft", "Review", "Expired", "Unpublished" ] }, "author" : { "$ref" : "./ArticleTranslation.json#/components/schemas/author" }, "reviewedBy" : { "$ref" : "./ArticleTranslation.json#/components/schemas/reviewedBy" }, "currentVersion" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "commentCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "tags" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-z0-9_\\-+%\\P{InBasicLatin}\\s]+" }, "uniqueItems" : false }, "sourceLocale" : { "type" : [ "string", "null" ], "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ], "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)" }, "translationId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "webUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "feedbackCount" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" }, "latestPublishedVersion" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "position" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" }, "metrics" : { "$ref" : "#/components/schemas/metrics" }, "templateUsageCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "templateUsedUsersCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "templateLastUpdatedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "permalink" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*" }, "latestVersionModifiedBy" : { "$ref" : "./ArticleTranslation.json#/components/schemas/modifiedBy" }, "status" : { "type" : [ "string", "null" ], "enum" : [ "Published", "Draft", "Review", "Expired", "Unpublished" ] }, "attachments" : { "$ref" : "./ArticleTranslation.json#/components/schemas/attachmentArr" }, "reviewedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "creatorId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "locale" : { "type" : [ "string", "null" ], "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ], "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)" }, "title" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0 }, "expiryDate" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "modifiedBy" : { "$ref" : "./ArticleTranslation.json#/components/schemas/modifiedBy" }, "viewCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "seo" : { "$ref" : "#/components/schemas/seo" }, "owner" : { "$ref" : "./ArticleTranslation.json#/components/schemas/owner" }, "summary" : { "type" : [ "string", "null" ], "maxLength" : 65553, "minLength" : 0 }, "isFollowing" : { "type" : [ "boolean", "null" ] }, "isArticleSummaryPresent" : { "description" : "Indicates whether an article summary is present. Possible values: • true = summary is present • false = summary is not present", "type" : [ "boolean", "null" ] }, "myVote" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "permission" : { "type" : [ "string", "null" ], "enum" : [ "ALL", "REGISTEREDUSERS", "AGENTS" ] }, "authorId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "usageCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "rootCategoryId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "answer" : { "type" : [ "string", "null" ], "maxLength" : 16777215, "minLength" : 0 }, "createdBy" : { "$ref" : "./ArticleTranslation.json#/components/schemas/createdBy" }, "latestVersion" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "portalUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "attachmentCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "availableLocaleTranslations" : { "$ref" : "#/components/schemas/availableLocaleTranslationsNew" }, "category" : { "$ref" : "./ArticleTranslation.json#/components/schemas/category" }, "categoryId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "answer", "attachmentCount", "attachmentCount", "attachments", "author", "authorId", "availableLocaleTranslations", "category", "categoryId", "commentCount", "commentCount", "createdBy", "createdTime", "creatorId", "currentVersion", "departmentId", "dislikeCount", "expiryDate", "feedbackCount", "id", "isFollowing", "isArticleSummaryPresent", "isLocked", "isTemplate", "isTrashed", "latestPublishedVersion", "latestVersion", "latestVersionModifiedBy", "latestVersionModifierId", "latestVersionStatus", "likeCount", "locale", "metrics", "modifiedBy", "modifiedTime", "modifierId", "myVote", "owner", "ownerId", "permalink", "permission", "portalUrl", "position", "reviewedBy", "reviewedTime", "rootCategoryId", "seo", "sourceLocale", "status", "summary", "tags", "templateLastUpdatedTime", "templateUsageCount", "templateUsedUsersCount", "title", "translationId", "translationSource", "translationState", "translationState", "usageCount", "viewCount", "webUrl" ] }, { "type" : "object", "properties" : { "quickEdit" : { "type" : [ "null", "object" ], "additionalProperties" : false, "maxProperties" : 2, "minProperties" : 2, "properties" : { "modifierId" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "modifiedBy" : { "type" : [ "null", "object" ], "additionalProperties" : false, "maxProperties" : 5, "minProperties" : 5, "properties" : { "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" }, "name" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0 }, "id" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "status" : { "type" : [ "string", "null" ], "enum" : [ "ACTIVE", "DISABLED", "LICENSE_DOWNGRADED", "DELETED", "ANONYMIZED", "CLOSED" ], "maxLength" : 100, "minLength" : 0 }, "zuid" : { "type" : [ "string", "null", "integer" ], "format" : "int32", "pattern" : "([0-9]+)" } }, "required" : [ "id", "name", "photoURL", "status", "zuid" ] } }, "required" : [ "modifiedBy", "modifierId" ] }, "secondaryTitles" : { "type" : [ "null", "array" ], "items" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0 }, "uniqueItems" : false }, "followersCount" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "articleSummary" : { "description" : "Details of the article summary", "$ref" : "./ArticleTranslation.json#/components/schemas/articleSummary" } } }, { "type" : [ "null", "object" ], "additionalProperties" : false, "properties" : { "modifiedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "departmentId" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "dislikeCount" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "modifierId" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "likeCount" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "ownerId" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "latestVersionModifierId" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "translationState" : { "type" : [ "string", "null" ], "enum" : [ "OUTDATED", "UP-TO-DATE", "AUTO-TRANSLATE INPROGRESS", "AUTO-TRANSLATE FAILED" ], "maxLength" : 100, "minLength" : 0 }, "isTrashed" : { "type" : [ "boolean", "null" ] }, "isTemplate" : { "type" : [ "boolean", "null" ] }, "isLocked" : { "type" : [ "boolean", "null" ] }, "createdTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "id" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "translationSource" : { "$ref" : "./ArticleTranslation.json#/components/schemas/translationSourceJson" }, "latestVersionStatus" : { "type" : [ "string", "null" ], "enum" : [ "Published", "Draft", "Review", "Expired", "Unpublished" ], "maxLength" : 100, "minLength" : 0 }, "author" : { "$ref" : "./ArticleTranslation.json#/components/schemas/author" }, "reviewedBy" : { "$ref" : "./ArticleTranslation.json#/components/schemas/reviewedBy" }, "currentVersion" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "commentCount" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "tags" : { "type" : [ "null", "array" ], "items" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-z0-9_\\-+%\\P{InBasicLatin}\\s]+" }, "uniqueItems" : false }, "sourceLocale" : { "type" : [ "string", "null" ], "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)" }, "translationId" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "webUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "feedbackCount" : { "type" : [ "string", "null", "integer" ], "format" : "int32", "pattern" : "([0-9]+)" }, "latestPublishedVersion" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "position" : { "type" : [ "string", "null", "integer" ], "format" : "int32", "pattern" : "([0-9]+)" }, "metrics" : { "$ref" : "./Article.json#/components/schemas/metrics" }, "templateUsageCount" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "templateUsedUsersCount" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "templateLastUpdatedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "permalink" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*" }, "latestVersionModifiedBy" : { "$ref" : "./ArticleTranslation.json#/components/schemas/modifiedBy" }, "status" : { "type" : [ "string", "null" ], "enum" : [ "Published", "Draft", "Review", "Expired", "Unpublished" ], "maxLength" : 100, "minLength" : 0 }, "attachments" : { "$ref" : "./ArticleTranslation.json#/components/schemas/attachmentArr" }, "reviewedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "creatorId" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "locale" : { "type" : [ "string", "null" ], "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)" }, "title" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0 }, "expiryDate" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))" }, "modifiedBy" : { "$ref" : "./ArticleTranslation.json#/components/schemas/modifiedBy" }, "viewCount" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "seo" : { "$ref" : "./Article.json#/components/schemas/seo" }, "owner" : { "$ref" : "./ArticleTranslation.json#/components/schemas/owner" }, "summary" : { "type" : [ "string", "null" ], "maxLength" : 65553, "minLength" : 0 }, "isFollowing" : { "type" : [ "boolean", "null" ] }, "isArticleSummaryPresent" : { "description" : "Indicates whether an article summary is present. Possible values: • true = summary is present • false = summary is not present", "type" : [ "boolean", "null" ] }, "myVote" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "permission" : { "type" : [ "string", "null" ], "enum" : [ "ALL", "REGISTEREDUSERS", "AGENTS" ], "maxLength" : 100, "minLength" : 0 }, "authorId" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "usageCount" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "rootCategoryId" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "answer" : { "type" : [ "string", "null" ], "maxLength" : 16777215, "minLength" : 0 }, "createdBy" : { "$ref" : "./ArticleTranslation.json#/components/schemas/createdBy" }, "latestVersion" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "portalUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "attachmentCount" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "availableLocaleTranslations" : { "$ref" : "./Article.json#/components/schemas/availableLocaleTranslationsNew" }, "category" : { "$ref" : "./ArticleTranslation.json#/components/schemas/category" }, "categoryId" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "answer", "attachmentCount", "attachmentCount", "attachments", "author", "authorId", "availableLocaleTranslations", "category", "categoryId", "commentCount", "commentCount", "createdBy", "createdTime", "creatorId", "currentVersion", "departmentId", "dislikeCount", "expiryDate", "feedbackCount", "id", "isFollowing", "isArticleSummaryPresent", "isLocked", "isTemplate", "isTrashed", "latestPublishedVersion", "latestVersion", "latestVersionModifiedBy", "latestVersionModifierId", "latestVersionStatus", "likeCount", "locale", "metrics", "modifiedBy", "modifiedTime", "modifierId", "myVote", "owner", "ownerId", "permalink", "permission", "portalUrl", "position", "reviewedBy", "reviewedTime", "rootCategoryId", "seo", "sourceLocale", "status", "summary", "tags", "templateLastUpdatedTime", "templateUsageCount", "templateUsedUsersCount", "title", "translationId", "translationSource", "translationState", "translationState", "usageCount", "viewCount", "webUrl" ] } ] }, "examples" : { "Valid responses Definitions" : { "value" : { "modifiedTime" : 1592999203000, "departmentId" : "24073000002376045", "dislikeCount" : "0", "modifierId" : "4000000000059", "likeCount" : "0", "latestVersionModifierId" : "4000000000060", "ownerId" : "4000000000059", "translationState" : "UP-TO-DATE", "isTrashed" : false, "isTemplate" : false, "quickEdit" : { "modifierId" : "24073000007464062", "modifiedBy" : { "photoURL" : "https://desk.zoho.com/api/v1/agents/24073000007464062/photo?orgId=123456", "name" : "Tony Stark", "id" : "24073000007464062", "status" : "ACTIVE", "zuid" : "70425988" } }, "createdTime" : 1592999203000, "id" : "4000000019059", "translationSource" : null, "latestVersionStatus" : "Published", "author" : { "photoURL" : null, "name" : "Hill", "id" : "4000000000059", "status" : "ACTIVE", "zuid" : "234543" }, "reviewedBy" : { "photoURL" : null, "name" : "Hill", "id" : "4000000000059", "status" : "ACTIVE", "zuid" : "234543" }, "currentVersion" : "1.0", "commentCount" : "0", "tags" : [ "first ticket" ], "sourceLocale" : "en", "translationId" : "4000000017294", "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Solutions/dv/4000000019059/en", "feedbackCount" : "0", "latestPublishedVersion" : "1.0", "position" : "6", "templateUsageCount" : "2", "templateUsedUsersCount" : "2", "templateLastUpdatedTime" : "2019-12-31T09:45:52.000Z", "metrics" : { "feedbackCount" : "2", "unlikeCount" : "2", "dislikeCount" : "2", "lastUsageTime" : null, "likeCount" : "1", "viewCount" : "257", "lastActivityTime" : 1676985967000, "usageCount" : "0", "templateUsageCount" : "2" }, "permalink" : "answering-your-first-ticket", "latestVersionModifiedBy" : { "photoURL" : null, "name" : "will smith", "id" : "4000000000060", "status" : "ACTIVE", "zuid" : "234544" }, "status" : "Published", "attachments" : [ { "resourceId" : "mvfyda9fcc4df229b4065a04fba88a5b81b33", "extension" : "jpg", "size" : "3028238", "name" : "bird_2.jpg", "downloadUrl" : "https://desk.zoho.com/api/v1/articles/24073000005321222/translations/en/attachments/mvfyda9fcc4df229b4065a04fba88a5b81b33/content?orgId=123456&inline=false", "viewUrl" : "https://desk.zoho.com/api/v1/articles/24073000005321222/translations/en/attachments/mvfyda9fcc4df229b4065a04fba88a5b81b33/content?orgId=123456", "createdTime" : 1635829881000 } ], "reviewedTime" : 1592999203000, "creatorId" : "4000000000059", "locale" : "en", "title" : "Answering your first ticket.", "expiryDate" : null, "modifiedBy" : { "photoURL" : null, "name" : "Hill", "id" : "4000000000059", "status" : "ACTIVE", "zuid" : "234543" }, "viewCount" : "0", "seo" : { "keywords" : "helpcenter, knowledge base", "isEnabled" : true, "description" : "Knowledge base", "title" : "Helpcenter and knowledge base" }, "owner" : { "photoURL" : null, "name" : "Hill", "id" : "4000000000059", "status" : "ACTIVE", "zuid" : "234543" }, "summary" : "Zoho Desk packs a bunch of features that are expressly there to help you respond to tickets smartly. The first of these, you've already discovered: Auto-Suggest Articles. Zoho Desk pulls up relevant articles on the ticket's content—so you can save ...", "isFollowing" : true, "isArticleSummaryPresent" : true, "myVote" : null, "permission" : "AGENTS", "authorId" : "4000000000059", "usageCount" : "0", "rootCategoryId" : "4000000017276", "answer" : "

Zoho Desk packs a bunch of features that are expressly there to help you respond to tickets smartly.

The first of these, you've already discovered: Auto-Suggest Articles. Zoho Desk pulls up relevant articles on the ticket's content—so you can save time on frequently asked questions.

Every action that you can perform with respect to a ticket has a corresponding keyboard shortcut. With these, you can optimize the time you spend on each ticket. (And the shortcut to access these shortcuts is Shift + ? ).When you need to quickly consult a colleague, you can tag them in a ticket comment without having to leave this screen. That's like a quick chat, without even leaving your place, and with the full context of the ticket.

With these, you're good to go.

Go on, save the world from bad customer service!

", "createdBy" : { "photoURL" : null, "name" : "Hill", "id" : "4000000000059", "status" : "ACTIVE", "zuid" : "234543" }, "latestVersion" : "1.0", "portalUrl" : "https://desk.zoho.com/portal/zylker/en/kb/articles/answering-your-first-ticket", "attachmentCount" : "0", "availableLocaleTranslations" : [ { "latestVersionStatus" : "Published", "translationId" : "24073000005321224", "isTrashed" : false, "latestVersion" : "19.0", "isLocked" : false, "latestPublishedVersion" : "19.0", "href" : "https://desk.zoho.com/api/v1/articles/24073000005321222/translations/en?orgId=123456", "authorId" : "24073000000095005", "locale" : "en", "translationState" : "UP-TO-DATE", "status" : "Published" }, { "latestVersionStatus" : "Draft", "translationId" : "24073000005321260", "isTrashed" : false, "latestVersion" : "0.1", "isLocked" : false, "latestPublishedVersion" : null, "href" : "https://desk.zoho.com/api/v1/articles/24073000005321222/translations/zh?orgId=123456", "authorId" : "24073000000095005", "locale" : "zh", "translationState" : "OUTDATED", "status" : "Draft" } ], "category" : { "name" : "General", "id" : "4000000017287", "locale" : "en" }, "categoryId" : "4000000017287" } } } } } }, "validatePermalinkResponse" : { "description" : "validatePermalinkResponse template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "isAvailable" : { "type" : [ "boolean", "null" ] }, "suggestion" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]*" } }, "required" : [ "isAvailable", "suggestion" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "isAvailable" : false, "suggestion" : "how-to-open-account-2-18-12-2017" } } } } } }, "listAllNewArticle" : { "description" : "listAllNewArticle template definitions", "content" : { "application/json" : { "schema" : { "allOf" : [ { "type" : [ "object" ], "properties" : { "data" : { "type" : [ "array" ], "items" : { "type" : [ "object" ], "properties" : { "secondaryTitles" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 1, "minProperties" : 1, "properties" : { "secondaryTitles" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0 }, "uniqueItems" : false } }, "required" : [ "secondaryTitles" ] } }, "additionalProperties" : false } } }, "additionalProperties" : false }, { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "data" : { "$ref" : "#/components/schemas/datanew" } }, "required" : [ "data" ] }, { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "type" : "object", "properties" : { "secondaryTitles" : { "type" : [ "null", "object" ], "additionalProperties" : false, "maxProperties" : 1, "minProperties" : 1, "properties" : { "secondaryTitles" : { "type" : [ "null", "array" ], "items" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0 }, "uniqueItems" : false } }, "required" : [ "secondaryTitles" ] } } } } } }, { "type" : [ "null", "object" ], "additionalProperties" : false, "properties" : { "data" : { "$ref" : "./Article.json#/components/schemas/datanew" } }, "required" : [ "data" ] } ] }, "examples" : { "Valid responses Definitions" : { "value" : { "data" : [ { "modifiedTime" : 1592999203000, "departmentId" : "24073000000006907", "creatorId" : "4000000000059", "dislikeCount" : "0", "modifierId" : "4000000000059", "likeCount" : "0", "locale" : "en", "latestVersionModifierId" : "4000000000060", "ownerId" : "4000000000059", "title" : "Answering your first ticket.", "translationState" : "UP-TO-DATE", "isTrashed" : false, "isTemplate" : false, "createdTime" : 1592999203000, "modifiedBy" : { "photoURL" : "https://desk.zoho.com/api/v1/agents/24073000000095005/photo?orgId=123456", "name" : "Hill", "id" : "4000000000059", "status" : "ACTIVE", "zuid" : "234543" }, "id" : "4000000019059", "viewCount" : "0", "translationSource" : null, "owner" : { "photoURL" : null, "name" : "Hill", "id" : "4000000000059", "status" : "ACTIVE", "zuid" : "234543" }, "summary" : "Zoho Desk packs a bunch of features that are expressly there to help you respond to tickets smartly. The first of these, you've already discovered: Auto-Suggest Articles. Zoho Desk pulls up relevant articles on the ticket's content—so you can save ...", "latestVersionStatus" : "Published", "author" : { "photoURL" : null, "name" : "Hill", "id" : "4000000000059", "status" : "ACTIVE", "zuid" : "234543" }, "permission" : "AGENTS", "authorId" : "4000000000059", "usageCount" : "0", "templateUsageCount" : "2", "templateUsedUsersCount" : "2", "templateLastUpdatedTime" : "2019-12-31T09:45:52.000Z", "commentCount" : "0", "rootCategoryId" : "4000000017276", "sourceLocale" : "en", "translationId" : "4000000017294", "createdBy" : { "photoURL" : null, "name" : "Hill", "id" : "4000000000059", "status" : "ACTIVE", "zuid" : "234543" }, "latestVersion" : "1.0", "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Solutions/dv/4000000019059/en", "feedbackCount" : "0", "portalUrl" : "https://desk.zoho.com/portal/zylker/en/kb/articles/answering-your-first-ticket", "attachmentCount" : "0", "latestPublishedVersion" : "1.0", "position" : "1", "availableLocaleTranslations" : [ { "latestVersionStatus" : "Published", "translationId" : "24073000000095164", "isTrashed" : false, "latestVersion" : "1.0", "isLocked" : false, "latestPublishedVersion" : "1.0", "href" : "https://desk.zoho.com/api/v1/articles/24073000002823830/translations/en?orgId=123456", "authorId" : "24073000000095005", "locale" : "en", "translationState" : "UP-TO-DATE", "status" : "Published" } ], "category" : { "name" : "General", "id" : "4000000017287", "locale" : "en" }, "permalink" : "answering-your-first-ticket", "categoryId" : "4000000017287", "latestVersionModifiedBy" : { "photoURL" : null, "name" : "will smith", "id" : "4000000000060", "status" : "ACTIVE", "zuid" : "234544" }, "status" : "Published", "expiryDate" : "2023-12-31T09:45:52.000Z" } ] } } } } } }, "articlesCountJson" : { "description" : "articlesCountJson template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "count" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" } }, "required" : [ "count" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "count" : "5" } } } } } }, "convertFileToHtmlJson" : { "description" : "convertFileToHtmlJson template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "answer" : { "type" : [ "string", "null" ], "description" : "Converted HTML content of the imported file", "maxLength" : 16777215, "minLength" : 0 }, "title" : { "type" : [ "string", "null" ], "description" : "Title derived from the imported file", "maxLength" : 500, "minLength" : 0 } }, "required" : [ "answer", "title" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "answer" : "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.", "title" : "Stunters" } } } } } }, "fetchExternalImageUrlsResponseJson" : { "description" : "fetchExternalImageUrlsResponseJson template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "externalImageUrls" : { "$ref" : "#/components/schemas/imagesUrlsArray" } }, "required" : [ "externalImageUrls" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "externalImageUrls" : [ "https://desk.zoho.com/support/ImageDisplay?downloadType=uploadedFile&fileName=158137256.png&blockId=5685asdf05f4cbfca985d3565adf29e7ca&zgId=78f6ezdf8da2397dfe6316f581e074ce98&mode=view", "https://pbs.twimg.com/profile_images/1253792323051204608/QiaT93TQ_400x400.jpg" ] } } } } } }, "previewJson" : { "description" : "previewJson template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "answer" : { "type" : [ "string", "null" ], "maxLength" : 16777215, "minLength" : 0 }, "title" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0 } }, "required" : [ "answer", "title" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "answer" : "
Demo for article preview
Lorem Ipsum is simply dummy text of the printing and typesetting industry.
", "title" : "Demo for article preview" } } } } } }, "externalImageUrlMigrationResponse" : { "description" : "externalImageUrlMigrationResponse template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "urlResponse" : { "$ref" : "./ArticleExternalImageUrlResponse.json#/components/schemas/resultJsonArray", "description" : "Status of each external image migration" }, "content" : { "type" : [ "string", "null" ], "description" : "Updated HTML content with external images replaced by gallery URLs", "maxLength" : 16777215, "minLength" : 0 } }, "required" : [ "content", "urlResponse" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "urlResponse" : [ { "responseMessage" : "Success", "url" : "https://www.aoaophoto.com/Sample/imgs/animation.gif", "responseCode" : "200" }, { "responseMessage" : "Not Found", "url" : "https://twimg.com/profile/12351204608/demo.jpg", "responseCode" : "404" }, { "responseMessage" : "Success", "url" : "https://desk.zoho.com/support/ImageDisplay?downloadType=uploadedFile&fileName=158137256.png&blockId=5685asdf05f4cbfca985d3565adf29e7ca&zgId=78f6ezdf8da2397dfe6316f581e074ce98&mode=view", "responseCode" : "200" } ], "content" : "
The knowledge base is a key component of a good help center.
This is where you can share the basics of using your products or services to your customers.
Help articles and FAQs are great assets when it comes to answering the most fundamental questions your customers might have regarding your offerings . Help articles also ease the burden of your customer support agents by enabling self-service.
" } } } } } }, "getArticleHistoryResponse" : { "description" : "Article history timeline JSON (comments + data events).", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/articleHistoryResponseJson" } } } }, "getArticleInsightsResponse" : { "description" : "Article insights / metrics JSON.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/articleInsightsResponseJson" } } } }, "articleCountByCategoryIdsResponse" : { "description" : "Article count grouped by category IDs", "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "additionalProperties" : false, "properties" : { "data" : { "type" : [ "array", "null" ], "items" : { "$ref" : "#/components/schemas/articleCountByCategoryIdsObj" } } }, "required" : [ "data" ] }, "examples" : { "articleCountByCategoryIdsResponse" : { "value" : { "data" : [ { "rootCategoryId" : "5000000066427", "categories" : [ { "id" : "5000000194003", "articlesCount" : "8" } ] } ] } } } } } } }, "parameters" : { "templateId" : { "name" : "templateId", "in" : "header", "description" : "ID of the template mapped with the article", "required" : false, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } } }, "requestBodies" : { "associateArticlesUsage_articleIdsJson" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "ids" : { "$ref" : "#/components/schemas/articleIdsData" } }, "required" : [ "ids" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "ids" : [ "1000000022005", "1000000034567" ] } } } } } }, "articleUpdateJson" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "fieldName" : { "type" : [ "string", "null" ], "description" : "Property to update. Possible values: categoryId, status . Note: The categoryId must correspond to the most specific (lowest-level) category in the hierarchy. If the root category contains sections or sub-sections, provide the ID of the lowest-level sub-category.Articles cannot be created directly under categories that have child sections", "enum" : [ "categoryId", "status" ], "maxLength" : 100, "minLength" : 0 }, "ids" : { "description" : "ID(s) of the articles to update", "$ref" : "#/components/schemas/articleIdsData", "minItems" : 1, "maxItems" : 50 }, "fieldValue" : { "type" : [ "string", "null" ], "description" : "New value for the specified property", "maxLength" : 70, "pattern" : "[a-zA-Z0-9_\\-+%.:\\P{InBasicLatin}\\s]+", "minLength" : 0 } }, "required" : [ "fieldName", "fieldValue", "ids" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "fieldName" : "tag", "ids" : [ "10000000220345", "1200000022015" ], "fieldValue" : "new" } } } } } }, "addArticleJson" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "seoDescription" : { "type" : [ "string", "null" ], "description" : "SEO-specific description of the article", "maxLength" : 250, "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\\"\\'\\/\\!\\P{InBasicLatin}\\s]+", "minLength" : 0 }, "permission" : { "type" : [ "string", "null" ], "description" : "Access permission for the article.Possible values: ALL, REGISTEREDUSERS, AGENTS", "enum" : [ "ALL", "REGISTEREDUSERS", "AGENTS", "ALL_USERS", "REGISTERED_USERS", "AGENTS_ONLY" ], "maxLength" : 100, "minLength" : 0 }, "title" : { "type" : [ "string", "null" ], "description" : "Title of the article", "maxLength" : 300, "minLength" : 0 }, "authorId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "description" : "Unique ID of the article author", "pattern" : "([0-9]+)" }, "seoTitle" : { "type" : [ "string", "null" ], "description" : "SEO-specific title of the article", "maxLength" : 200, "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\\"\\'\\/\\!\\P{InBasicLatin}\\s]+", "minLength" : 0 }, "seoKeywords" : { "type" : [ "string", "null" ], "description" : "SEO-specific keywords of the article", "maxLength" : 200, "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\\"\\'\\/\\!\\P{InBasicLatin}\\s]+", "minLength" : 0 }, "locale" : { "type" : [ "string", "null" ], "description" : "Language code of the article translation ", "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ], "pattern" : "[a-zA-Z]{2,4}([-_][a-zA-Z]{2})?", "maxLength" : 100, "minLength" : 0 }, "translationState" : { "type" : [ "string", "null" ], "description" : "State of the translated article. Possible values: OUTDATED, UP-TO-DATE", "enum" : [ "OUTDATED", "UP-TO-DATE" ], "maxLength" : 100, "minLength" : 0 }, "tags" : { "description" : "Tags to associate with the article", "type" : [ "array" ], "items" : { "type" : [ "string" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-z0-9_\\-+%\\P{InBasicLatin}\\s]+" }, "uniqueItems" : false }, "expiryDate" : { "type" : [ "string", "null" ], "description" : "Schedule the expiry date of the article. format : (YYYY-MM-DD HH:MM)", "maxLength" : 50, "pattern" : "(([1-3])([0-9]{3})(-)([0-1])([0-9])(-)([0-3])([0-9])(\\ )([0-2])([0-9])(\\:)([0-6])([0-9]))|(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null", "minLength" : 0 }, "isSEOEnabled" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether SEO must be enabled for the article. Possible values: true = enable SEO . false = disable SEO" }, "isTemplate" : { "type" : [ "boolean" ], "default" : false, "description" : "Is it a template" }, "answer" : { "type" : [ "string", "null" ], "description" : "Content of the article", "maxLength" : 16777215, "minLength" : 0 }, "attachmentIds" : { "description" : "ID(s) of the attachments to associate with the article", "type" : [ "array" ], "items" : { "type" : [ "string" ], "maxLength" : 100, "minLength" : 0, "pattern" : "^([a-zA-Z0-9]{37}|-1)$" }, "max-size" : 50, "uniqueItems" : false }, "permalink" : { "type" : [ "string", "null" ], "description" : "Custom permalink for the article", "maxLength" : 300, "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]+", "minLength" : 0 }, "categoryId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "description" : "Unique ID of the category under which the article must be created . The categoryId must correspond to the most specific (lowest-level) category in the hierarchy. If the root category contains sections or sub-sections, provide the ID of the lowest-level sub-category.Note: Articles cannot be created directly under categories that have child sections", "pattern" : "([0-9]+)" }, "status" : { "type" : [ "string", "null" ], "description" : "Publishing status of the article. Possible values: Draft, Published, Review ", "enum" : [ "Draft", "Published", "Review", "DRAFT", "PUBLISH", "REVIEW" ], "maxLength" : 100, "minLength" : 0 }, "departmentId" : { "description" : "Unique ID of the department", "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "ownerId" : { "description" : "Unique ID of the article owner", "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "answer", "categoryId", "status", "title" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "seoDescription" : "Knowledge Base for your product", "permission" : "ALL", "title" : "Importance of a Knowledge Base", "authorId" : 22372000000094004, "seoTitle" : "Knowledge Base", "seoKeywords" : "Helpcenter, Knowledge Base", "tags" : [ "knowledge base", "helpcenter" ], "expiryDate" : 1526882100000, "isSEOEnabled" : true, "answer" : "The knowledge base is a key component of a good help center. This is where you can share the basics of using your products or services to your customers. Help articles and FAQs are great assets when it comes to answering the most fundamental questions your customers might have regarding your offerings. Help articles also ease the burden of your customer support agents by enabling self-service.", "permalink" : "knowledgebase", "categoryId" : 22372000000094160, "status" : "Draft" } } } } } }, "updateArticleJson" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "seoDescription" : { "type" : [ "string", "null" ], "description" : "SEO Description of the article", "maxLength" : 250, "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\\"\\'\\/\\!\\P{InBasicLatin}\\s]+", "minLength" : 0 }, "permission" : { "type" : [ "string", "null" ], "description" : "Access permission. Possible values: ALL, REGISTEREDUSERS, AGENTS", "enum" : [ "ALL", "REGISTEREDUSERS", "AGENTS", "ALL_USERS", "REGISTERED_USERS", "AGENTS_ONLY" ], "maxLength" : 100, "minLength" : 0 }, "title" : { "type" : [ "string", "null" ], "description" : "Title of the Article", "maxLength" : 300, "minLength" : 0 }, "authorId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "description" : "Unique ID of the article author", "pattern" : "([0-9]+)" }, "seoTitle" : { "type" : [ "string", "null" ], "description" : "SEO Title of article", "maxLength" : 200, "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\\"\\'\\/\\!\\P{InBasicLatin}\\s]+", "minLength" : 0 }, "seoKeywords" : { "type" : [ "string", "null" ], "description" : "SEO Keywords of the article", "maxLength" : 200, "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\\"\\'\\/\\!\\P{InBasicLatin}\\s]+", "minLength" : 0 }, "translationState" : { "type" : [ "string", "null" ], "description" : "State of the translated article. Possible values: OUTDATED, UP-TO-DATE", "enum" : [ "OUTDATED", "UP-TO-DATE" ], "maxLength" : 100, "minLength" : 0 }, "tags" : { "description" : "Tags associated with the article", "type" : [ "array" ], "items" : { "type" : [ "string" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-z0-9_\\-+%\\P{InBasicLatin}\\s]+" }, "uniqueItems" : false }, "expiryDate" : { "type" : [ "string", "null" ], "description" : "Schedule the expiry date of the article. format : (YYYY-MM-DD HH:MM)", "maxLength" : 50, "pattern" : "(([1-3])([0-9]{3})(-)([0-1])([0-9])(-)([0-3])([0-9])(\\ )([0-2])([0-9])(\\:)([0-6])([0-9]))|(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))|null", "minLength" : 0 }, "isSEOEnabled" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether SEO must be enabled. Possible values: true = enable SEO, false = disable SEO." }, "answer" : { "type" : [ "string", "null" ], "description" : "Content of the article", "maxLength" : 16777215, "minLength" : 0 }, "permalink" : { "type" : [ "string", "null" ], "description" : "The permalink of the article", "maxLength" : 300, "pattern" : "[a-zA-Z0-9%\\-._/?\\P{InBasicLatin}]+", "minLength" : 0 }, "categoryId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "description" : "Unique ID of the category\nThe categoryId must correspond to the most specific (lowest-level) category in the hierarchy. If the root category contains sections or sub-sections, provide the ID of the lowest-level sub-category.@Note@: Articles cannot be created directly under categories that have child sections", "pattern" : "([0-9]+)" }, "status" : { "type" : [ "string", "null" ], "description" : "Publishing status of the article. Possible values: Draft, Published, Review, Unpublished", "enum" : [ "Draft", "Published", "Review", "Unpublished", "DRAFT", "PUBLISH", "REVIEW" ], "maxLength" : 100, "minLength" : 0 }, "departmentId" : { "description" : "Unique ID of the department", "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "secondaryTitles" : { "description" : "Alternate titles for the article", "type" : [ "array" ], "items" : { "type" : [ "string" ] }, "maxLength" : 20000, "minItems" : 0, "maxItems" : 50 }, "ownerId" : { "description" : "Unique ID of the article owner", "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } } }, "examples" : { "Valid requestBody Definitions" : { "value" : { "expiryDate" : 1526882100000, "isSEOEnabled" : true, "answer" : "The knowledge base is a key component of a good help center. This is where you can share the basics of using your products or services to your customers. Help articles and FAQs are great assets when it comes to answering the most fundamental questions your customers might have regarding your offerings. Help articles also ease the burden of your customer support agents by enabling self-service.", "seoDescription" : "Knowledge base for your product", "permission" : "REGISTEREDUSERS", "title" : "Importance of a Knowledge Base", "authorId" : 22372000000094004, "seoTitle" : "Knowledge base", "seoKeywords" : "Knowledge base, Helpcenter", "categoryId" : 22372000000094160, "status" : "Draft", "tags" : [ "helpcenter", "knowledge base" ] } } } } } }, "validatePermalinkRequestBody" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "permalink" : { "type" : [ "string", "null" ], "description" : "The permalink of Solution", "maxLength" : 300, "pattern" : "[A-Za-z0-9%\\-+\\/=\\P{InBasicLatin}]+", "minLength" : 0 }, "locale" : { "type" : [ "string", "null" ], "description" : "Language", "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ], "pattern" : "[a-zA-Z]{2,4}([-_][a-zA-Z]{2})?", "maxLength" : 100, "minLength" : 0 }, "articleId" : { "type" : [ "string", "integer", "null" ], "description" : "The ID of the article for which the permalink is being validated.", "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "permalink" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "permalink" : "how-to-open-account-2", "articleId" : "55315324530" } } } } } }, "convertCloudDocumentContentToHtmlRequestBody" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "accountId" : { "type" : [ "string", "null" ], "description" : "Account ID (for Dropbox)", "maxLength" : 300, "pattern" : "[A-Za-z0-9@\\$&+\\:\\.\\{\\}\\(\\)#\\-_]+", "minLength" : 0 }, "filePath" : { "type" : [ "string", "null" ], "description" : "File path of the document (for Dropbox)", "maxLength" : 300, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "name" : { "type" : [ "string", "null" ], "description" : "Name of the document", "maxLength" : 300, "minLength" : 0 }, "source" : { "type" : [ "string", "null" ], "description" : "Source cloud provider. Possible values: zohodocs, gdrive, dropbox, box, skydrive, evernote, office365, workdrive.", "enum" : [ "gdrive", "dropbox", "box", "skydrive", "evernote", "workdrive", "zohodocs", "office365" ], "maxLength" : 100, "minLength" : 0 }, "id" : { "type" : [ "string", "null" ], "description" : "Unique ID of the document in the cloud provider", "maxLength" : 300, "minLength" : 0 }, "type" : { "type" : [ "string", "null" ], "description" : "Document type. Possible values: file, presentation, pdf, document, spreadsheet, writer.", "enum" : [ "file", "presentation", "pdf", "document", "spreadsheet", "writer" ], "maxLength" : 100, "minLength" : 0 }, "mimeType" : { "type" : [ "string", "null" ], "description" : "MIME type of the document (for Google Drive)", "maxLength" : 300, "examples" : [ "application/pdf", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "image/png", "text/csv" ], "minLength" : 0, "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9\\!\\#\\$\\&\\-\\^_]*\\/[a-zA-Z0-9][a-zA-Z0-9\\!\\#\\$\\&\\-\\^_.+]*$" }, "workspaceId" : { "type" : [ "string", "null" ], "description" : "Unique ID of the workspace to upload the attachment", "maxLength" : 100, "pattern" : "^([a-zA-Z0-9]{37}|-1)$", "minLength" : 0 } }, "required" : [ "id", "name", "source", "workspaceId", "type", "mimeType" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "name" : "Motorcycle.docx", "source" : "zohodocs", "id" : "25863000019783023", "type" : [ "file" ], "workspaceId" : "4fv34170cbb5ea8ed43a0932efaf53545818a" } } } } } }, "previewJson" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "answer" : { "type" : [ "string", "null" ], "description" : "The answer part of article", "maxLength" : 16777215, "minLength" : 0 }, "title" : { "type" : [ "string", "null" ], "description" : "The title of article", "maxLength" : 300, "minLength" : 0 } }, "required" : [ "answer", "title" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "answer" : "
Demo for article preview
Lorem Ipsum is simply dummy text of the printing and typesetting industry.
", "title" : "Demo for article preview" } } } } } }, "updateExternalImageUrlsPayload" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "ignoreClassName" : { "type" : [ "string", "null" ], "description" : "CSS class name of image tags that must not be migrated", "maxLength" : 50, "pattern" : "(^([a-zA-Z0-9\\s\\.\\?\\_\\-\\,\\@\\:/+\\(\\)])*$|null|undefined)", "minLength" : 0 }, "content" : { "type" : [ "string", "null" ], "description" : "HTML content of an article containing external images to migrate", "maxLength" : 16777215, "minLength" : 0 }, "workspaceId" : { "type" : [ "string", "null" ], "description" : "Unique ID of the workspace to which the external images must be uploaded", "maxLength" : 100, "pattern" : "^([a-zA-Z0-9]{37}|-1)$", "minLength" : 0 } }, "required" : [ "content", "workspaceId" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "ignoreClassName" : "ignoreExternalImageMigration", "content" : "
The knowledge base is a key component of a good help center.
This is where you can share the basics of using your products or services to your customers.
Help articles and FAQs are great assets when it comes to answering the most fundamental questions your customers might have regarding your offerings . Help articles also ease the burden of your customer support agents by enabling self-service.
", "workspaceId" : "a7iyy1dfbdfae106147a7b678e53939690d57" } } } } } }, "trashArticles_articleIdsJson" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "ids" : { "$ref" : "#/components/schemas/articleIdsData" } }, "required" : [ "ids" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "ids" : [ "2345678987654323", "3456789087654567" ] } } } } } }, "autoTranslationMassActionJson" : { "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "additionalProperties" : false, "properties" : { "ids" : { "type" : [ "array" ], "description" : "ID(s) of the articles for which auto-translation scheduled/stopped", "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "minItems" : 1, "maxItems" : 50 }, "locales" : { "type" : [ "array" ], "description" : "Locale(s) for which auto-translation scheduled/stopped. If not provided, the action is performed for all configured languages", "items" : { "type" : [ "string" ], "enum" : [ "en", "ja", "zh", "es", "de", "fr", "tr", "ru", "pt", "it", "nl", "da", "sv", "pl", "ar", "he", "af", "cs", "fr-ca", "bg", "fi", "el", "hu", "id", "nb", "ro", "th", "uk", "vi", "ur", "hi", "te", "kn", "ta", "mr", "ko", "fa", "bn", "gu", "ms", "ml", "en-gb", "sk", "hr", "sl", "zh_TW", "zh-tw", "ca", "ka", "kk", "my", "km", "pt-br" ], "pattern" : "([a-zA-Z]{2,4}([-_][a-zA-Z]{2})?)", "maxLength" : 10, "minLength" : 0 }, "minItems" : 1, "maxItems" : 50 } }, "required" : [ "ids" ] }, "examples" : { "Valid requestBody Definitions with ids only" : { "value" : { "ids" : [ "2345678987654323", "2356789087654567" ] } }, "Valid requestBody Definitions with ids and locales" : { "value" : { "ids" : [ "2345678987654323", "2356789087654567" ], "locales" : [ "en", "fr", "de" ] } } } } } } }, "securitySchemes" : { "cookie-auth" : { "$ref" : "./Common.json#/components/securitySchemes/cookie-auth" }, "org-oauth" : { "$ref" : "./Common.json#/components/securitySchemes/org-oauth" }, "iam-oauth2-schema" : { "$ref" : "./Common.json#/components/securitySchemes/iam-oauth2-schema" } } }, "x-entity" : "Article" }