Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Resource Relations

Get Resource Relation

Get a resource relation

get/v2/schema/{proj_id}/{env_id}/resources/{resource_id}/relations/{relation_id}

Path parameters

resource_idstring required

Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the "slug").

Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the "slug").

relation_idstring required

Either the unique id of the relation, or the URL-friendly key of the relation (i.e: the "slug").

Either the unique id of the relation, or the URL-friendly key of the relation (i.e: the "slug").

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

env_idstring required

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Response

Successful Response

descriptionstring

An optional longer description of what this relation represents in your system

subject_resourcestring required

The subject resource ID or key

keystring required

A URL-friendly name of the relation (i.e: slug). You will be able to query later using this key instead of the id (UUID) of the relation.

namestring required

The name of the relation

idstring uuid required

Unique id of the relation

organization_idstring uuid required

Unique id of the organization that the relation belongs to.

project_idstring uuid required

Unique id of the project that the relation belongs to.

environment_idstring uuid required

Unique id of the environment that the relation belongs to.

created_atstring date-time required

Date and time when the relation was created (ISO_8601 format).

updated_atstring date-time required

Date and time when the relation was last updated/modified (ISO_8601 format).

object_resource_idstring uuid required

The object resource id

object_resourcestring required

The object resource key

subject_resource_idstring uuid required

The subject resource id

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "key": "parent",
  "name": "parent",
  "description": "parent relation",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
  "object_resource_id": "40ef0e48-a11f-4963-a229-e396c9f7e7dd",
  "object_resource": "repo",
  "subject_resource_id": "40ef0e48-a11f-4963-a229-e396c9f7e7dd",
  "subject_resource": "organization",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}