Contents x
Forks an article with an ID
  • 16 Mar 2023
  • 4 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
Contents

Forks an article with an ID

  • Updated on 16 Mar 2023
  • 4 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
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
string Required

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 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 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 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 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": "2023-03-16T13:17:47.3825682Z",
    "modified_at": "2023-03-16T13:17:47.3825686Z",
    "base_version": 3,
    "status": 5,
    "profile_url": "https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E"
  },
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
data
object
version_number
integer

The version number of the article

created_by
string

Author name

created_at
string

The date the article version was created

modified_at
string

The last time the article version was modified

base_version
integer

The version number from which this article version is derived

status
integer
Valid values[0,1,2,3,4,5]
profile_url
string

Author profile image

extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

status description for customer Api response information

400

Bad Request

user_id not found.

Kindly verify the user_id and perform the task again.

{
  "data": null,
  "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.

{
  "data": null,
  "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.

{
  "data": null,
  "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.

{
  "data": null,
  "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": []
}
Expand All
object
data
object
version_number
integer

The version number of the article

created_by
string

Author name

created_at
string

The date the article version was created

modified_at
string

The last time the article version was modified

base_version
integer

The version number from which this article version is derived

status
integer
Valid values[0,1,2,3,4,5]
profile_url
string

Author profile image

extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

status description for customer Api response information

Was this article helpful?
What's Next