Publish QuestionSet
This API is used to publish the question set on the Sunbird-inQuiry Platform.
This API is used to publish the question set on the Sunbird-inQuiry Platform.
POST
/questionset/v1/publish/QuestionSet_Id
• /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/v4/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
QuestionSet_Id
String
Append a valid Question Set Id To the Request URL
Headers
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
request
Object
The body is the representation of the resource object for publishing question set
{
"id": "api.questionset.publish",
"ver": "3.0",
"ts": "2021-02-03T09:39:14ZZ",
"params": {
"resmsgid": "62f7e310-39e1-4287-bc9f-f8e6ac5f5bd3",
"msgid": null,
"err": null,
"status": "successful",
"errmsg": null
},
"responseCode": "OK",
"result": {
"message": "Question is successfully sent for Publish",
"identifier": "do_113208323801554944120"
}
}
Request Sample
{
"request": {
"questionset": {
"lastPublishedBy": "ae94b68c-a535-4dce-8e7a-fb9662b0ad68"
}
}
}
Success result schema
identidier
String
Unique Question identifier
message
String
Publish success message
cURL
curl --location -g --request POST '{{host}}/questionset/v1/publish/{{questionSet_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{api_key}}' \
--header 'X-Channel-Id: {{channel_id}}' \
--data-raw '{
"request": {
"questionset": {}
}
}'
Last updated
Was this helpful?