Hi this is an API article Sample. This is updated.
","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"0","source":"uat","order":0} }, "Update article wth article Id for article in the state of need translation": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as need translation, source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"Hi this is an API article Sample. This is updated.
","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"1","source":"uat","order":0} }, "Update article wth article Id with translation you had made": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as translated, source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"Hi this is an API article Sample. This is updated.
","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"2","source":"uat","order":0} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleRequest" } ] }, "examples": { "Update article wth article Id for default language": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option for default language,source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"Hi this is an API article Sample. This is updated.
","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"0","source":"uat","order":0} }, "Update article wth article Id for article in the state of need translation": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as need translation, source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"Hi this is an API article Sample. This is updated.
","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"1","source":"uat","order":0} }, "Update article wth article Id with translation you had made": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as translated, source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"Hi this is an API article Sample. This is updated.
","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"2","source":"uat","order":0} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleRequest" } ] }, "examples": { "Update article wth article Id for default language": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option for default language,source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"Hi this is an API article Sample. This is updated.
","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"0","source":"uat","order":0} }, "Update article wth article Id for article in the state of need translation": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as need translation, source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"Hi this is an API article Sample. This is updated.
","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"1","source":"uat","order":0} }, "Update article wth article Id with translation you had made": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as translated, source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"Hi this is an API article Sample. This is updated.
","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"2","source":"uat","order":0} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleRequest" } ] }, "examples": { "Update article wth article Id for default language": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option for default language,source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"Hi this is an API article Sample. This is updated.
","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"0","source":"uat","order":0} }, "Update article wth article Id for article in the state of need translation": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as need translation, source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"Hi this is an API article Sample. This is updated.
","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"1","source":"uat","order":0} }, "Update article wth article Id with translation you had made": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as translated, source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"Hi this is an API article Sample. This is updated.
","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"2","source":"uat","order":0} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateArticleResponse" }, "examples": { "Article Created Successfully": { "summary": "The article has been created under the following category. you can use the article Id to view the article in the portal.", "value": {"data":{"id":"a1096061-e842-41fd-9085-494095e401b9","title":"Knowledge bases are much easier to design and edit","content":"Have you ever edited a Wikipedia page? You have to break the flow of text to add tags, and when you want to connect two articles together you have to just hope that nobody changes the other article’s name, lest you end up with a rusty red “dead link.”To be fair,Wikipedia has actually made good strides in making their Wiki software easy to use for anybody, but opening up the editor is still a bit of a shock since you don’t see the familiar webpage you just clicked on. With a knowledge base, what you see is what you get.You don’t have to train anybody on how to add or edit pages because the whole thing is extremely intuitive. Anybody can learn to navigate an edit page in seconds flat.","html_content":null,"category_id":"de104b39-db97-4509-8d4c-deeac74d448b","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":1,"latest_version":2,"enable_rtl":false,"hidden":false,"status":0,"order":0,"created_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","authors":[{"id":"f11efc6f-e968-4e95-82eb-85ad61559de8","first_name":"peter","last_name":"jone","user_description":null,"unique_user_name":"peter-jone","email_id":"peterjone@mail.com","profile_logo_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","profile_logo_cdn_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","is_enterprise_user":false}],"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","slug":"Knowledge-bases-are-much-easier-to-design-and edit","is_fall_back_content":false,"description":null,"category_type":0,"content_type":null,"is_shared_article":false,"translation_option":0,"url":"https://example.com/v1/docs/en/getting-started","current_workflow_status_id":null,"available_languages":[],"security_visibility":0,"custom_fields":null},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Article Not Found": { "summary": "Kindly verify the article Id and Langauage code, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles": { "get": { "tags": [ "Articles" ], "summary": "Gets an article by URL", "parameters": [ { "name": "url", "in": "query", "description": "The relative URL of the article (without domain). For example: \"/workspace/docs/en/article-slug\"", "required": true, "schema": { "type": "string" } }, { "name": "redirectionMode", "in": "query", "description": "Determines how the API handles redirection when a redirection rule is configured for the requested article, category, or document.\r\n- 0 - None – Returns the content of the originally requested resource without applying any redirection.\r\n- 1 - RedirectOnly – Returns an HTTP 302 response along with the redirected resource's URL, without fetching its content.\r\n- 2 - RedirectWithContent – Automatically follows the redirection rule and returns the content of the final redirected resource.", "schema": { "enum": [ "none", "redirectOnly", "redirectWithContent" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/RedirectionMode" } ], "description": "Possible values: `\"none\"` = None, `\"redirectOnly\"` = RedirectOnly, `\"redirectWithContent\"` = RedirectWithContent", "default": 0, "x-enumNames": [ "None", "RedirectOnly", "RedirectWithContent" ], "x-enum-varnames": [ "None", "RedirectOnly", "RedirectWithContent" ], "x-ms-enum": { "name": "RedirectionMode", "modelAsString": true } } }, { "name": "isForDisplay", "in": "query", "description": "Set this to true, if you are displaying the article to the end-user. If true, the content of snippets or variables appears in the article.", "schema": { "type": "boolean", "default": true } }, { "name": "isPublished", "in": "query", "description": "True: You will get the latest published version of the article. False: To get the latest version of the article.", "schema": { "type": "boolean", "default": true } }, { "name": "appendSASToken", "in": "query", "description": "Set this to false to exclude appending SAS token for images/files.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetArticleByUrlResponse" } } } }, "302": { "description": "Redirect", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Export Documentation - 400 Status response.": { "summary": "The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid export id","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Export Documentation - 400 Status response.": { "summary": "The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid export id","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Export Documentation - 400 Status response.": { "summary": "The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid export id","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] }, "post": { "tags": [ "Articles" ], "summary": "Adds an article to an existing category", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateArticleRequest" } ] }, "examples": { "Create article Request Example": { "summary": "Create an article with the title, categoryId, projevtVersionId, and userId.", "value": {"title":"New Article","content":"This is my new article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateArticleRequest" } ] }, "examples": { "Create article Request Example": { "summary": "Create an article with the title, categoryId, projevtVersionId, and userId.", "value": {"title":"New Article","content":"This is my new article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateArticleRequest" } ] }, "examples": { "Create article Request Example": { "summary": "Create an article with the title, categoryId, projevtVersionId, and userId.", "value": {"title":"New Article","content":"This is my new article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateArticleRequest" } ] }, "examples": { "Create article Request Example": { "summary": "Create an article with the title, categoryId, projevtVersionId, and userId.", "value": {"title":"New Article","content":"This is my new article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateArticleResponse" }, "examples": { "Article Created Successfully": { "summary": "The article has been created under the following category. you can use the article Id to view the article in the portal.", "value": {"data":{"id":"925b69b9-f241-4d89-9e3e-208a98dfc8eb","title":"Sample Article","public_version":0,"latest_version":1,"language_code":null,"hidden":false,"status":0,"order":3,"slug":"sample-article","content_type":null,"translation_option":0,"is_shared_article":false,"created_at":null,"modified_at":null,"current_workflow_status_id":null},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "userId not found": { "summary": "Kindly check your user Id and perform the task again. Find your user Id at /v2/Teams.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de81' does not exist in your project.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "category_id not found": { "summary": "Kindly check the category_id from /v2/ProjectVersions/{projectVersionId}/categories and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Unable to find specified parent category with an id 5b291e6b-fa40-4ab9-941e-f8fffc23b3761.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "project_version_id not found": { "summary": "Kindly check the project_version_id from /v2/ProjectVersions and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The supplied project version id 46f48bc7-760f-4b07-b2d2-fce4aa8ba2349 does not exist in your project.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "title not found": { "summary": "Kindly check the title is empty or null, and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The Title field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles/{articleId}/versions": { "get": { "tags": [ "Articles" ], "summary": "Gets all article versions", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetArticleVersionsResponse" }, "examples": { "Success Status Response": { "summary": "You can verify all the type of versions in a project.", "value": {"data":[{"version_number":1,"created_by":"peter jone","created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","base_version":0,"status":0,"profile_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E","comment":null}],"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Article not found": { "summary": "Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":null,"custom_data":null}],"warnings":[],"information":[]} } } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles/{articleId}/{langCode}/versions": { "get": { "tags": [ "Articles" ], "summary": "Gets all article versions", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article", "required": true, "schema": { "type": "string" } }, { "name": "langCode", "in": "path", "required": true, "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetArticleVersionsResponse" }, "examples": { "Success Status Response": { "summary": "You can verify all the type of versions in a project.", "value": {"data":[{"version_number":1,"created_by":"peter jone","created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","base_version":0,"status":0,"profile_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E","comment":null}],"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Article not found": { "summary": "Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":null,"custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles/{articleId}/versions/{versionNumber}": { "get": { "tags": [ "Articles" ], "summary": "Gets article by a version number", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "Version number of the article", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "isForDisplay", "in": "query", "description": "Set this to true, if you are displaying the article to the end-user. If true, the content of snippets or variables appears in the article. Note: If the value is true, ensure that the article content is not passed for update article endpoints.", "schema": { "type": "boolean", "default": false } }, { "name": "appendSASToken", "in": "query", "description": "Set this to false to exclude appending SAS token for images/files", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetArticleVersionResponse" }, "examples": { "Success status Response": { "summary": "This is the sample response for get-article, You can verify the information regarding the individual article.", "value": {"data":{"id":"a1096061-e842-41fd-9085-494095e401b9","title":"Knowledge bases are much easier to design and edit","content":"Have you ever edited a Wikipedia page? You have to break the flow of text to add tags, and when you want to connect two articles together you have to just hope that nobody changes the other article’s name, lest you end up with a rusty red “dead link.”To be fair,Wikipedia has actually made good strides in making their Wiki software easy to use for anybody, but opening up the editor is still a bit of a shock since you don’t see the familiar webpage you just clicked on. With a knowledge base, what you see is what you get.You don’t have to train anybody on how to add or edit pages because the whole thing is extremely intuitive. Anybody can learn to navigate an edit page in seconds flat.","html_content":null,"category_id":"de104b39-db97-4509-8d4c-deeac74d448b","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":1,"latest_version":2,"enable_rtl":false,"hidden":false,"status":0,"order":0,"created_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","authors":[{"id":"f11efc6f-e968-4e95-82eb-85ad61559de8","first_name":"peter","last_name":"jone","user_description":null,"unique_user_name":"peter-jone","email_id":"peterjone@mail.com","profile_logo_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","profile_logo_cdn_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","is_enterprise_user":false}],"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","slug":"Knowledge-bases-are-much-easier-to-design-and edit","is_fall_back_content":false,"description":null,"category_type":0,"content_type":null,"is_shared_article":false,"translation_option":0,"version_created_at":"0001-01-01T00:00:00","custom_fields":null},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Article not found": { "summary": "Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":null,"custom_data":null}],"warnings":[],"information":[]} } } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles/{articleId}/{langCode}/versions/{versionNumber}": { "get": { "tags": [ "Articles" ], "summary": "Gets article by a version number", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "Version number of the article", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "langCode", "in": "path", "description": "Language code of the article", "required": true, "schema": { "type": "string", "default": "en" } }, { "name": "isForDisplay", "in": "query", "description": "Set this to true, if you are displaying the article to the end-user. If true, the content of snippets or variables appears in the article. Note: If the value is true, ensure that the article content is not passed for update article endpoints.", "schema": { "type": "boolean", "default": false } }, { "name": "appendSASToken", "in": "query", "description": "Set this to false to exclude appending SAS token for images/files", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetArticleVersionResponse" }, "examples": { "Success status Response": { "summary": "This is the sample response for get-article, You can verify the information regarding the individual article.", "value": {"data":{"id":"a1096061-e842-41fd-9085-494095e401b9","title":"Knowledge bases are much easier to design and edit","content":"Have you ever edited a Wikipedia page? You have to break the flow of text to add tags, and when you want to connect two articles together you have to just hope that nobody changes the other article’s name, lest you end up with a rusty red “dead link.”To be fair,Wikipedia has actually made good strides in making their Wiki software easy to use for anybody, but opening up the editor is still a bit of a shock since you don’t see the familiar webpage you just clicked on. With a knowledge base, what you see is what you get.You don’t have to train anybody on how to add or edit pages because the whole thing is extremely intuitive. Anybody can learn to navigate an edit page in seconds flat.","html_content":null,"category_id":"de104b39-db97-4509-8d4c-deeac74d448b","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":1,"latest_version":2,"enable_rtl":false,"hidden":false,"status":0,"order":0,"created_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","authors":[{"id":"f11efc6f-e968-4e95-82eb-85ad61559de8","first_name":"peter","last_name":"jone","user_description":null,"unique_user_name":"peter-jone","email_id":"peterjone@mail.com","profile_logo_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","profile_logo_cdn_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","is_enterprise_user":false}],"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","slug":"Knowledge-bases-are-much-easier-to-design-and edit","is_fall_back_content":false,"description":null,"category_type":0,"content_type":null,"is_shared_article":false,"translation_option":0,"version_created_at":"0001-01-01T00:00:00","custom_fields":null},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Article not found": { "summary": "Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":null,"custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles/{articleId}/settings": { "get": { "tags": [ "Articles" ], "summary": "Gets settings for the article", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetArticleSettingsResponse" }, "examples": { "Success status Response": { "summary": "This is the sample response for Get-Article-Settings, You can verify the Slug, Tags, and relatedArticles.", "value": {"data":{"slug":"5-basic-things-to-get-started","seo_title":null,"description":null,"allow_comments":true,"show_table_of_contents":true,"featured_image_url":null,"tags":["Getting started"],"status_indicator":1,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":false,"exclude_from_ai_search":false,"exclude_from_external_search":false,"related_articles":[],"is_acknowledgement_enabled":false,"custom_fields":[{"field_id":"field-definition-id-1","name":"Country","type":0,"value":"USA"},{"field_id":"field-definition-id-2","name":"Priority","type":6,"value":5},{"field_id":"field-definition-id-3","name":"Status","type":2,"value":"option-id-active","options":[{"id":"option-id-active","label":"Active"},{"id":"option-id-inactive","label":"Inactive"},{"id":"option-id-pending","label":"Pending"}]}]},"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Article not found": { "summary": "Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":null,"custom_data":null}],"warnings":[],"information":[]} } } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] }, "put": { "tags": [ "Articles" ], "summary": "Updates settings for the article", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","allow_comments":true,"show_table_of_contents":true,"tags":[],"status_indicator":2,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"exclude_from_external_search":false,"custom_fields":[{"field_id":"field-definition-id-1","value":"Canada"},{"field_id":"field-definition-id-2","value":8},{"field_id":"field-definition-id-3","value":"option-id-active"}]} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","allow_comments":true,"show_table_of_contents":true,"tags":[],"status_indicator":2,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"exclude_from_external_search":false,"custom_fields":[{"field_id":"field-definition-id-1","value":"Canada"},{"field_id":"field-definition-id-2","value":8},{"field_id":"field-definition-id-3","value":"option-id-active"}]} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","allow_comments":true,"show_table_of_contents":true,"tags":[],"status_indicator":2,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"exclude_from_external_search":false,"custom_fields":[{"field_id":"field-definition-id-1","value":"Canada"},{"field_id":"field-definition-id-2","value":8},{"field_id":"field-definition-id-3","value":"option-id-active"}]} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","allow_comments":true,"show_table_of_contents":true,"tags":[],"status_indicator":2,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"exclude_from_external_search":false,"custom_fields":[{"field_id":"field-definition-id-1","value":"Canada"},{"field_id":"field-definition-id-2","value":8},{"field_id":"field-definition-id-3","value":"option-id-active"}]} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateArticleSettingsResponseCustomer" }, "examples": { "Successfully updated the article setings.": { "summary": "This response indicate a article settings has been successfully updated.", "value": {"data":{"url":"https://example.com/v1/docs/en/getting-started","slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","allow_comments":true,"show_table_of_contents":true,"featured_image_url":"","tags":[],"status_indicator":2,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"exclude_from_external_search":false,"related_articles":[],"is_acknowledgement_enabled":false,"custom_fields":[{"field_id":"field-definition-id-1","name":"Country","type":0,"value":"Canada"},{"field_id":"field-definition-id-2","name":"Priority","type":6,"value":8},{"field_id":"field-definition-id-3","name":"Status","type":2,"value":"option-id-active","options":[{"id":"option-id-active","label":"Active"},{"id":"option-id-inactive","label":"Inactive"}]}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[{"extension_data":null,"description":"Article settings updated successfully"}]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"A non-empty request body is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles/{articleId}/{langCode}/settings": { "get": { "tags": [ "Articles" ], "summary": "Gets settings for the article", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article", "required": true, "schema": { "type": "string" } }, { "name": "langCode", "in": "path", "description": "Language code of the article", "required": true, "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetArticleSettingsResponse" }, "examples": { "Success status Response": { "summary": "This is the sample response for Get-Article-Settings, You can verify the Slug, Tags, and relatedArticles.", "value": {"data":{"slug":"5-basic-things-to-get-started","seo_title":null,"description":null,"allow_comments":true,"show_table_of_contents":true,"featured_image_url":null,"tags":["Getting started"],"status_indicator":1,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":false,"exclude_from_ai_search":false,"exclude_from_external_search":false,"related_articles":[],"is_acknowledgement_enabled":false,"custom_fields":[{"field_id":"field-definition-id-1","name":"Country","type":0,"value":"USA"},{"field_id":"field-definition-id-2","name":"Priority","type":6,"value":5},{"field_id":"field-definition-id-3","name":"Status","type":2,"value":"option-id-active","options":[{"id":"option-id-active","label":"Active"},{"id":"option-id-inactive","label":"Inactive"},{"id":"option-id-pending","label":"Pending"}]}]},"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Article not found": { "summary": "Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":null,"custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] }, "put": { "tags": [ "Articles" ], "summary": "Updates settings for the article", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article", "required": true, "schema": { "type": "string" } }, { "name": "langCode", "in": "path", "description": "Language code of the article", "required": true, "schema": { "type": "string", "default": "en" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","allow_comments":true,"show_table_of_contents":true,"tags":[],"status_indicator":2,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"exclude_from_external_search":false,"custom_fields":[{"field_id":"field-definition-id-1","value":"Canada"},{"field_id":"field-definition-id-2","value":8},{"field_id":"field-definition-id-3","value":"option-id-active"}]} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","allow_comments":true,"show_table_of_contents":true,"tags":[],"status_indicator":2,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"exclude_from_external_search":false,"custom_fields":[{"field_id":"field-definition-id-1","value":"Canada"},{"field_id":"field-definition-id-2","value":8},{"field_id":"field-definition-id-3","value":"option-id-active"}]} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","allow_comments":true,"show_table_of_contents":true,"tags":[],"status_indicator":2,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"exclude_from_external_search":false,"custom_fields":[{"field_id":"field-definition-id-1","value":"Canada"},{"field_id":"field-definition-id-2","value":8},{"field_id":"field-definition-id-3","value":"option-id-active"}]} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","allow_comments":true,"show_table_of_contents":true,"tags":[],"status_indicator":2,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"exclude_from_external_search":false,"custom_fields":[{"field_id":"field-definition-id-1","value":"Canada"},{"field_id":"field-definition-id-2","value":8},{"field_id":"field-definition-id-3","value":"option-id-active"}]} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateArticleSettingsResponseCustomer" }, "examples": { "Successfully updated the article setings.": { "summary": "This response indicate a article settings has been successfully updated.", "value": {"data":{"url":"https://example.com/v1/docs/en/getting-started","slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","allow_comments":true,"show_table_of_contents":true,"featured_image_url":"","tags":[],"status_indicator":2,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"exclude_from_external_search":false,"related_articles":[],"is_acknowledgement_enabled":false,"custom_fields":[{"field_id":"field-definition-id-1","name":"Country","type":0,"value":"Canada"},{"field_id":"field-definition-id-2","name":"Priority","type":6,"value":8},{"field_id":"field-definition-id-3","name":"Status","type":2,"value":"option-id-active","options":[{"id":"option-id-active","label":"Active"},{"id":"option-id-inactive","label":"Inactive"}]}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[{"extension_data":null,"description":"Article settings updated successfully"}]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"A non-empty request body is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles/bulkcreate": { "post": { "tags": [ "Articles" ], "summary": "Adds multiple articles", "requestBody": { "description": "A list of article creation requests. For each article, the 'slug' property is optional - if not provided, a slug will be auto-generated from the title. When provided, the slug must be unique within the project version, otherwise an error will be returned for that article.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateArticleRequest" } }, "examples": { "Create Bulk Article Request Example": { "summary": "Create Bulk artilce by adding a list of data in title, category_id, project_version_id, and user_id. use content property to add some data in to your article.", "value": [{"title":"New Article 1","content":"This is my first article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"title":"New Article 2","content":"This is my second article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateArticleRequest" } }, "examples": { "Create Bulk Article Request Example": { "summary": "Create Bulk artilce by adding a list of data in title, category_id, project_version_id, and user_id. use content property to add some data in to your article.", "value": [{"title":"New Article 1","content":"This is my first article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"title":"New Article 2","content":"This is my second article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateArticleRequest" } }, "examples": { "Create Bulk Article Request Example": { "summary": "Create Bulk artilce by adding a list of data in title, category_id, project_version_id, and user_id. use content property to add some data in to your article.", "value": [{"title":"New Article 1","content":"This is my first article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"title":"New Article 2","content":"This is my second article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateArticleRequest" } }, "examples": { "Create Bulk Article Request Example": { "summary": "Create Bulk artilce by adding a list of data in title, category_id, project_version_id, and user_id. use content property to add some data in to your article.", "value": [{"title":"New Article 1","content":"This is my first article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"title":"New Article 2","content":"This is my second article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCreateArticleResponseCustomer" }, "examples": { "Article Created Successfully": { "summary": "The article has been created under the following category. you can use the article Id to view the article in the portal.", "value": {"data":[{"index":0,"article_id":"d83f3388-7493-489f-ab51-249d4e6a25ce","success":true,"details":"Successfully created article c1"},{"index":0,"article_id":"5cabbba1-fc2a-4f82-9dee-01759509b109","success":true,"details":"Successfully created article c2"}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "userId not found": { "summary": "Kindly check your user Id and perform the task again. Find your user Id at /v2/Teams.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Failed to create article c2\r\nError: The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de81' does not exist in your project.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "project_version_id not foundd": { "summary": "Kindly check the project_version_id from /v2/ProjectVersions and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Failed to create article c1\r\nError: The supplied workspace id 46f48bc7-760f-4b07-b2d2-fce4aa8ba2341 does not exist in your project..","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "category_id not found": { "summary": "Kindly check the category_id from /v2/ProjectVersions/{projectVersionId}/categories and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Failed to create article c1\r\nError: Unable to find specified parent category with an id 5b291e6b-fa40-4ab9-941e-f8fffc23b3761.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "title not found": { "summary": "Kindly check the title is empty or null, and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The Title field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles/{articleId}/publish": { "post": { "tags": [ "Articles" ], "summary": "Publishes an article with an id", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishArticleRequest" } ] }, "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publishing my article with new changes."} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishArticleRequest" } ] }, "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publishing my article with new changes."} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishArticleRequest" } ] }, "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publishing my article with new changes."} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishArticleRequest" } ] }, "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publishing my article with new changes."} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateArticleResponse" }, "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"url":"https://example.com/v1/docs/en/getting-started","extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "ALready published Article": { "summary": "This is repeated task that, this article has already published ", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article has already been published.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "version_number Not Found": { "summary": "version_number is missing or null, kindly verify the version number and perform the task again. ", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The field VersionNumber must be between 1 and 32767.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "article_id Not Found": { "summary": "Kindly verify the article_id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"One or more errors occurred. (Article not found).","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "article Not Found": { "summary": "Kindly verify the articleId or langCode and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles/update-workflow": { "post": { "tags": [ "Articles" ], "summary": "Update workflow status of the articles", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ArticleUpdateWorkflowRequest" } ] }, "example": {"project_version_id":"ae430990-88df-4886-b1e6-2596ae416df7","lang_code":"en","user_id":"43340990-88df-4886-b1e6-2596ae416df7","article_ids":["ea35f84c-394b-407c-80e9-4187a7ea9620","49fe8b58-2e21-4251-b10d-cec4c5a8769f"],"workflow_status_info":{"status_id":"65545e06-8c41-4e1a-a090-c603f9f1b4b2","due_date":"2024-06-13T14:30:00","comment":"Ready for review","assignee_id":"eed92685-0c5e-46b4-b559-c27625fe7a6b"}} }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ArticleUpdateWorkflowRequest" } ] }, "example": {"project_version_id":"ae430990-88df-4886-b1e6-2596ae416df7","lang_code":"en","user_id":"43340990-88df-4886-b1e6-2596ae416df7","article_ids":["ea35f84c-394b-407c-80e9-4187a7ea9620","49fe8b58-2e21-4251-b10d-cec4c5a8769f"],"workflow_status_info":{"status_id":"65545e06-8c41-4e1a-a090-c603f9f1b4b2","due_date":"2024-06-13T14:30:00","comment":"Ready for review","assignee_id":"eed92685-0c5e-46b4-b559-c27625fe7a6b"}} }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ArticleUpdateWorkflowRequest" } ] }, "example": {"project_version_id":"ae430990-88df-4886-b1e6-2596ae416df7","lang_code":"en","user_id":"43340990-88df-4886-b1e6-2596ae416df7","article_ids":["ea35f84c-394b-407c-80e9-4187a7ea9620","49fe8b58-2e21-4251-b10d-cec4c5a8769f"],"workflow_status_info":{"status_id":"65545e06-8c41-4e1a-a090-c603f9f1b4b2","due_date":"2024-06-13T14:30:00","comment":"Ready for review","assignee_id":"eed92685-0c5e-46b4-b559-c27625fe7a6b"}} }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ArticleUpdateWorkflowRequest" } ] }, "example": {"project_version_id":"ae430990-88df-4886-b1e6-2596ae416df7","lang_code":"en","user_id":"43340990-88df-4886-b1e6-2596ae416df7","article_ids":["ea35f84c-394b-407c-80e9-4187a7ea9620","49fe8b58-2e21-4251-b10d-cec4c5a8769f"],"workflow_status_info":{"status_id":"65545e06-8c41-4e1a-a090-c603f9f1b4b2","due_date":"2024-06-13T14:30:00","comment":"Ready for review","assignee_id":"eed92685-0c5e-46b4-b559-c27625fe7a6b"}} } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Update Workflow - 200 Success response.": { "summary": "The below example shows a successful workflow update response", "value": {"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Missing ProjectDocumentVersionId": { "summary": "The 'ProjectDocumentVersionId' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"ProjectDocumentVersion ID is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Missing LangCode": { "summary": "The 'LangCode' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Language code is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Missing UserId": { "summary": "The 'UserId' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"User Id is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Missing DocumentIds": { "summary": "The 'DocumentIds' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Document IDs are required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Missing WorkflowStatusInfo": { "summary": "The 'WorkflowStatusInfo' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Workflow status information is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles/{articleId}/fork": { "put": { "tags": [ "Articles" ], "summary": "Forks an article with an id", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForkArticleVersionRequest" } ] }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"version_number":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","lang_code":"en"} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForkArticleVersionRequest" } ] }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"version_number":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","lang_code":"en"} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForkArticleVersionRequest" } ] }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"version_number":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","lang_code":"en"} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForkArticleVersionRequest" } ] }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"version_number":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","lang_code":"en"} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForkArticleVersionResponse" }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"data":{"version_number":4,"created_by":"peter jone","created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","base_version":3,"status":0,"profile_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E","comment":null},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "user_id not found.": { "summary": "Kindly verify the user_id and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"The UserId field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "lang_code not found.": { "summary": "Kindly verify the lang_code and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"The LangCode field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "version_number not found.": { "summary": "Kindly verify the version_number and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Cannot fork version number 0, it does not exist in your project.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Article Id not found.": { "summary": "Kindly verify the Article Id and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"One or more errors occurred. (Article not found).","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles/bulkupdate": { "put": { "tags": [ "Articles" ], "summary": "Updates multiple articles", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateArticle" } }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": [{"article_id":"0e9a3cf2-b5ce-46d4-a637-604cb8407b93","lang_code":"en","title":"Updated Title","content":"updating content","html_content":"updating content
","category_id":"68212cec-7a9b-4323-9bb8-33865444a508","hidden":false,"version_number":1,"translation_option":"","source":"","order":0}] } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateArticle" } }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": [{"article_id":"0e9a3cf2-b5ce-46d4-a637-604cb8407b93","lang_code":"en","title":"Updated Title","content":"updating content","html_content":"updating content
","category_id":"68212cec-7a9b-4323-9bb8-33865444a508","hidden":false,"version_number":1,"translation_option":"","source":"","order":0}] } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateArticle" } }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": [{"article_id":"0e9a3cf2-b5ce-46d4-a637-604cb8407b93","lang_code":"en","title":"Updated Title","content":"updating content","html_content":"updating content
","category_id":"68212cec-7a9b-4323-9bb8-33865444a508","hidden":false,"version_number":1,"translation_option":"","source":"","order":0}] } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateArticle" } }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": [{"article_id":"0e9a3cf2-b5ce-46d4-a637-604cb8407b93","lang_code":"en","title":"Updated Title","content":"updating content","html_content":"updating content
","category_id":"68212cec-7a9b-4323-9bb8-33865444a508","hidden":false,"version_number":1,"translation_option":"","source":"","order":0}] } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdateArticleResponse" }, "examples": { "Success response for bulk article update.": { "summary": "This is an response that indicate the bulk articles has updated successfully.", "value": {"data":[{"index":0,"article_id":"0e9a3cf2-b5ce-46d4-a637-604cb8407b93","success":true,"details":"Successfully updated article with an id 0e9a3cf2-b5ce-46d4-a637-604cb8407b93"}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"A non-empty request body is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles/{articleId}/updateDescription": { "put": { "tags": [ "Articles" ], "summary": "Update the Article Description", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "The description of the article", "schema": { "maxLength": 250, "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Kindly verify the language code.": { "summary": "Verify the language code and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} }, "Kindly verify the article Id.": { "summary": "Verify the article Id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles/{articleId}/{langCode}/updateDescription": { "put": { "tags": [ "Articles" ], "summary": "Update the Article Description", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "The description of the article", "schema": { "maxLength": 250, "type": "string" } }, { "name": "langCode", "in": "path", "description": "Language code of the article", "required": true, "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Kindly verify the language code.": { "summary": "Verify the language code and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} }, "Kindly verify the article Id.": { "summary": "Verify the article Id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/{categoryId}": { "delete": { "tags": [ "Categories" ], "summary": "Deletes an category with an ID", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Successfully Deleted": { "summary": "The category has been successfully deleted.", "value": {"extension_data":null,"success":true,"errors":null,"warnings":[],"information":null} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category not found": { "summary": "Kindly verify the Categotry Id and Langauage code, then peroform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] }, "get": { "tags": [ "Categories" ], "summary": "Get a category by ID with its articles and direct child categories metadata", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } }, { "name": "langCode", "in": "query", "description": "If the language code is empty, the default language of the category will be taken into account.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCategoryResponse" }, "examples": { "Success Response": { "summary": "This is an example for get category succes response. \\n Here you can view diffrent data included with multiple article associated with a category.", "value": {"data":{"articles":[{"id":"cf8f67da-77c7-48b1-b207-70875caa2f55","title":"New article 1","public_version":1,"latest_version":1,"language_code":"en","hidden":false,"status":0,"order":2,"slug":"new-article-1","content_type":null,"translation_option":0,"is_shared_article":false,"created_at":null,"modified_at":"2024-06-13T14:30:00","current_workflow_status_id":"ec0a4d2a-bb13-4c55-867e-1e9e0be07086"},{"id":"925b69b9-f241-4d89-9e3e-208a98dfc8eb","title":"New article 2","public_version":1,"latest_version":1,"language_code":"en","hidden":false,"status":0,"order":2,"slug":"new-article-2","content_type":null,"translation_option":0,"is_shared_article":false,"created_at":null,"modified_at":"2024-06-13T14:30:00","current_workflow_status_id":"ec0a4d2a-bb13-4c55-867e-1e9e0be07086"}],"child_categories":[{"articles":[{"id":"cf8f67da-77c7-48b1-b207-70875caa2f55","title":"New article 3","public_version":1,"latest_version":1,"language_code":"en","hidden":false,"status":0,"order":2,"slug":"new-article-3","content_type":null,"translation_option":0,"is_shared_article":false,"created_at":null,"modified_at":"2024-06-13T14:30:00","current_workflow_status_id":"ec0a4d2a-bb13-4c55-867e-1e9e0be07086"},{"id":"925b69b9-f241-4d89-9e3e-208a98dfc8eb","title":"New article 4","public_version":1,"latest_version":1,"language_code":"en","hidden":false,"status":0,"order":2,"slug":"new-article-4","content_type":null,"translation_option":0,"is_shared_article":false,"created_at":null,"modified_at":"2024-06-13T14:30:00","current_workflow_status_id":"ec0a4d2a-bb13-4c55-867e-1e9e0be07086"}],"child_categories":[],"id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","name":"Child category name","description":null,"project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":11,"parent_category_id":null,"hidden":false,"icon":null,"slug":"category-name","language_code":null,"category_type":2,"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","status":null,"content_type":null,"current_workflow_status_id":"9fc4dd1a-ee83-489f-994d-ddf43c9b4b18"}],"id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","name":"Category name","description":null,"project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":11,"parent_category_id":null,"hidden":false,"icon":null,"slug":"category-name","language_code":null,"category_type":2,"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","status":null,"content_type":null,"current_workflow_status_id":"9fc4dd1a-ee83-489f-994d-ddf43c9b4b18"},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category Not Found": { "summary": "Kindly verify the Categotry Id, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Cannot find category with id 5b291e6b-fa40-4ab9-941e-f8fffc23b3761","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Language Not Found": { "summary": "Kindly verify the langCode, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Language code not found","error_code":null,"custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] }, "put": { "tags": [ "Categories" ], "summary": "Update a category with the ID", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryRequest" } ] }, "examples": { "Updating Category": { "summary": "Request for Updating Category Name.\\n if you are not using parent_category_id then remove the field.", "value": {"name":"UpdatedName","order":0,"parent_category_id":"814bd3cc-4cd1-4f97-adde-d4d644e9fe78","hidden":false,"icon":"","language":"en"} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryRequest" } ] }, "examples": { "Updating Category": { "summary": "Request for Updating Category Name.\\n if you are not using parent_category_id then remove the field.", "value": {"name":"UpdatedName","order":0,"parent_category_id":"814bd3cc-4cd1-4f97-adde-d4d644e9fe78","hidden":false,"icon":"","language":"en"} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryRequest" } ] }, "examples": { "Updating Category": { "summary": "Request for Updating Category Name.\\n if you are not using parent_category_id then remove the field.", "value": {"name":"UpdatedName","order":0,"parent_category_id":"814bd3cc-4cd1-4f97-adde-d4d644e9fe78","hidden":false,"icon":"","language":"en"} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryRequest" } ] }, "examples": { "Updating Category": { "summary": "Request for Updating Category Name.\\n if you are not using parent_category_id then remove the field.", "value": {"name":"UpdatedName","order":0,"parent_category_id":"814bd3cc-4cd1-4f97-adde-d4d644e9fe78","hidden":false,"icon":"","language":"en"} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCategoryResponse" }, "examples": { "Successfully Updated Category": { "summary": "Updated Catgory information is shown in this response.", "value": {"data":{"id":"68212cec-7a9b-4323-9bb8-33865444a508","name":"UpdatedName","order":0,"icon":""},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"A non-empty request body is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "parent_category_id should be removed if its null or empty..": { "summary": "Kindly remove the parent_category_id, it should not be null or empty. \\n if there you need an parent_category_id with another category please add it.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Object reference not set to an instance of an object.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/{categoryId}/version/{versionNumber}": { "delete": { "tags": [ "Categories" ], "summary": "Delete category Version", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "Version number of the category to be deleted", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Successfully Deleted": { "summary": "The category version has been successfully deleted.", "value": {"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category not found": { "summary": "Kindly verify the Categotry Id and Langauage code, then peroform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid CategoryId","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Version not found": { "summary": "Kindly verify the version and Langauage code, then peroform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Last Version cannot be deleted","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Version number invalid": { "summary": "Kindly verify the version number and Langauage code, then peroform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid Category Version","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/{categoryId}/{langCode}/version/{versionNumber}": { "delete": { "tags": [ "Categories" ], "summary": "Delete category Version", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "Version number of the category to be deleted", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "langCode", "in": "path", "description": "Language code of the category", "required": true, "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Successfully Deleted": { "summary": "The category version has been successfully deleted.", "value": {"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category not found": { "summary": "Kindly verify the Categotry Id and Langauage code, then peroform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid CategoryId","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Version not found": { "summary": "Kindly verify the version and Langauage code, then peroform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Last Version cannot be deleted","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Version number invalid": { "summary": "Kindly verify the version number and Langauage code, then peroform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid Category Version","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/bulkdelete-category-versions": { "delete": { "tags": [ "Categories" ], "summary": "Delete multiple category versions", "parameters": [ { "name": "categoryId", "in": "query", "description": "The ID of the Category", "required": true, "schema": { "type": "string" } }, { "name": "langCode", "in": "query", "description": "Language code of the category", "required": true, "schema": { "type": "string" } }, { "name": "categoryVersionNumbers", "in": "query", "description": "Array of category version numbers to be deleted", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteCategoryVersionResponse" } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/{categoryId}/{langCode}/publish": { "delete": { "tags": [ "Categories" ], "summary": "Unpublishes a page category with an id", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } }, { "name": "langCode", "in": "path", "description": "Language code of the category", "required": true, "schema": { "type": "string", "default": "en" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UnpublishCategoryRequest" } ] }, "examples": { "Unpublish category Request Example": { "summary": "This is an basic example for unpublish category. ProjectVersionId, UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"unpublish_message":"Successfully unpublished"} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UnpublishCategoryRequest" } ] }, "examples": { "Unpublish category Request Example": { "summary": "This is an basic example for unpublish category. ProjectVersionId, UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"unpublish_message":"Successfully unpublished"} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UnpublishCategoryRequest" } ] }, "examples": { "Unpublish category Request Example": { "summary": "This is an basic example for unpublish category. ProjectVersionId, UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"unpublish_message":"Successfully unpublished"} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UnpublishCategoryRequest" } ] }, "examples": { "Unpublish category Request Example": { "summary": "This is an basic example for unpublish category. ProjectVersionId, UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"unpublish_message":"Successfully unpublished"} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCreateCategoryResponse" }, "examples": { "Successfully unpublished category": { "summary": "Unublishing a page category with CategoryId, project_veriond_id, langCode, user_id, version_number, and unpublish_message.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "CategoryId not found": { "summary": "kindly verify the CategoryId and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "version_number not found": { "summary": "kindly verify the version_number and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The field VersionNumber must be between 1 and 32767.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "user_id not found": { "summary": "Kindly verify the user_id nad perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The UserId field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] }, "post": { "tags": [ "Categories" ], "summary": "Publishes an category with an id", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } }, { "name": "langCode", "in": "path", "description": "Language code of the category", "required": true, "schema": { "type": "string", "default": "en" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishCategoryRequest" } ] }, "examples": { "Publish Category Request Example": { "summary": "This is an basic example for publish category. UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Successfully Published"} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishCategoryRequest" } ] }, "examples": { "Publish Category Request Example": { "summary": "This is an basic example for publish category. UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Successfully Published"} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishCategoryRequest" } ] }, "examples": { "Publish Category Request Example": { "summary": "This is an basic example for publish category. UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Successfully Published"} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishCategoryRequest" } ] }, "examples": { "Publish Category Request Example": { "summary": "This is an basic example for publish category. UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Successfully Published"} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCreateCategoryResponse" }, "examples": { "Successfully Published Category": { "summary": "Category page\t\t", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "CategoryId not found": { "summary": "kindly verify the CategoryId and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "version_number not found": { "summary": "kindly verify the version_number and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The field VersionNumber must be between 1 and 32767.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "user_id not found": { "summary": "Kindly verify the user_id nad perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The UserId field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/bulkpublish/{langCode}": { "delete": { "tags": [ "Categories" ], "summary": "Unpublishes multiple categories", "parameters": [ { "name": "langCode", "in": "path", "description": "Language code of the category", "required": true, "schema": { "type": "string", "default": "en" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUnpublishCategoryRequest" } ] }, "examples": { "Unpublished category request": { "summary": "Category page has unpublished successfully. the category_id, poject_version_id, user_id, and version_number are mandatory.", "value": {"categories":[{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","version_number":1},{"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","version_number":1}],"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","unpublish_message":"Unpublish category"} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUnpublishCategoryRequest" } ] }, "examples": { "Unpublished category request": { "summary": "Category page has unpublished successfully. the category_id, poject_version_id, user_id, and version_number are mandatory.", "value": {"categories":[{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","version_number":1},{"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","version_number":1}],"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","unpublish_message":"Unpublish category"} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUnpublishCategoryRequest" } ] }, "examples": { "Unpublished category request": { "summary": "Category page has unpublished successfully. the category_id, poject_version_id, user_id, and version_number are mandatory.", "value": {"categories":[{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","version_number":1},{"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","version_number":1}],"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","unpublish_message":"Unpublish category"} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUnpublishCategoryRequest" } ] }, "examples": { "Unpublished category request": { "summary": "Category page has unpublished successfully. the category_id, poject_version_id, user_id, and version_number are mandatory.", "value": {"categories":[{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","version_number":1},{"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","version_number":1}],"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","unpublish_message":"Unpublish category"} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUnpublishCategoryResponse" }, "examples": { "Successfully Unublished Category": { "summary": "Unublishing a page category with CategoryId, project_veriond_id, langCode, user_id, version_number, and unpublish_message.", "value": {"data":[{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","success":true,"details":"Successfully unpublished category with an id 152e9239-1a5a-4044-b5de-1030f49976b6s"},{"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","success":true,"details":"Successfully unpublished category with an id gr32e9239-1a5a-4044-b5de-1030f499fe6sr"}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "category_id not found": { "summary": "Kindly verify the category_id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The CategoryId field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "user_id not found": { "summary": "Kindly verify the user_id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The UserId field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "version_number not found": { "summary": "Kindly verify the version_number and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The field VersionNumber must be between 1 and 32767.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] }, "post": { "tags": [ "Categories" ], "summary": "Publishes multiple categories", "parameters": [ { "name": "langCode", "in": "path", "description": "Language code of the category", "required": true, "schema": { "type": "string", "default": "en" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkPublishCategory" } }, "examples": { "Published Category Request": { "summary": "Category page has published successfully. the category_id, user_id, and version_number are mandatory.", "value": [{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publish Success"},{"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","user_id":"edr1efc6f-e968-4e95-82eb-ccad61559deef3","version_number":1,"publish_message":"Publish Success"}] } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkPublishCategory" } }, "examples": { "Published Category Request": { "summary": "Category page has published successfully. the category_id, user_id, and version_number are mandatory.", "value": [{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publish Success"},{"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","user_id":"edr1efc6f-e968-4e95-82eb-ccad61559deef3","version_number":1,"publish_message":"Publish Success"}] } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkPublishCategory" } }, "examples": { "Published Category Request": { "summary": "Category page has published successfully. the category_id, user_id, and version_number are mandatory.", "value": [{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publish Success"},{"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","user_id":"edr1efc6f-e968-4e95-82eb-ccad61559deef3","version_number":1,"publish_message":"Publish Success"}] } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkPublishCategory" } }, "examples": { "Published Category Request": { "summary": "Category page has published successfully. the category_id, user_id, and version_number are mandatory.", "value": [{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publish Success"},{"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","user_id":"edr1efc6f-e968-4e95-82eb-ccad61559deef3","version_number":1,"publish_message":"Publish Success"}] } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkPublishCategoryResponse" }, "examples": { "Successfully Published Category": { "summary": "Category page\t\t", "value": {"data":[{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","success":true,"details":"Bulk Publish Success"},{"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","success":true,"details":"Bulk Publish Success"}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "category_id not found": { "summary": "Kindly verify the category_id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The CategoryId field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "user_id not found": { "summary": "Kindly verify the user_id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The UserId field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "version_number not found": { "summary": "Kindly verify the version_number and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The field VersionNumber must be between 1 and 32767.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories": { "get": { "tags": [ "Categories" ], "summary": "Gets a category by URL", "parameters": [ { "name": "url", "in": "query", "description": "The relative URL of the category (without domain). For example: \"/workspace/docs/en/category-slug\"", "required": true, "schema": { "type": "string" } }, { "name": "redirectionMode", "in": "query", "description": "Determines how the API handles redirection when a redirection rule is configured for the requested article, category, or document.\r\n- 0 - None – Returns the content of the originally requested resource without applying any redirection.\r\n- 1 - RedirectOnly – Returns an HTTP 302 response along with the redirected resource's URL, without fetching its content.\r\n- 2 - RedirectWithContent – Automatically follows the redirection rule and returns the content of the final redirected resource.", "schema": { "enum": [ "none", "redirectOnly", "redirectWithContent" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/RedirectionMode" } ], "description": "Possible values: `\"none\"` = None, `\"redirectOnly\"` = RedirectOnly, `\"redirectWithContent\"` = RedirectWithContent", "default": 0, "x-enumNames": [ "None", "RedirectOnly", "RedirectWithContent" ], "x-enum-varnames": [ "None", "RedirectOnly", "RedirectWithContent" ], "x-ms-enum": { "name": "RedirectionMode", "modelAsString": true } } }, { "name": "isForDisplay", "in": "query", "description": "Set this to true, if you are displaying the category to the end-user. If true, the content of snippets or variables appears in the category.", "schema": { "type": "boolean", "default": true } }, { "name": "isPublished", "in": "query", "description": "True: You will get the latest published version of the category. False: To get the latest version of the category.", "schema": { "type": "boolean", "default": true } }, { "name": "appendSASToken", "in": "query", "description": "Set this to false to exclude appending SAS token for images/files.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCategoryByUrlResponse" } } } }, "302": { "description": "Redirect", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Export Documentation - 400 Status response.": { "summary": "The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid export id","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Export Documentation - 400 Status response.": { "summary": "The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid export id","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Export Documentation - 400 Status response.": { "summary": "The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid export id","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] }, "post": { "tags": [ "Categories" ], "summary": "Adds a new category", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddCategoryRequest" } ] }, "examples": { "Create a new Category as Folder.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Create a new Category as Page .": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Create a new Category as Index.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddCategoryRequest" } ] }, "examples": { "Create a new Category as Folder.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Create a new Category as Page .": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Create a new Category as Index.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddCategoryRequest" } ] }, "examples": { "Create a new Category as Folder.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Create a new Category as Page .": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Create a new Category as Index.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddCategoryRequest" } ] }, "examples": { "Create a new Category as Folder.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Create a new Category as Page .": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Create a new Category as Index.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddCategoryResponse" }, "examples": { "Successfully Created the Category": { "summary": "Here you can find the Category Id and category name to navigate.", "value": {"data":{"id":"df574e5a-8015-428f-ac33-cad428d1230c","name":"New Category","order":0,"icon":null},"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Invalid Category project_version_id Parameters": { "summary": "Kindly verify the project_version_id, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The supplied project version id 46fvf48bc7-760f-4b07-b2d2-fce4aa8ba234 does not exist in your project","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Empty project_version_id Parameters": { "summary": "Kindly verify the project_version_id is not empty, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The ProjectVersionId field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Invalid Category Name Parameter": { "summary": "Kindly verify the Name, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The Name field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/{categoryId}/content/{langCode}": { "get": { "tags": [ "Categories" ], "summary": "Get category page with an ID", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } }, { "name": "langCode", "in": "path", "description": "Language code of the category", "required": true, "schema": { "type": "string", "default": "en" } }, { "name": "isForDisplay", "in": "query", "description": "Set this to true, if you are displaying the category to the end-user. If **true**, the content of snippets or variables appears in the category. Note: If the value is true, ensure that the article content is not passed for *update* category endpoints.", "schema": { "type": "boolean", "default": false } }, { "name": "isPublished", "in": "query", "description": "To get latest published article, **set isPublished as true.**", "schema": { "type": "boolean", "default": false } }, { "name": "appendSASToken", "in": "query", "description": "Set this to false to exclude appending SAS token for images/files", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCategoryContentResponse" }, "examples": { "Success Response": { "summary": "This is an example for get category page succes response. \\n Here you can view diffrent data included with multiple Authors associated with a category page.", "value": {"category":{"id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","title":"IndexPage","content":"Content is the information contained within communication media. This includes internet, cinema, television, radio, audio CDs, books, magazines, physical art, and live event content. It’s directed at an end-user or audience in the sectors of publishing, art, and communication","html_content":"Content is the information contained within communication media. This includes internet, cinema, television, radio, audio CDs, books, magazines, physical art, and live event content. It’s directed at an end-user or audience in the sectors of publishing, art, and communication
\n","block_content":null,"parent_category_id":null,"project_document_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":1,"latest_version":1,"enable_rtl":true,"hidden":false,"status":0,"created_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","authors":[{"id":"f11efc6f-e968-4e95-82eb-85ad61559de8","first_name":"peter","last_name":"jone","email_id":"peterjone@mail.com","profile_logo_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","user_role":7,"last_login_at":"2024-06-13T14:30:00","unique_user_name":"peter-jone","sso_user_type":0,"is_sso_user":false,"is_active":false}],"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","slug":"indexpage","is_fall_back_content":true,"stale_status":{"article_stale_status":0,"stale_reason":"","expired_at":"2024-06-13T14:30:00","is_from_document_settings":false,"expire_days":0},"content_type":"Markdown","current_workflow_status_id":null,"is_block_editor":false,"custom_fields":[{"field_id":"field-definition-id-1","name":"Category Type","type":0,"value":"Index Page"},{"field_id":"field-definition-id-2","name":"Display Order","type":6,"value":1}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category not found": { "summary": "Kindly verify the Categotry Id, version Number and Langauage code, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Version not found": { "summary": "Kindly verify the version Number and language code, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category with Id ad6ef117-1e8f-4817-800b-6ed8e2304bf2 with the language code en does not contain version 2","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] }, "put": { "tags": [ "Categories" ], "summary": "Update a category page content with the ID", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } }, { "name": "langCode", "in": "path", "description": "Language code of the category", "required": true, "schema": { "type": "string", "default": "en" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryContentCustomerRequest" } ] }, "examples": { "Successfully Updated Category": { "summary": "Updated Catgory information is shown in this response.", "value": {"title":"UpdateTitleForCategoryPage","content":"This is my updated content.","html_content":"This is my updated content,
","block_content":"This is my updated content,
","version_number":1,"translation_option":"","source":"","updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8"} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryContentCustomerRequest" } ] }, "examples": { "Successfully Updated Category": { "summary": "Updated Catgory information is shown in this response.", "value": {"title":"UpdateTitleForCategoryPage","content":"This is my updated content.","html_content":"This is my updated content,
","block_content":"This is my updated content,
","version_number":1,"translation_option":"","source":"","updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8"} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryContentCustomerRequest" } ] }, "examples": { "Successfully Updated Category": { "summary": "Updated Catgory information is shown in this response.", "value": {"title":"UpdateTitleForCategoryPage","content":"This is my updated content.","html_content":"This is my updated content,
","block_content":"This is my updated content,
","version_number":1,"translation_option":"","source":"","updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8"} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryContentCustomerRequest" } ] }, "examples": { "Successfully Updated Category": { "summary": "Updated Catgory information is shown in this response.", "value": {"title":"UpdateTitleForCategoryPage","content":"This is my updated content.","html_content":"This is my updated content,
","block_content":"This is my updated content,
","version_number":1,"translation_option":"","source":"","updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8"} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCategoryContentCustomerResponse" }, "examples": { "Successfully Updated Category": { "summary": "Updated Catgory information is shown in this response.", "value": {"data":{"id":"d6f49c75-1eea-4101-bfd4-fd314f57815d","title":"UpdateTitleForCategoryPage","content":"This is my updated content.","html_content":"This is my updated content.
\n","block_content":null,"category_id":"d6f49c75-1eea-4101-bfd4-fd314f57815d","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":2,"public_version":1,"latest_version":2,"enable_rtl":false,"hidden":false,"status":0,"order":0,"created_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","authors":[],"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","slug":"updatetitleforcategorypage","is_fall_back_content":false},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"A non-empty request body is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/{categoryId}/versions/{versionNumber}": { "get": { "tags": [ "Categories" ], "summary": "Get category page content with an ID", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "Version number of the category", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "isForDisplay", "in": "query", "description": "Set this to true, if you are displaying the category to the end-user. If true, the content of snippets or variables appears in the category. Note: If the value is true, ensure that the category content is not passed for update category endpoints.", "schema": { "type": "boolean", "default": false } }, { "name": "appendSASToken", "in": "query", "description": "Set this to false to exclude appending SAS token for images/files", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCategoryContentResponse" }, "examples": { "Success Response": { "summary": "This is an sample category data by category version.", "value": {"category":{"id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","title":"IndexPage","content":"Content is the information contained within communication media. This includes internet, cinema, television, radio, audio CDs, books, magazines, physical art, and live event content. It’s directed at an end-user or audience in the sectors of publishing, art, and communication","html_content":"Content is the information contained within communication media. This includes internet, cinema, television, radio, audio CDs, books, magazines, physical art, and live event content. It’s directed at an end-user or audience in the sectors of publishing, art, and communication
\n","block_content":null,"parent_category_id":null,"project_document_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":1,"latest_version":1,"enable_rtl":true,"hidden":false,"status":0,"created_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","authors":[{"id":"f11efc6f-e968-4e95-82eb-85ad61559de8","first_name":"peter","last_name":"jone","email_id":"peterjone@mail.com","profile_logo_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","user_role":7,"last_login_at":"2024-06-13T14:30:00","unique_user_name":"peter-jone","sso_user_type":0,"is_sso_user":false,"is_active":false}],"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","slug":"indexpage","is_fall_back_content":true,"stale_status":{"article_stale_status":0,"stale_reason":"","expired_at":"2024-06-13T14:30:00","is_from_document_settings":false,"expire_days":0},"content_type":"Markdown","current_workflow_status_id":null,"is_block_editor":false,"custom_fields":[{"field_id":"field-definition-id-1","name":"Category Type","type":0,"value":"Index Page"},{"field_id":"field-definition-id-2","name":"Display Order","type":6,"value":1}]},"extension_data":null,"success":false,"errors":null,"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category not found": { "summary": "Kindly verify the Categotry Id and Langauage code, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Version not found": { "summary": "Kindly verify the version Id and Langauage code, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category with Id ad6ef117-1e8f-4817-800b-6ed8e2304bf2 with the language code en does not contain version 2","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/{categoryId}/versions/{langCode}/{versionNumber}": { "get": { "tags": [ "Categories" ], "summary": "Get category page content with an ID", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "Version number of the category", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "langCode", "in": "path", "description": "Language code of the category", "required": true, "schema": { "type": "string", "default": "en" } }, { "name": "isForDisplay", "in": "query", "description": "Set this to true, if you are displaying the category to the end-user. If true, the content of snippets or variables appears in the category. Note: If the value is true, ensure that the category content is not passed for update category endpoints.", "schema": { "type": "boolean", "default": false } }, { "name": "appendSASToken", "in": "query", "description": "Set this to false to exclude appending SAS token for images/files", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCategoryContentResponse" }, "examples": { "Success Response": { "summary": "This is an sample category data by category version.", "value": {"category":{"id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","title":"IndexPage","content":"Content is the information contained within communication media. This includes internet, cinema, television, radio, audio CDs, books, magazines, physical art, and live event content. It’s directed at an end-user or audience in the sectors of publishing, art, and communication","html_content":"Content is the information contained within communication media. This includes internet, cinema, television, radio, audio CDs, books, magazines, physical art, and live event content. It’s directed at an end-user or audience in the sectors of publishing, art, and communication
\n","block_content":null,"parent_category_id":null,"project_document_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":1,"latest_version":1,"enable_rtl":true,"hidden":false,"status":0,"created_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","authors":[{"id":"f11efc6f-e968-4e95-82eb-85ad61559de8","first_name":"peter","last_name":"jone","email_id":"peterjone@mail.com","profile_logo_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","user_role":7,"last_login_at":"2024-06-13T14:30:00","unique_user_name":"peter-jone","sso_user_type":0,"is_sso_user":false,"is_active":false}],"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","slug":"indexpage","is_fall_back_content":true,"stale_status":{"article_stale_status":0,"stale_reason":"","expired_at":"2024-06-13T14:30:00","is_from_document_settings":false,"expire_days":0},"content_type":"Markdown","current_workflow_status_id":null,"is_block_editor":false,"custom_fields":[{"field_id":"field-definition-id-1","name":"Category Type","type":0,"value":"Index Page"},{"field_id":"field-definition-id-2","name":"Display Order","type":6,"value":1}]},"extension_data":null,"success":false,"errors":null,"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category not found": { "summary": "Kindly verify the Categotry Id and Langauage code, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Version not found": { "summary": "Kindly verify the version Id and Langauage code, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category with Id ad6ef117-1e8f-4817-800b-6ed8e2304bf2 with the language code en does not contain version 2","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/{categoryId}/versions": { "get": { "tags": [ "Categories" ], "summary": "Get category page versions", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCategoryVersionsResponse" }, "examples": { "Success response": { "summary": "Success response for getting category page with version.", "value": {"versions":[{"version_number":1,"created_by":null,"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","base_version":0,"status":0,"profile_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E"}],"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category not found": { "summary": "Kindly verify the Categotry Id and Langauage code, and peroform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/{categoryId}/{langCode}versions": { "get": { "tags": [ "Categories" ], "summary": "Get category page versions", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } }, { "name": "langCode", "in": "path", "description": "Language code of the category", "required": true, "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCategoryVersionsResponse" }, "examples": { "Success response": { "summary": "Success response for getting category page with version.", "value": {"versions":[{"version_number":1,"created_by":null,"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","base_version":0,"status":0,"profile_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E"}],"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category not found": { "summary": "Kindly verify the Categotry Id and Langauage code, and peroform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/{categoryId}/settings": { "get": { "tags": [ "Categories" ], "summary": "Get settings for the Category", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCategorySettingsResponse" }, "examples": { "Success Response": { "summary": "Getting settings status for category.", "value": {"data":{"slug":"indexpage","seo_title":"IndexPage","description":null,"allow_comments":true,"show_table_of_contents":true,"featured_image_url":null,"tags":[],"status_indicator":0,"status_indicator_expiry_date":null,"exclude_from_search":false,"exclude_from_ai_search":false,"exclude_from_external_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"custom_fields":[{"field_id":"field-definition-id-1","name":"Category Type","type":0,"value":"Index Page"},{"field_id":"field-definition-id-2","name":"Display Order","type":6,"value":1}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category not found": { "summary": "Kindly verify the Categotry Id and Langauage code, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] }, "put": { "tags": [ "Categories" ], "summary": "Update settings for the category", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"slug":"updatedslug","seo_title":"updatedSeoTitle","description":"This is the description in updating category settings.","allow_comments":true,"show_table_of_contents":true,"tags":[],"status_indicator":1,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"exclude_from_external_search":false,"custom_fields":[{"field_id":"field-definition-id-1","value":"Updated Category Type"},{"field_id":"field-definition-id-2","value":5}]} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"slug":"updatedslug","seo_title":"updatedSeoTitle","description":"This is the description in updating category settings.","allow_comments":true,"show_table_of_contents":true,"tags":[],"status_indicator":1,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"exclude_from_external_search":false,"custom_fields":[{"field_id":"field-definition-id-1","value":"Updated Category Type"},{"field_id":"field-definition-id-2","value":5}]} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"slug":"updatedslug","seo_title":"updatedSeoTitle","description":"This is the description in updating category settings.","allow_comments":true,"show_table_of_contents":true,"tags":[],"status_indicator":1,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"exclude_from_external_search":false,"custom_fields":[{"field_id":"field-definition-id-1","value":"Updated Category Type"},{"field_id":"field-definition-id-2","value":5}]} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"slug":"updatedslug","seo_title":"updatedSeoTitle","description":"This is the description in updating category settings.","allow_comments":true,"show_table_of_contents":true,"tags":[],"status_indicator":1,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"exclude_from_external_search":false,"custom_fields":[{"field_id":"field-definition-id-1","value":"Updated Category Type"},{"field_id":"field-definition-id-2","value":5}]} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCategorySettingsResponse" }, "examples": { "Successfully updated the setings.": { "summary": "This response indicate a category settings has been successfully updated.", "value": {"data":{"slug":"updated-category","seo_title":"Updated Category","description":"Updated category settings description","allow_comments":true,"show_table_of_contents":true,"featured_image_url":null,"tags":["updated","category"],"status_indicator":0,"status_indicator_expiry_date":null,"exclude_from_search":false,"exclude_from_ai_search":false,"exclude_from_external_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"custom_fields":[{"field_id":"field-definition-id-1","name":"Category Type","type":0,"value":"Updated Index Page"},{"field_id":"field-definition-id-2","name":"Display Order","type":6,"value":5}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[{"extension_data":null,"description":"Category settings updated successfully"}]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category Not Found.": { "summary": "Kindly verifty the category Id or the langCode, and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":".Category not found","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"A non-empty request body is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/{categoryId}/{langCode}/settings": { "get": { "tags": [ "Categories" ], "summary": "Get settings for the Category", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } }, { "name": "langCode", "in": "path", "description": "Language code of the category", "required": true, "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCategorySettingsResponse" }, "examples": { "Success Response": { "summary": "Getting settings status for category.", "value": {"data":{"slug":"indexpage","seo_title":"IndexPage","description":null,"allow_comments":true,"show_table_of_contents":true,"featured_image_url":null,"tags":[],"status_indicator":0,"status_indicator_expiry_date":null,"exclude_from_search":false,"exclude_from_ai_search":false,"exclude_from_external_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"custom_fields":[{"field_id":"field-definition-id-1","name":"Category Type","type":0,"value":"Index Page"},{"field_id":"field-definition-id-2","name":"Display Order","type":6,"value":1}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category not found": { "summary": "Kindly verify the Categotry Id and Langauage code, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] }, "put": { "tags": [ "Categories" ], "summary": "Update settings for the category", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } }, { "name": "langCode", "in": "path", "description": "Language code of the category", "required": true, "schema": { "type": "string", "default": "en" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"slug":"updatedslug","seo_title":"updatedSeoTitle","description":"This is the description in updating category settings.","allow_comments":true,"show_table_of_contents":true,"tags":[],"status_indicator":1,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"exclude_from_external_search":false,"custom_fields":[{"field_id":"field-definition-id-1","value":"Updated Category Type"},{"field_id":"field-definition-id-2","value":5}]} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"slug":"updatedslug","seo_title":"updatedSeoTitle","description":"This is the description in updating category settings.","allow_comments":true,"show_table_of_contents":true,"tags":[],"status_indicator":1,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"exclude_from_external_search":false,"custom_fields":[{"field_id":"field-definition-id-1","value":"Updated Category Type"},{"field_id":"field-definition-id-2","value":5}]} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"slug":"updatedslug","seo_title":"updatedSeoTitle","description":"This is the description in updating category settings.","allow_comments":true,"show_table_of_contents":true,"tags":[],"status_indicator":1,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"exclude_from_external_search":false,"custom_fields":[{"field_id":"field-definition-id-1","value":"Updated Category Type"},{"field_id":"field-definition-id-2","value":5}]} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "examples": { "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"slug":"updatedslug","seo_title":"updatedSeoTitle","description":"This is the description in updating category settings.","allow_comments":true,"show_table_of_contents":true,"tags":[],"status_indicator":1,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"exclude_from_external_search":false,"custom_fields":[{"field_id":"field-definition-id-1","value":"Updated Category Type"},{"field_id":"field-definition-id-2","value":5}]} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCategorySettingsResponse" }, "examples": { "Successfully updated the setings.": { "summary": "This response indicate a category settings has been successfully updated.", "value": {"data":{"slug":"updated-category","seo_title":"Updated Category","description":"Updated category settings description","allow_comments":true,"show_table_of_contents":true,"featured_image_url":null,"tags":["updated","category"],"status_indicator":0,"status_indicator_expiry_date":null,"exclude_from_search":false,"exclude_from_ai_search":false,"exclude_from_external_search":false,"related_articles":[],"content_type":0,"is_acknowledgement_enabled":false,"custom_fields":[{"field_id":"field-definition-id-1","name":"Category Type","type":0,"value":"Updated Index Page"},{"field_id":"field-definition-id-2","name":"Display Order","type":6,"value":5}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[{"extension_data":null,"description":"Category settings updated successfully"}]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category Not Found.": { "summary": "Kindly verifty the category Id or the langCode, and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":".Category not found","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Non-Empty body is required.": { "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"A non-empty request body is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/bulkcreate": { "post": { "tags": [ "Categories" ], "summary": "Adds multiple Categories", "requestBody": { "description": "A list of category creation requests. For each category, the 'slug' property is optional - if not provided, a slug will be auto-generated from the name. When provided, the slug must be unique within the project version, otherwise an error will be returned for that category.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddCategoryRequest" } }, "examples": { "Create a new Category as Folder.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] }, "Create a new Category as Page.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] }, "Create a new Category as Index.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddCategoryRequest" } }, "examples": { "Create a new Category as Folder.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] }, "Create a new Category as Page.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] }, "Create a new Category as Index.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddCategoryRequest" } }, "examples": { "Create a new Category as Folder.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] }, "Create a new Category as Page.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] }, "Create a new Category as Index.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddCategoryRequest" } }, "examples": { "Create a new Category as Folder.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] }, "Create a new Category as Page.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] }, "Create a new Category as Index.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCreateCategoryResponse" }, "examples": { "Update article wth article Id": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option, and source.", "value": {"data":[{"category_id":"b1a857d9-ecbc-4ab3-a0cb-ed22267ec999","success":true,"details":"Successfully created category New Category 1"},{"category_id":"975a72df-a8b6-4a4e-8081-be9baddd0467","success":true,"details":"Successfully created category New Category 2"}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "No Category created": { "summary": "Kindly add some data to create category.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "Empty project_version_id Parameters": { "summary": "Kindly verify the project_version_id is not empty, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The ProjectVersionId field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Invalid Category Name Parameter": { "summary": "Kindly verify the Name, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The Name field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/{categoryId}/publish": { "post": { "tags": [ "Categories" ], "summary": "Publishes an category with an id", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishCategoryRequest" } ] }, "examples": { "Publish Category Request Example": { "summary": "This is an basic example for publish category. UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Successfully Published"} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishCategoryRequest" } ] }, "examples": { "Publish Category Request Example": { "summary": "This is an basic example for publish category. UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Successfully Published"} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishCategoryRequest" } ] }, "examples": { "Publish Category Request Example": { "summary": "This is an basic example for publish category. UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Successfully Published"} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishCategoryRequest" } ] }, "examples": { "Publish Category Request Example": { "summary": "This is an basic example for publish category. UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Successfully Published"} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCreateCategoryResponse" }, "examples": { "Successfully Published Category": { "summary": "Category page\t\t", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "CategoryId not found": { "summary": "kindly verify the CategoryId and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "version_number not found": { "summary": "kindly verify the version_number and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The field VersionNumber must be between 1 and 32767.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "user_id not found": { "summary": "Kindly verify the user_id nad perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The UserId field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/update-workflow": { "post": { "tags": [ "Categories" ], "summary": "Update workflow status of the page categories", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryWorkflowStatusRequest" } ] }, "example": {"project_version_id":"ae430990-88df-4886-b1e6-2596ae416df7","lang_code":"en","user_id":"43340990-88df-4886-b1e6-2596ae416df7","category_ids":["ea35f84c-394b-407c-80e9-4187a7ea9620","49fe8b58-2e21-4251-b10d-cec4c5a8769f"],"workflow_status_info":{"status_id":"65545e06-8c41-4e1a-a090-c603f9f1b4b2","due_date":"2024-06-13T14:30:00","comment":"Ready for review","assignee_id":"eed92685-0c5e-46b4-b559-c27625fe7a6b"}} }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryWorkflowStatusRequest" } ] }, "example": {"project_version_id":"ae430990-88df-4886-b1e6-2596ae416df7","lang_code":"en","user_id":"43340990-88df-4886-b1e6-2596ae416df7","category_ids":["ea35f84c-394b-407c-80e9-4187a7ea9620","49fe8b58-2e21-4251-b10d-cec4c5a8769f"],"workflow_status_info":{"status_id":"65545e06-8c41-4e1a-a090-c603f9f1b4b2","due_date":"2024-06-13T14:30:00","comment":"Ready for review","assignee_id":"eed92685-0c5e-46b4-b559-c27625fe7a6b"}} }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryWorkflowStatusRequest" } ] }, "example": {"project_version_id":"ae430990-88df-4886-b1e6-2596ae416df7","lang_code":"en","user_id":"43340990-88df-4886-b1e6-2596ae416df7","category_ids":["ea35f84c-394b-407c-80e9-4187a7ea9620","49fe8b58-2e21-4251-b10d-cec4c5a8769f"],"workflow_status_info":{"status_id":"65545e06-8c41-4e1a-a090-c603f9f1b4b2","due_date":"2024-06-13T14:30:00","comment":"Ready for review","assignee_id":"eed92685-0c5e-46b4-b559-c27625fe7a6b"}} }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryWorkflowStatusRequest" } ] }, "example": {"project_version_id":"ae430990-88df-4886-b1e6-2596ae416df7","lang_code":"en","user_id":"43340990-88df-4886-b1e6-2596ae416df7","category_ids":["ea35f84c-394b-407c-80e9-4187a7ea9620","49fe8b58-2e21-4251-b10d-cec4c5a8769f"],"workflow_status_info":{"status_id":"65545e06-8c41-4e1a-a090-c603f9f1b4b2","due_date":"2024-06-13T14:30:00","comment":"Ready for review","assignee_id":"eed92685-0c5e-46b4-b559-c27625fe7a6b"}} } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Update Workflow - 200 Success response.": { "summary": "The below example shows a successful workflow update response", "value": {"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Missing ProjectDocumentVersionId": { "summary": "The 'ProjectDocumentVersionId' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"ProjectDocumentVersion ID is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Missing LangCode": { "summary": "The 'LangCode' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Language code is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Missing UserId": { "summary": "The 'UserId' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"User Id is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Missing DocumentIds": { "summary": "The 'DocumentIds' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Document IDs are required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Missing WorkflowStatusInfo": { "summary": "The 'WorkflowStatusInfo' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Workflow status information is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/bulkupdateContent": { "put": { "tags": [ "Categories" ], "summary": "Update multiple page categories", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateCategoryContentRequest" } }, "examples": { "Update multiple page category ": { "summary": "Update multiple page category. Kindly for the needed page category for the bulk updation. you can find the updated_by (user id) from /V2/Teams Get Method.", "value": [{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6","lang_code":"en","title":"New Name","content":"No new content","html_content":"No new content
","block_content":"No new content
","version_number":2,"translation_option":null,"source":null,"updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8"}] } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateCategoryContentRequest" } }, "examples": { "Update multiple page category ": { "summary": "Update multiple page category. Kindly for the needed page category for the bulk updation. you can find the updated_by (user id) from /V2/Teams Get Method.", "value": [{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6","lang_code":"en","title":"New Name","content":"No new content","html_content":"No new content
","block_content":"No new content
","version_number":2,"translation_option":null,"source":null,"updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8"}] } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateCategoryContentRequest" } }, "examples": { "Update multiple page category ": { "summary": "Update multiple page category. Kindly for the needed page category for the bulk updation. you can find the updated_by (user id) from /V2/Teams Get Method.", "value": [{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6","lang_code":"en","title":"New Name","content":"No new content","html_content":"No new content
","block_content":"No new content
","version_number":2,"translation_option":null,"source":null,"updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8"}] } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateCategoryContentRequest" } }, "examples": { "Update multiple page category ": { "summary": "Update multiple page category. Kindly for the needed page category for the bulk updation. you can find the updated_by (user id) from /V2/Teams Get Method.", "value": [{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6","lang_code":"en","title":"New Name","content":"No new content","html_content":"No new content
","block_content":"No new content
","version_number":2,"translation_option":null,"source":null,"updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8"}] } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdateCategoryContentResponse" }, "examples": { "Bulk Update Successful": { "summary": "You can find all the updated Category page details below.", "value": {"data":[{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6","success":true,"details":"Successfully updated category with an id 152e9239-1a5a-4044-b5de-1030f49976b6"}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category not Found": { "summary": "The enhtered categoryId is not valid. Kindly verify the categoryId and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Failed to update category with an id 152e9239-1a5a-044-b5de-103f49976b6\r\nError: Category not found' does not exist in your project.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "UserId not Found": { "summary": "The user_id is not found. kindly verify the updated_by (user id) from /V2/Teams Get Method", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Failed to update category with an id 152e9239-1a5a-4044-b5de-1030f49976b6\r\nError: The user with id '6f-e968-4e95-82eb-85ad61559de8' does not exist in your project.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/{categoryId}/fork": { "put": { "tags": [ "Categories" ], "summary": "Fork category page with an id", "parameters": [ { "name": "categoryId", "in": "path", "description": "ID of the category", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForkCategoryVersionRequest" } ] }, "examples": { "Fork category page with Id": { "summary": "Fork category page with current version_number, user_id and lang_code.", "value": {"version_number":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","lang_code":"en"} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForkCategoryVersionRequest" } ] }, "examples": { "Fork category page with Id": { "summary": "Fork category page with current version_number, user_id and lang_code.", "value": {"version_number":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","lang_code":"en"} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForkCategoryVersionRequest" } ] }, "examples": { "Fork category page with Id": { "summary": "Fork category page with current version_number, user_id and lang_code.", "value": {"version_number":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","lang_code":"en"} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForkCategoryVersionRequest" } ] }, "examples": { "Fork category page with Id": { "summary": "Fork category page with current version_number, user_id and lang_code.", "value": {"version_number":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","lang_code":"en"} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForkCategoryVersionResponse" }, "examples": { "Fork category page with Id": { "summary": "Fork category page with current version_number, user_id and lang_code.", "value": {"data":{"version_number":2,"created_by":"peter jone","created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","base_version":1,"status":0,"profile_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E"},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category not found": { "summary": "Category page not found in the context. Kindly verify the categoryId and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found","error_code":"","custom_data":null}],"warnings":[],"information":[]} }, "UserId not found": { "summary": "UserId not found in the context. Kindly verify the categoryId and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de' does not exist in your project.","error_code":"","custom_data":null}],"warnings":[],"information":[]} }, "Version Number not found": { "summary": "Version Number not found in the context. Kindly verify the categoryId and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Cannot fork version number 5, it does not exist in your project","error_code":"","custom_data":null}],"warnings":[],"information":[]} }, "LangCode not found": { "summary": "LangCode is missing in the Request Body. Kindly verify the categoryId and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"The LangCode field is required.","error_code":"","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/{categoryId}/updateCategoryType": { "put": { "tags": [ "Categories" ], "summary": "Update the Category Type", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } }, { "name": "categoryType", "in": "query", "description": "Category type (0-Folder, 1-Page, 2-Index)", "required": true, "schema": { "enum": [ "default", "customContent", "linksToArticle" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/CategoryType" } ], "description": "0 - Folder, 1 - Page, 2 - Index", "x-enumNames": [ "Default", "CustomContent", "LinksToArticle" ], "x-enum-varnames": [ "Default", "CustomContent", "LinksToArticle" ], "x-ms-enum": { "name": "CategoryType", "modelAsString": true } } }, { "name": "userId", "in": "query", "description": "The ID of the team account", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category type Updated Successfully": { "summary": "Updated the category type. Status updated successfully.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "CategoryId not found": { "summary": "Kindly update the category Id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} }, "userId not found": { "summary": "Kindly update the user Id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/{categoryId}/updateDescription": { "put": { "tags": [ "Categories" ], "summary": "Update the category description", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "The description of the category", "schema": { "maxLength": 250, "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category description updated success": { "summary": "Kindly update the category Id and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "Description not found": { "summary": "Kindly update the description and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category Id not found": { "summary": "Kindly update the Category Id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found","error_code":"","custom_data":null}],"warnings":[],"information":[]} }, "LangCode not found": { "summary": "Kindly update the Language code and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} } } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/{categoryId}/{langCode}/updateDescription": { "put": { "tags": [ "Categories" ], "summary": "Update the category description", "parameters": [ { "name": "categoryId", "in": "path", "description": "The ID of the category", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "The description of the category", "schema": { "maxLength": 250, "type": "string" } }, { "name": "langCode", "in": "path", "description": "Language code of the category", "required": true, "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category description updated success": { "summary": "Kindly update the category Id and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "Description not found": { "summary": "Kindly update the description and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category Id not found": { "summary": "Kindly update the Category Id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found","error_code":"","custom_data":null}],"warnings":[],"information":[]} }, "LangCode not found": { "summary": "Kindly update the Language code and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/customfields": { "get": { "tags": [ "CustomField" ], "summary": "Gets all custom field definitions.", "description": "This endpoint returns metadata about all custom fields configured for your project.\r\nUse this information to understand available fields before updating article settings.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCustomFieldDefinitionsResponse" }, "examples": { "Success Response": { "summary": "This response shows all custom field definitions available for the project. Use the field names and metadata to construct update requests.", "value": {"data":[{"field_id":"field-definition-id-1","name":"Country","type":0,"placeholder":"Enter country name","help_text":"The country where this article applies","max_length":100},{"field_id":"field-definition-id-2","name":"Priority","type":6,"placeholder":"Enter priority","help_text":"Priority level (1=lowest, 10=highest)"},{"field_id":"field-definition-id-3","name":"Status","type":2,"placeholder":"Select status","help_text":"Current article status","options":[{"id":"option-id-active","label":"Active"},{"id":"option-id-inactive","label":"Inactive"}]}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Invalid Project": { "summary": "This error occurs when the project ID is invalid or custom fields feature is not enabled.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Custom fields feature is not enabled for this project","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Drive/Folders/{folderId}": { "delete": { "tags": [ "Drive" ], "summary": "Delete a folder", "parameters": [ { "name": "folderId", "in": "path", "description": "The ID of the folder in Drive", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Success status response": { "summary": "A folder has been deleted successfully.The folder cannot be retrieved or undo.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[{"extension_data":null,"description":"Deleted folder successfully"}]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Bad Response": { "summary": "Kindly verify the folder and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] }, "get": { "tags": [ "Drive" ], "summary": "Gets folder information by folder ID", "parameters": [ { "name": "folderId", "in": "path", "description": "The ID of the folder in Drive", "required": true, "schema": { "type": "string" } }, { "name": "appendSASToken", "in": "query", "description": "Set this to false to exclude appending SAS token for images/files", "schema": { "type": "boolean", "default": false } }, { "name": "pageNo", "in": "query", "description": "Specify the page to retrieve. Page numbers are zero-based. Therefore, to retrieve the 10th page, you need to set page=9", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "The number of results per page", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMediaFolderWithIdCustomer" }, "examples": { "Success status response": { "summary": "Here, you can verify the folder’s information using the folder ID.", "value": {"data":{"id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","title":"Document","order":1,"parent_folder_id":null,"files":[{"id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","file_name":"New-Image","file_type":"Other","file_url":"https://file.example.com/new-image.jpg","updated_on":"2024-06-13T14:30:00","updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","size":"235","height":null,"width":null,"title":null,"alternative_text":null,"thumbnail_url":null,"tags":[{"id":"d8b65d24-ce62-407a-8463-846efc8eee93","tag_name":"new-tag"}],"is_starred":true}],"icon":null,"items_count":1,"updated_on":"2024-06-13T14:30:00","updated_by":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","is_starred":false,"folder_color":null,"files_count":1,"sub_folders":[{"id":"d8b65d24-ce62-407a-8463-846efc8eee93","title":"Images","parent_folder_id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","sub_folders":[],"items_count":0,"updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","created_at":null,"updated_on":"2024-06-13T14:30:00","order":2,"is_starred":true}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Bad response": { "summary": "Kindly verify the given folder ID is valid and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Drive/Folders/{folderId}/{fileId}": { "delete": { "tags": [ "Drive" ], "summary": "Delete file using file ID", "parameters": [ { "name": "folderId", "in": "path", "description": "The ID of the folder in Drive", "required": true, "schema": { "type": "string" } }, { "name": "fileId", "in": "path", "description": "The ID of the file in Drive", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteMediaFileResponseCustomer" }, "examples": { "Success status response": { "summary": "A file has been deleted successfully.The file cannot be retrieved or undo.", "value": {"task_id":"65868a00c536f34594713fec","extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Bad Response": { "summary": "Kindly verify the file and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] }, "get": { "tags": [ "Drive" ], "summary": "Gets file information", "parameters": [ { "name": "folderId", "in": "path", "description": "The ID of drive folder", "required": true, "schema": { "type": "string" } }, { "name": "fileId", "in": "path", "description": "The ID of file", "required": true, "schema": { "type": "string" } }, { "name": "appendSASToken", "in": "query", "description": "Set this to false to exclude appending SAS token for images/files", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFileAndTagsMetaDataResponseCustomer" }, "examples": { "Success status response": { "summary": "Here, you can verify the file’s information.", "value": {"data":{"id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","file_name":"New-Image","file_type":"Other","file_url":"https://file.example.com/new-image.jpg","updated_on":"2024-06-13T14:30:00","updated_by":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","size":"235","height":null,"width":null,"parent_folder_id":null,"title":"Document","alternative_text":null,"tags":[{"id":"d8b65d24-ce62-407a-8463-846efc8eee93","tag_name":"new-tag"}],"thumbnail_url":"https://file.example.com/New-thumbnail-url","is_starred":true},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Bad Response": { "summary": "Kindly verify the given file is valid and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] }, "put": { "tags": [ "Drive" ], "summary": "Move a file with file ID", "parameters": [ { "name": "folderId", "in": "path", "description": "The ID of target folder", "required": true, "schema": { "type": "string" } }, { "name": "fileId", "in": "path", "description": "The ID of file", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Success status response": { "summary": "This status indicates a file has been moved successfully.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[{"extension_data":null,"description":"File has been moved successfully"}]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Bad Response": { "summary": "Kindly verify the given file is valid and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Drive/Folders": { "get": { "tags": [ "Drive" ], "summary": "Gets folders information", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMediaFolderResponseCustomer" }, "examples": { "Success status response": { "summary": "Here, you can verify the folder’s information.", "value": {"data":[{"id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","title":"Document","parent_folder_id":"fsf41c-0f94-4b04-a8b6-a14bb1995eca","sub_folders":[{"id":"d8b65d24-ce62-407a-8463-846efc8eee93","title":"Images","parent_folder_id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","sub_folders":[],"items_count":0,"updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","created_at":null,"updated_on":"2024-06-13T14:30:00","order":2,"is_starred":true}],"items_count":1,"updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","created_at":null,"updated_on":"2024-06-13T14:30:00","order":1,"is_starred":true}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Bad Response": { "summary": "Kindly verify the given folder is valid and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] }, "post": { "tags": [ "Drive" ], "summary": "Add new folder in drive", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddMediaFolderRequestCustomer" } ] }, "examples": { "Add media folder": { "summary": "Request body for adding folder with parentfolderId, name and order.", "value": {"title":"Title","parent_folder_id":"d8b65d24-ce62-407a-8463-846efc8eee93","user_id":"ffb65d24-ce62-407a-84d-8dfdfefc8eee93","order":1} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddMediaFolderRequestCustomer" } ] }, "examples": { "Add media folder": { "summary": "Request body for adding folder with parentfolderId, name and order.", "value": {"title":"Title","parent_folder_id":"d8b65d24-ce62-407a-8463-846efc8eee93","user_id":"ffb65d24-ce62-407a-84d-8dfdfefc8eee93","order":1} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddMediaFolderRequestCustomer" } ] }, "examples": { "Add media folder": { "summary": "Request body for adding folder with parentfolderId, name and order.", "value": {"title":"Title","parent_folder_id":"d8b65d24-ce62-407a-8463-846efc8eee93","user_id":"ffb65d24-ce62-407a-84d-8dfdfefc8eee93","order":1} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddMediaFolderRequestCustomer" } ] }, "examples": { "Add media folder": { "summary": "Request body for adding folder with parentfolderId, name and order.", "value": {"title":"Title","parent_folder_id":"d8b65d24-ce62-407a-8463-846efc8eee93","user_id":"ffb65d24-ce62-407a-84d-8dfdfefc8eee93","order":1} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFolderMetaDataResponseCustomer" }, "examples": { "Bad Response": { "summary": "The folder has been created successfully.", "value": {"data":{"media_folder_id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","media_folder_title":"Folder Title","order":1,"icon":null,"updated_on":"2024-06-13T14:30:00","folder_color":null,"is_starred":true,"updated_by":"fdsc041c-0f94-4b04-a8b6-a14bb1995eca","parent_media_folder_id":null},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Bad Response": { "summary": "Kindly check your folder credentials and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] }, "put": { "tags": [ "Drive" ], "summary": "Update a folder with ID", "parameters": [ { "name": "folderId", "in": "query", "description": "The ID of drive folder", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateMediaFolderRequestCustomer" } ] }, "examples": { "Update media folder": { "summary": "Request body for updating folder with name,order,folder color and IsStarred. ", "value": {"name":"Updated folder name","order":2,"folder_color":"#8852F5","is_starred":true} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateMediaFolderRequestCustomer" } ] }, "examples": { "Update media folder": { "summary": "Request body for updating folder with name,order,folder color and IsStarred. ", "value": {"name":"Updated folder name","order":2,"folder_color":"#8852F5","is_starred":true} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateMediaFolderRequestCustomer" } ] }, "examples": { "Update media folder": { "summary": "Request body for updating folder with name,order,folder color and IsStarred. ", "value": {"name":"Updated folder name","order":2,"folder_color":"#8852F5","is_starred":true} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateMediaFolderRequestCustomer" } ] }, "examples": { "Update media folder": { "summary": "Request body for updating folder with name,order,folder color and IsStarred. ", "value": {"name":"Updated folder name","order":2,"folder_color":"#8852F5","is_starred":true} } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFolderMetaDataResponseCustomer" }, "examples": { "Bad Response": { "summary": "This response indicates the folder has been updated successfully.", "value": {"data":{"media_folder_id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","media_folder_title":"Folder Title","order":1,"icon":null,"updated_on":"2024-06-13T14:30:00","folder_color":null,"is_starred":true,"updated_by":"fdsc041c-0f94-4b04-a8b6-a14bb1995eca","parent_media_folder_id":null},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Bad Response": { "summary": "Kindly verify the folder ID and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Drive/Search": { "get": { "tags": [ "Drive" ], "summary": "Drive search - files and folders", "parameters": [ { "name": "searchKeyword", "in": "query", "description": "Keyword to search file items from drive", "schema": { "type": "string" } }, { "name": "pageNo", "in": "query", "description": "Specify the page to retrieve. Page numbers are zero-based. Therefore, to retrieve the 10th page, you need to set page=9", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "take", "in": "query", "description": "The number of results per page", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "allowImagesOnly", "in": "query", "description": "Allow images only in response", "schema": { "type": "boolean", "default": false } }, { "name": "userIds", "in": "query", "description": "Find by userId", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filterFromDate", "in": "query", "description": "Filter using from-date", "schema": { "type": "string", "format": "date-time" } }, { "name": "filterToDate", "in": "query", "description": "Filter using to-date", "schema": { "type": "string", "format": "date-time" } }, { "name": "filterTags", "in": "query", "description": "Filter using tagIds", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllFilesWithCountResponseCustomer" }, "examples": { "Bad Response": { "summary": "This response indicates the process has been completed.", "value": {"data":{"all_files":[{"id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","file_name":"File name","file_type":"Other","file_url":"https://file.example.com/file.png","updated_on":"2024-06-13T14:30:00","updated_by":"ff9c041c-0f94-4b04-a8b6-a14bb1995eca","size":"342","height":null,"width":null,"title":"File title","alternative_text":null,"is_starred":false,"parent_folder_id":"sdfs041c-0f94-4b04-a8b6-a14bb19fwefver","tag_ids":["e79c041c-0f94-4b04-a8b6-a14bb1995eca","f79c041c-0f94-4b04-a8b6-a14bb1995eca"]}],"count":12},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Bad Response": { "summary": "Kindly verify the status and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Drive/Folders/DeleteFile/Status/{taskId}": { "get": { "tags": [ "Drive" ], "summary": "Get status of the delete file operation", "parameters": [ { "name": "taskId", "in": "path", "description": "The task ID of the file deleted", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCustomerTaskStatusResponse" }, "examples": { "Success status response": { "summary": "This example shows the status response for deleting a file operation that has been completed.", "value": {"task_status":{"task_id":"65868a00c536f34594713fec","is_complete":true,"status":2},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Bad response": { "summary": "This example shows that the given status is invalid. Perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Drive/MediaFiles/{projectVersionId}/{articleId}/{langCode}": { "get": { "tags": [ "Drive" ], "summary": "Get all media files inserted in the article", "parameters": [ { "name": "projectVersionId", "in": "path", "description": "The ID of the project version", "required": true, "schema": { "type": "string" } }, { "name": "articleId", "in": "path", "description": "The ID of the article", "required": true, "schema": { "type": "string" } }, { "name": "langCode", "in": "path", "description": "Language code of the article", "required": true, "schema": { "type": "string" } }, { "name": "appendSASToken", "in": "query", "description": "Set this to false to exclude appending SAS token for images/files", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDriveFilesInArticleDataCustomer" }, "examples": { "Success status response": { "summary": "This is a sample success status response.", "value": {"article_id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","file_urls":["https://file.example.com/new-image.jpg","https://file.example.com/sample-image.jpg"],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Bad Response": { "summary": "Kindly verify your media files and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Drive/Folders/Files": { "post": { "tags": [ "Drive" ], "summary": "Add file in to drive", "parameters": [ { "name": "DriveFolderId", "in": "query", "description": "The folder ID", "required": true, "schema": { "type": "string" } }, { "name": "UserId", "in": "query", "description": "The ID of the team account", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "files" ], "type": "object", "properties": { "files": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "File collection -The maximum file size upload limit is 40MB" } } }, "encoding": { "files": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddMediaFileResponseCustomer" }, "examples": { "Success status response": { "summary": "This response indicates that the files were added to the drive successfully.", "value": {"data":[{"id":"d8b65d24-ce62-407a-8463-846efc8eee93","title":"Title name","file_name":"File name","file_type":"Other","file_url":"https://file.example.com/file.png","updated_by":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","media_folder_id":null}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Bad Response": { "summary": "Ensure the given file is valid and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Drive/Folders/{folderId}/{fileId}/Tags": { "post": { "tags": [ "Drive" ], "summary": "Add tags in a file using file ID", "parameters": [ { "name": "folderId", "in": "path", "description": "The folder ID", "required": true, "schema": { "type": "string" } }, { "name": "fileId", "in": "path", "description": "The file ID", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "Team account ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of tag names", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFileDataResponseCustomer" }, "examples": { "Success status response": { "summary": "The tags have been added.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[{"extension_data":null,"description":"Tags added to the file successfully"}]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Bad Response": { "summary": "Kindly verify your tags are valid and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Drive/Folders/{folderId}/{fileId}/Tags/Bulkdelete": { "post": { "tags": [ "Drive" ], "summary": "Delete tags from files", "parameters": [ { "name": "folderId", "in": "path", "description": "The folder ID", "required": true, "schema": { "type": "string" } }, { "name": "fileId", "in": "path", "description": "The file ID", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "Team account ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of tag Ids", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFileDataResponseCustomer" }, "examples": { "Success status response": { "summary": "This states that tags have been deleted successfully.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[{"extension_data":null,"description":"Tags deleted from the file successfully"}]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Bad Response": { "summary": "Kindly verify your tags are valid and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Drive/Folders/{folderId}/{fileId}/Copy": { "post": { "tags": [ "Drive" ], "summary": "Copy file from one folder to another", "parameters": [ { "name": "folderId", "in": "path", "description": "Target folder ID", "required": true, "schema": { "type": "string" } }, { "name": "fileId", "in": "path", "description": "Selected file ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Success status response": { "summary": "This response indicates that a file has been successfully copied from one folder to another.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[{"extension_data":null,"description":"File has been copied successfully."}]} } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Bad Response": { "summary": "Kindly check your folder credentials and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Language/{projectVersionId}": { "get": { "tags": [ "Language" ], "summary": "Gets all version languages in the project", "parameters": [ { "name": "projectVersionId", "in": "path", "description": "The ID of the project version", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLanguageFromProjectVersion" }, "examples": { "Language versions in a project": { "summary": "This is the enabled language versions for the following project.", "value": {"data":[{"language_id":"850668e5-cbf6-4522-850668e5-cbf6-4522","language_code":"en","language_name":"English","is_set_as_default":true,"country_flag_code":null},{"language_id":"850634e-a748-4522-850668e5-cbf6-4522","language_code":"zh","language_name":"Chinese","is_set_as_default":false,"country_flag_code":null},{"language_id":"850668e5-cbf6-4522-8534e-a748-4522","language_code":"nl","language_name":"Dutch","is_set_as_default":false,"country_flag_code":null}],"extension_data":null,"success":true,"errors":null,"warnings":null,"information":null} } } } } } }, "security": [ { "api_token": [ ] } ] } }, "/v2/Project/Export/{exportId}": { "get": { "tags": [ "Project" ], "summary": "Get the status of export", "parameters": [ { "name": "exportId", "in": "path", "description": "The ID of the export request", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportDocumentationStatusResponse" }, "examples": { "Export Documentation - success Status response": { "summary": "The below example shows the status response for export documentation has successfully Completed.", "value": {"status":"Completed","download_url":"https://document.com//exp/To configure Single Sign On in Document360, follow these steps: