Add a collection

POST {{baseUrl}}/apis/{{apiId}}/collections

Adds a collection to an API. To do this, use the following operationType values:

• COPY_COLLECTION — Copies a collection from the workspace and adds it to an API.
• CREATE_NEW — Creates a new collection by providing the new collection's content.

• GENERATE_FROM_SCHEMA — Generates the collection from an API schema.

  • 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.

For examples of each method, see the collection's response examples.

Request Body

{"operationType"=>"{{operationType}}"}

HEADERS

RESPONSES

status: Created

{"id":"12ece9e1-2abf-4edc-8e34-de66e74114d2"}