30 Days of Postman exercises API Documentation
Create collection from schema
POST https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/schemas/{{schemaId}}/collections?workspace=c90a3482-f80d-43d6-9dfb-0830f5e43605
This call creates a collection and links it to an API as one or multiple relations. Request body requires two keys:
- The allowed relation types are Requires API Key as name - Name of the collection to be created.
- relations - A list of relation(s) to be created.contracttest, integrationtest, testsuite, and documentation.
X-Api-Key request header or apikey URL query parameter.
Body
PARAM
| Key | Datatype | Required | Description |
workspace
|
string |
HEADERS
| Key | Datatype | Required | Description |
Content-Type
|
string |
RESPONSES
status OK
| {
"collection": {
"id": "e6b0d46a-8722-4f42-ab86-f5f473187ddf",
"uid": "112098-e6b0d46a-8722-4f42-ab86-f5f473187ddf"
},
"relations": [
{
"type": "contracttest",
"id": "4b40f06a-5a6a-448f-bfcd-a6dbcb68da22"
}
]
} |
Curl
curl -X POST 'https://api.getpostman.com/apis/undefined/versions/undefined/schemas/undefined/collections?workspace=c90a3482-f80d-43d6-9dfb-0830f5e43605?workspace=c90a3482-f80d-43d6-9dfb-0830f5e43605' -H 'Content-Type: application/json' -d '{"name":"My generated collection","relations":[{"type":"contracttest"}]}'
ENDPOINTS