- Print
- DarkLight
Publish an API reference with apiReferenceId, projectVersionId, and userId.
{
"api_reference_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8"
}
The ID of the API reference
The ID of the project version
The ID of the team account
Publish an API reference with apiReferenceId, projectVersionId, and userId.
{
"api_reference_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8"
}
The ID of the API reference
The ID of the project version
The ID of the team account
Publish an API reference with apiReferenceId, projectVersionId, and userId.
{
"api_reference_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8"
}
The ID of the API reference
The ID of the project version
The ID of the team account
Publish an API reference with apiReferenceId, projectVersionId, and userId.
{
"api_reference_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8"
}
The ID of the API reference
The ID of the project version
The ID of the team account
Success
API reference has been successfully published. You can view the published endpoints in the KB site.
{
"extension_data": null,
"success": true,
"errors": null,
"warnings": [],
"information": []
}
Status indication for customer API response
Errors in the customer API response
Stack trace for error response message
Description for error cause
Error code for Api response
Warning in the customer API response
Warning description
warning code for customer Api base response
Information passed by the customer API response
status description for customer Api response information
Bad Request
Kindly verify the API reference ID and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Invalid API reference",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}
Kindly verify the project version ID and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The supplied project version id 'd2eafb73-ccb6-4d15-9c4a-959b3c232ddba' does not exist in your project",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}
Kindly verify the team account ID and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de8a' does not exist in your project.",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}
Since all the articles are already in a published state, they cannot be published again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "All articles are already in published state.",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}
Status indication for customer API response
Errors in the customer API response
Stack trace for error response message
Description for error cause
Error code for Api response
Warning in the customer API response
Warning description
warning code for customer Api base response
Information passed by the customer API response
status description for customer Api response information