API-Schema

Number of APIs: 4

1. Get a schema

GET https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/schemas/{{schemaId}}

This endpoint is deprecated in Qodex v10 and higher.

Gets information about an API's definition.

---

2. Create a schema

POST https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/schemas

This endpoint is deprecated in Qodex v10 and higher.

Creates an API definition. The request body must contain a schema object with the following properties:

• type — A string value that contains the API definition's type. One of:
  • openapi3_1
  • openapi3
  • openapi2
  • openapi1
  • raml
  • raml1
  • wsdl1
  • wsdl2
  • graphql
  • proto2
  • graphql
  • proto3
• language — A string value that contains the API definition's language. One of:
  • OpenAPI and RAML — json or yaml
  • GraphQL — graphql
  • WSDL — xml
  • Protobuf — proto
• schema — A string value that contains the API definition's contents.

---

3. Create a collection from a schema

POST https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/schemas/{{schemaId}}/collections

This endpoint is deprecated in Qodex v10 and higher.

Creates a collection and links it to an API as one or multiple relations.

Include the following properties in the request body:

• name — A string that contains the name of the collection.

You can also include the following additional properties in the request body:

• relations — An array that contains a list of relations to create:
  • contracttest — Deprecated.
  • integrationtest — Deprecated.
  • testsuite — Deprecated.
  • documentation
• options — An object that contains advanced creation options and their values. You can find a complete list of properties and their values in Qodex's OpenAPI 3.0 to Qodex Collection v2.1.0 Converter OPTIONS documentation. These properties are case-sensitive.

---

4. Update a schema

PUT https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/schemas/{{schemaId}}

This endpoint is deprecated in Qodex v10 and higher.

Updates an API definition. The request body must contain a schema object with the following properties:

• type — A string value that contains the API definition's type. One of:
  • openapi3_1
  • openapi3
  • openapi2
  • openapi1
  • raml
  • raml1
  • wsdl1
  • wsdl2
  • graphql
  • proto2
  • graphql
  • proto3
• language — A string value that contains the API definition's language. One of:
  • OpenAPI and RAML — json or yaml
  • GraphQL — graphql
  • WSDL — xml
  • Protobuf — proto
• schema — Optional. A string value that contains the API definition's contents.

---