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-Keyrequest header orapikeyURL query parameter.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
workspace | string |
Request Body
{"name"=>"My generated collection", "relations"=>[{"type"=>"contracttest"}]}
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"}]}