POST /apis/{apiId}/versions/{apiVersionId}/relations
This call allows you to add existing Postman entities as new relations to an API. The request body should contain the relations to be created along with an array of entity IDs.
| Relation | Entity ID type |
|---|
|
| contracttest | Collection UIDs |
| integrationtest | Collection UIDs |
| documentation | Collection UIDs |
| testsuite | Collection UIDs |
| environment | Environment UIDs |
| mock | Mock IDs |
| monitor | Monitor IDs |
Requires API Key as X-Api-Key request header or apikey URL query parameter.
Servers
- https://api.getpostman.com
Path parameters
| Name |
Type |
Required |
Description |
apiId |
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"
|
Request body fields
| Name |
Type |
Required |
Description |
contracttest[] |
Array |
No |
|
documentation[] |
Array |
No |
|
testsuite[] |
Array |
No |
|
mock[] |
Array |
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.
