v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB

Schema Responses

Create a new Schema Response

This endpoint creates a new Schema Response with an in_progress state. A new response can only be created if the current schema response is in an approved state.

Returns

Returns a JSON object with a data key containing an updated representation of the requested Schema Response, if the request is successful.

Errors

If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the list of error codes to understand why this request may have failed.

post/schema_responses/

Request body

idstring

The unique identifier of the Schema Response.

typestring required

The type identifier of the Schema Response (schema-response).

Example request

{
  "data": {
    "type": "schema-responses",
    "attributes": {
      "revision_justification": "I made a mistake.",
      "revision_responses": {
        "Q1": "updated response"
      }
    }
  }
}