POST /apis/{apiId}/versions/{apiVersionId}/schemas/{schemaId}/collections
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-Keyrequest header orapikeyURL query parameter.
Servers
- https://api.getpostman.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
apiId |
String | Yes | |
schemaId |
String | Yes | |
apiVersionId |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspace |
String | No |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | No | |
relations[] |
Array | No | |
relations[].type |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.