> 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/v1/questionset-apis/copy-questionset.md).
# Copy QuestionSet
## This API is associated with copying questionset on the Sunbird Platform.
`POST` `/questionset/v1/copy/{QuestionSet_Id}`
• The endpoint for **Copy QuestionSet** is /questionset/v1/copy\
• It points to inquiry-api-service (assessment service) - /questionset/v4/copy \
• You need to provide a valid Question Set Id value in {QuestionSet\_Id} field of the API URL.\
• All parameters marked with \* are mandatory. You must provide values for these parameters. \
• Mandatory fields cannot be null or empty.
#### Path Parameters
| Name | Type | Description |
| ------------------------------------------------- | ------ | ------------------------------------------------ |
| QuestionSet\_Id\* | String | Append a valid QuestionSet Id to the Request URL |
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Content-Type\* | String | The Content-Type entity is the media type of the resource. The possible media types can be: Application/json |
| Authorization\* | String | You require authorization to make use of the API. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
Set Bearer {{api\_key}}
|
| x-channel-id | String | Unique identification number associated with a root organisation. |
#### Request Body
| Name | Type | Description |
| ----------------------------------------- | ------ | ---------------------------------------------------------------------------------- |
| request\* | Object | The body is the representation of the resource object for importing a question set |
{% tabs %}
{% tab title="200: OK The Copy QuestionSet operation was successful!" %}
```javascript
{
"id": "api.questionset.copy",
"ver": "3.0",
"ts": "2023-06-23T06:41:31ZZ",
"params": {
"resmsgid": "8bba3dda-f81e-4659-8c05-55caed20d174",
"msgid": null,
"err": null,
"status": "successful",
"errmsg": null
},
"responseCode": "OK",
"result": {
"node_id": {
"do_2138240203066900481600": "do_2138240204082216961601"
},
"versionKey": "1687502491400"
}
}
```
{% endtab %}
{% tab title="400: Bad Request The Copy QuestionSet operation failed. You may have missed providing input for a mandatory parameter.'" %}
```javascript
{
"id": "api.questionset.copy",
"ver": "3.0",
"ts": "2023-06-23T06:44:12ZZ",
"params": {
"resmsgid": "2ea62aa3-f2a9-4aeb-86f0-9d648591d1f2",
"msgid": null,
"err": "ERR_BAD_REQUEST",
"status": "failed",
"errmsg": "Hierarchy data is empty"
},
"responseCode": "CLIENT_ERROR",
"result": {
"messages": null
}
}
```
{% endtab %}
{% tab title="500: Internal Server Error We track these errors automatically and try to set it right at the earliest." %}
```javascript
{
"id": "api.questionset.copy",
"ver": "3.0",
"ts": "2020-12-10T08:51:51.647Z",
"params": {
"resmsgid": "f234a6f0-3ac4-11eb-b0a2-8d5c9f561887",
"msgid": null,
"status": "failed",
"err": null,
"errmsg": null
},
"responseCode": "SERVER_ERROR",
"result": {}
}
```
{% endtab %}
{% tab title="404: Not Found The Copy QuestionSet operation failed. You may have requested a resource that is not existing in the server.'" %}
{% endtab %}
{% endtabs %}
#### Sample Request
```json
{
"request": {
"questionset": {
"createdBy": "User001",
"createdFor": [
"Sunbird"
],
"name": "Sunbird-QS"
}
}
}
```
#### Request schema
| Attribute | Description | Type |
|---|
| createdBy | Represents the the user who triggered the copy operation | string |
| createdFor | Represents the organization on behalf the request was triggered | Object |
| name | Represents the collection with which Questionset can be copied. | string |
#### Success result schema
| Attribute | Type | Description |
| --------- | --------------- | ------------------------- |
| node\_id | Array of Object | Node Ids that were copied |
**cURL**
```
curl --location -g --request POST '{{host}}/questionset/v1/copy/{QuestionSet_Id}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{api_key}}' \
--header 'X-Channel-Id: {{channel_id}}' \
--data-raw '{
"request": {
"questionset": {
"createdBy": "User001",
"createdFor": [
"Sunbird"
],
"name": "Sunbird-QS"
}
}
}'
```
---
# 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/v1/questionset-apis/copy-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.