List Asset Relationship Definitions

GET 
/rtm/api/v1/asset-relationship-definition

Returns a list of supported relationships between assets for all cloud types.

Request

Query Parameters

nextPageToken String

Page token from the response object of an earlier request to get next page asset relationship definitions.

Responses

200

Successful operation

application/json

Schema

Schema

nextPageToken string
value object[]
Array [
sourceApi objectrequired
Indicates the Source API
id int64required
API Id
name stringrequired
API name
displayName stringrequired
API readable name
targetApi objectrequired
Indicates the Target API
id int64required
API Id
name stringrequired
API name
displayName stringrequired
API readable name
relationshipType objectrequired
Indicates the Relationship Type
id int64required
Asset Relationship Type Id
name stringrequired
Asset Relationship Type name
displayName stringrequired
Asset Relationship Type readable name
inverseName string
Asset Relationship Type inverse name
inverseDisplayName string
Asset Relationship Type readable inverse name
]

Example (from schema)

{
  "nextPageToken": "string",
  "value": [
    {
      "sourceApi": {
        "id": 0,
        "name": "string",
        "displayName": "string"
      },
      "targetApi": {
        "id": 0,
        "name": "string",
        "displayName": "string"
      },
      "relationshipType": {
        "id": 0,
        "name": "string",
        "displayName": "string",
        "inverseName": "string",
        "inverseDisplayName": "string"
      }
    }
  ]
}

400

Internal Error

application/json

Schema

Schema

error object
code string
message string

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

401

Unauthorized - user cannot be authenticated to service the request

application/json

Schema

Schema

error object
code string
message string

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

404

Not Found

application/json

Schema

Schema

error object
code string
message string

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

425

Too early to access the resource

application/json

Schema

Schema

error object
code string
message string

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

429

Too many requests

application/json

Schema

Schema

error object
code string
message string

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Loading...