> For the complete documentation index, see [llms.txt](https://inquiry.sunbird.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://inquiry.sunbird.org/learn/product-and-developer-guide/question-and-question-set-service/apis/v2/questionset-apis/publish-questionset.md).
# Publish QuestionSet
## This API is used to publish the question set on the Sunbird-inQuiry Platform.
`POST` `/questionset/v2/publish/{questionSet_id}`
• /questionset/v2/publish/{questionSet\_id} endpoint executes the "Publish QuestionSet" request based on parameters provided as metadata in the request body. \
• It points to inquiry-api-service (assessment service) - /questionset/v5/publish/{questionSet\_id}\
• It is mandatory to provide values for parameters marked with \*\
• Mandatory fields cannot be null or empty.\
• Asynchronous flink job : async-questionset-publish will takes care of the publishing activity.
#### Path Parameters
| Name | Type | Description |
| --------------- | ------ | ------------------------------------------------- |
| questionSet\_id | String | Append a valid Question Set Id To the Request URL |
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Content-Type\* | String | The Content-Type entity is the media type of the resource. Possible media types can be: Application/json |
| Authorization\* | String | All content APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API.
Set Bearer {{api\_key}}
|
| x-channel-id | String | Unique identification number associated with a root organization. |
#### Request Body
| Name | Type | Description |
| ------- | ------ | --------------------------------------------------------------------------------- |
| request | Object | The body is the representation of the resource object for publishing question set |
{% tabs %}
{% tab title="200: OK QuestionSet publish operation was successfully executed." %}
```javascript
{
"id": "api.questionset.publish",
"ver": "5.0",
"ts": "2023-06-29T07:51:03ZZ",
"params": {
"resmsgid": "62f7e310-39e1-4287-bc9f-f8e6ac5f5bd3",
"msgid": null,
"err": null,
"status": "successful",
"errmsg": null
},
"responseCode": "OK",
"result": {
"message": "QuestionSet is successfully sent for Publish",
"identifier": "do_113208323801554944120"
}
}
```
{% endtab %}
{% tab title="404: Not Found QuestionSet Send for publish operation failed !The possible reason for failure is that you may have provided wrong questionset id." %}
```javascript
{
"id": "api.questionset.publish",
"ver": "5.0",
"ts": "2023-06-29T07:51:03ZZ",
"params": {
"resmsgid": "6fc0bd55-e99e-4ae1-80e2-7275458258ab",
"msgid": null,
"err": "NOT_FOUND",
"status": "failed",
"errmsg": "Error! Node(s) doesn't Exists. | [Invalid Node Id.]: do_1132084061164175361221"
},
"responseCode": "RESOURCE_NOT_FOUND",
"result": {
"messages": null
}
}
```
{% endtab %}
{% tab title="500: Internal Server Error Looks like something went wrong! We track these errors automatically" %}
```javascript
{
"id": "api.questionset.publish",
"ver": "5.0",
"ts": "2023-06-29T07:51:03ZZ",
"params": {
"resmsgid": "f234a6f0-3ac4-11eb-b0a2-8d5c9f561887",
"msgid": null,
"status": "failed",
"err": null,
"errmsg": null
},
"responseCode": "SERVER_ERROR",
"result": {}
}
```
{% endtab %}
{% tab title="400: Bad Request Publish operation failed because of some error in QuestionSet data" %}
```json
{
"id": "api.questionset.publish",
"ver": "5.0",
"ts": "2023-06-29T11:36:09ZZ",
"params": {
"resmsgid": "93f72a36-e5ca-4154-86a3-de662a20ecf4",
"msgid": null,
"err": "ERR_OBJECT_VALIDATION",
"status": "failed",
"errmsg": "No children's found for identifier:do_2138284054041886721542"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
}
```
{% endtab %}
{% endtabs %}
#### Request Sample
```json
{
"request": {
"questionset": {
"lastPublishedBy": "ae94b68c-a535-4dce-8e7a-fb9662b0ad68"
}
}
}
```
#### Success result schema
| Attribute | Type | Description |
|---|
| identifier | String | Unique Question identifier |
| message | String | Publish success message |
#### cURL
```shell
curl --location -g --request POST '{{host}}/questionset/v2/publish/{{questionSet_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{api_key}}' \
--header 'X-Channel-Id: {{channel_id}}' \
--data-raw '{
"request": {
"questionset": {}
}
}'
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://inquiry.sunbird.org/learn/product-and-developer-guide/question-and-question-set-service/apis/v2/questionset-apis/publish-questionset.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.