Define an API resource response structure

  • Release version: Zurich
  • Updated February 20, 2026
  • 1 minute to read

    • Add a schema and relevant response headers to a REST response to define the response's expected data structure.

    Before you begin

    At least one REST API resource and at least one schema must already be defined for use in the relevant REST API. You must also define any response headers you want to use. For more information, see Define a REST API response header.

    Role required: web_service_admin

    Procedure

    1. Navigate to a new REST Response record in one of the following ways.
      If you navigate through the scripted REST API record, most fields in the REST Response record are pre-populated.
      OptionProcedure
      Navigate through a scripted REST API record
      1. Navigate to All > System Web Services > Scripted REST Services > Scripted REST APIs.
      2. Select a scripted REST API record.
      3. In the Resources related list, select a resource.
      4. In the Response Schema tab, select New.
      Navigate directly to the REST Response record
      1. Navigate to All > Filter and enter sys_ws_response_spec.form.
      2. In the API field, select an API.
      3. In the API resource field, select the API resource whose response format you want to specify.
      4. In the Http method field, select the method whose response format you want to specify (for example, GET).
      5. Version field, select the API resource version.
    2. In the Http status field, enter the HTTP status that the REST response specifications apply to (for example, 200).
      For example, return ABC status by entering 200.
    3. In the Schema field, find or enter the schema that defines the structure and format for the resource's selected HTTP status, version, and method.
    4. Optional: Add relevant response headers associated with the API.
      1. Select the Unlock Response Headers icon .
      2. Find or enter relevant response headers associated with the API.
    5. In the Description field, summarize the expected format of the REST response.
    6. Select Submit.

    Result

    The schema you used to define the response body structure is included in the exportable OpenAPI specification in the REST API Explorer. For more information about exporting OpenAPI specifications, see Export to OpenAPI specification.