Create collection from schema

This call creates a collection and links it to an API as one or multiple relations.

Request body requires two keys:

name - Name of the collection to be created.

relations - A list of relation(s) to be created.

The allowed relation types are contracttest, integrationtest, testsuite, and documentation.

Requires API Key as X-Api-Key request header or apikey URL query parameter.

curl --location --request POST 'https://api.getpostman.com/apis//versions//schemas//collections' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "My generated collection", "relations": [ { "type": "contracttest" } ] }'

{ "collection": { "id": "e6b0d46a-8722-4f42-ab86-f5f473187ddf", "uid": "112098-e6b0d46a-8722-4f42-ab86-f5f473187ddf" }, "relations": [ { "id": "4b40f06a-5a6a-448f-bfcd-a6dbcb68da22", "type": "contracttest" } ] }

Request

Path Params

apiId

string

required

apiVersionId

string

required

schemaId

string

required

Query Params

workspace

string

optional

Body Params application/json

name

string

optional

Example:

My generated collection

relations

array [object {1}]

optional

type

string

optional

Example:

contracttest

Examples

Responses

🟢200Create collection from schema

application/json

Body

collection

object

optional

string

optional

Example:

e6b0d46a-8722-4f42-ab86-f5f473187ddf

uid

string

optional

Example:

112098-e6b0d46a-8722-4f42-ab86-f5f473187ddf

relations

array [object {2}]

optional

string

optional

Example:

4b40f06a-5a6a-448f-bfcd-a6dbcb68da22

type

string

optional

Example:

contracttest