Forks an article with an id
- 02 Nov 2024
- 4 Minutes To Read
- Contributors
- Print
- Dark modeLight
- PDF
Forks an article with an id
- Updated On 02 Nov 2024
- 4 Minutes To Read
- Contributors
- Print
- Dark modeLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Put
/v2/Articles/{articleId}/fork
Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Path parameters
articleId
stringRequired
The ID of the article
Body parameters
Non-Empty body is required.
This response is due to an empty request body. \n Kindly make some body parameters to get success response.
{
"version_number": 2,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"lang_code": "en"
}object
version_number
integer (int32) Required
The version number of the article to be forked
user_id
string Required
The ID of the team account that will be marked as the contributor of this fork
Min length1
lang_code
string Required
Language code of the article
Min length1
Non-Empty body is required.
This response is due to an empty request body. \n Kindly make some body parameters to get success response.
{
"version_number": 2,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"lang_code": "en"
}object
version_number
integer (int32) Required
The version number of the article to be forked
user_id
string Required
The ID of the team account that will be marked as the contributor of this fork
Min length1
lang_code
string Required
Language code of the article
Min length1
Non-Empty body is required.
This response is due to an empty request body. \n Kindly make some body parameters to get success response.
{
"version_number": 2,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"lang_code": "en"
}object
version_number
integer (int32) Required
The version number of the article to be forked
user_id
string Required
The ID of the team account that will be marked as the contributor of this fork
Min length1
lang_code
string Required
Language code of the article
Min length1
Non-Empty body is required.
This response is due to an empty request body. \n Kindly make some body parameters to get success response.
{
"version_number": 2,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"lang_code": "en"
}object
version_number
integer (int32) Required
The version number of the article to be forked
user_id
string Required
The ID of the team account that will be marked as the contributor of this fork
Min length1
lang_code
string Required
Language code of the article
Min length1
Responses
200
Success
Non-Empty body is required.
This response is due to an empty request body. \n Kindly make some body parameters to get success response.
{
"data": {
"version_number": 4,
"created_by": "peter jone",
"created_at": "2024-06-13T02:30:00Z",
"modified_at": "2024-06-13T02:30:00Z",
"base_version": 3,
"status": 0,
"profile_url": "https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E"
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}object
data
object | null
forked article data
version_number
integer (int32)
The version number of the article
created_by
string | null
Author name
created_at
string (date-time)
The date the article version was created
modified_at
string (date-time)
The last time the article version was modified
base_version
integer (int32)
The version number from which this article version is derived
status
integer (int32)
The status of the article: 0 - Draft, 3 - Published
Valid values[ 0, 3 ]
profile_url
string | null
Author profile image
extension_data
object | null
Extention data for customer API response
success
boolean
Status indication for customer API response
errors
Array of object (BaseError) | null
Errors in the customer API response
object
extension_data
object | null
Thids is the Extention data object
stack_trace
string | null
Stack trace for error response message
description
string | null
Description for error cause
error_code
string | null
Error code for Api response
custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null
Warnings in the customer API response
object
extension_data
object | null
Extention Data for customer Api warning
description
string | null
Warning description
warning_code
string | null
warning code for customer Api base response
information
Array of object (BaseInformation) | null
Information passed by the customer API response
object
extension_data
object | null
Extention data for customer Api response information
description
string | null
status description for customer Api response information
400
Bad Request
user_id not found.
Kindly verify the user_id and perform the task again.
{
"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.
Kindly verify the lang_code and perform the task again.
{
"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.
Kindly verify the version_number and perform the task again.
{
"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.
Kindly verify the Article Id and perform the task again.
{
"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": []
}object
extension_data
object | null
Extention data for customer API response
success
boolean
Status indication for customer API response
errors
Array of object (BaseError) | null
Errors in the customer API response
object
extension_data
object | null
Thids is the Extention data object
stack_trace
string | null
Stack trace for error response message
description
string | null
Description for error cause
error_code
string | null
Error code for Api response
custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null
Warnings in the customer API response
object
extension_data
object | null
Extention Data for customer Api warning
description
string | null
Warning description
warning_code
string | null
warning code for customer Api base response
information
Array of object (BaseInformation) | null
Information passed by the customer API response
object
extension_data
object | null
Extention data for customer Api response information
description
string | null
status description for customer Api response information
Was this article helpful?
