Get linked relations

GET

/apis/{apiId}/versions/{apiVersionId}/relations

APIRelations

This call fetches all the relations which are linked to the specified API version along with their details.

The response will contain a relations object which lists all the relation types which are linked to the API version. Each of the relation type will be an object which details the relations of this type.

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.getpostman.com/apis//versions//relations'

Response Example

{
  "relations": {
    "contracttest": {
      "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2": {
        "id": "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2",
        "name": "C test",
        "updatedAt": "2019-08-29T10:18:11.000Z"
      }
    },
    "integrationtest": {
      "521b0486-ab91-4d3a-9189-43c9380a0533": {
        "id": "521b0486-ab91-4d3a-9189-43c9380a0533",
        "name": "C1",
        "updatedAt": "2019-08-29T11:40:39.000Z"
      },
      "a236b715-e682-460b-97b6-c1db24f7612e": {
        "id": "a236b715-e682-460b-97b6-c1db24f7612e",
        "name": "C test",
        "updatedAt": "2019-08-29T10:18:11.000Z"
      }
    },
    "mock": {
      "4ccd755f-2c80-481b-a262-49b55e12f5e1": {
        "id": "4ccd755f-2c80-481b-a262-49b55e12f5e1",
        "name": "Mock",
        "updatedAt": "2019-08-20T10:18:13.000Z",
        "url": "https://4ccd755f-2c80-481b-a262-49b55e12f5e1.mock-beta.pstmn.io"
      }
    }
  }
}

Request

Path Params

apiId

string

required

apiVersionId

string

required

Responses

🟢200Get linked relations for an API version

application/json

Body

relations

object

optional

contracttest

object

optional

integrationtest

object

optional

mock

object

optional

Get monitor relations

Create relations