Get Request Schema

GET /request-schemas/{schemaid}

Bearer auth

Retrieve request schema content

Path parameters

schemaid string Required

Unique identifier of the request schema

Minimum length is 24, maximum length is 24. Format should match the following pattern: SC[A-Za-z0-9_\-]+.

Responses

200 application/octet-stream

Get Schema File Content
Hide headers attribute Show headers attribute
- Last-Modified string(date-time)
  
  format to use when generating times in headers. Time as in RFC1123 but hard-codes GMT as the time zone
  
  Minimum length is 15, maximum length is 30.
https://json-schema.org/draft/2020-12/json-schema-core.html

Minimum length is 2, maximum length is 355000.
400 application/json

Bad request
Hide response attributes Show response attributes object
- code string(string) Required
  
  Error code
  
  Minimum length is 1, maximum length is 64.
- message string(string) Required
  
  Human-readable error message
  
  Minimum length is 1, maximum length is 1024.
401 application/json

Unauthorized request
Hide response attributes Show response attributes object
- code string(string) Required
  
  Error code
  
  Minimum length is 1, maximum length is 64.
- message string(string) Required
  
  Human-readable error message
  
  Minimum length is 1, maximum length is 1024.
404 application/json

Resource not found
Hide response attributes Show response attributes object
- code string(string) Required
  
  Error code
  
  Minimum length is 1, maximum length is 64.
- message string(string) Required
  
  Human-readable error message
  
  Minimum length is 1, maximum length is 1024.
429 application/json

Too many requests
Hide response attributes Show response attributes object
- code string(string) Required
  
  Error code
  
  Minimum length is 1, maximum length is 64.
- message string(string) Required
  
  Human-readable error message
  
  Minimum length is 1, maximum length is 1024.
500 application/json

Internal server error
Hide response attributes Show response attributes object
- code string(string) Required
  
  Error code
  
  Minimum length is 1, maximum length is 64.
- message string(string) Required
  
  Human-readable error message
  
  Minimum length is 1, maximum length is 1024.

GET /request-schemas/{schemaid}

curl \
 --request GET '/api/v1/request-schemas/SCx3zt0ygAcQGBAQEBAQEBAQ' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (400)

{
  "code": "string",
  "message": "string"
}

Response examples (401)

{
  "code": "string",
  "message": "string"
}

Response examples (404)

{
  "code": "string",
  "message": "string"
}

Response examples (429)

{
  "code": "string",
  "message": "string"
}

Response examples (500)

{
  "code": "string",
  "message": "string"
}