OPopenintegrationhub
Domains

Retrieve a schema by URI.

Changed on

Provides details of a schema with a given URI.

get/domains/{domainId}/schemas/{uri}

Request

Path parameters

domainIdstring required

ID of the domain to retrieve schema of

uristring required

URI of the schema

Response

successful operation

Example response

{
  "data": {
    "value": {
      "$id": "address",
      "required": [
        "street_address",
        "city",
        "state"
      ],
      "properties": {
        "street_address": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "state": {
          "type": "string"
        }
      }
    }
  }
}

Changes

  • f3d6b449bc4fRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

  • 1746e9d51ff0Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • info

      the endpoint scheme security BearerAuth was removed from the API

    • info

      added subschema #2 to the response body allOf list for the response status