v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB

Schema Responses

Update a Registration's Schema Response

Patching to this endpoint allows one to directly edit the revision responses on the Schema Response of a Registration if that Schema Response is in an in_progress 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.

patch/schema_responses/{schema_response_id}

Path parameters

schema_response_idstring required

The unique identifier of the Registration Schema example 6176c9d45e01f100091d4f94.

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"
      }
    }
  }
}