Return selectable relationship paths for one root record type.

GET

/api/workspace/admin/entitlement-operations/setup/relationship-paths

curl --request GET \
  --url https://example.com/api/workspace/admin/entitlement-operations/setup/relationship-paths

Authorizations

• None

Parameters

Query Parameters

rootEntityDefinitionId

string

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

200

OK

Media typeapplication/json

object

Data

Relationship path options returned for a selected root EntityDefinition.

object

RootEntityDefinitionId

string

nullable

Paths

Array<object>

nullable

Relationship path option that can be selected by an entitlement model.

object

Key

string

nullable

DisplayName

string

nullable

RootEntityDefinitionId

string

nullable

RootEntityDisplayName

string

nullable

LeafEntityDefinitionId

string

nullable

LeafEntityDisplayName

string

nullable

Depth

integer format: int32

Steps

Array<object>

nullable

One resolved step inside a relationship path option.

object

SortOrder

integer format: int32

FromEntityDefinitionId

string

nullable

FromEntityDisplayName

string

nullable

ToEntityDefinitionId

string

nullable

ToEntityDisplayName

string

nullable

FieldId

string

nullable

FieldDisplayName

string

nullable

Direction

integer format: int32

Allowed values: 0 1

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Paths": [
      {
        "Steps": [
          {
            "Direction": 0
          }
        ]
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

Media typeapplication/json

object

Data

Relationship path options returned for a selected root EntityDefinition.

object

RootEntityDefinitionId

string

nullable

Paths

Array<object>

nullable

Relationship path option that can be selected by an entitlement model.

object

Key

string

nullable

DisplayName

string

nullable

RootEntityDefinitionId

string

nullable

RootEntityDisplayName

string

nullable

LeafEntityDefinitionId

string

nullable

LeafEntityDisplayName

string

nullable

Depth

integer format: int32

Steps

Array<object>

nullable

One resolved step inside a relationship path option.

object

SortOrder

integer format: int32

FromEntityDefinitionId

string

nullable

FromEntityDisplayName

string

nullable

ToEntityDefinitionId

string

nullable

ToEntityDisplayName

string

nullable

FieldId

string

nullable

FieldDisplayName

string

nullable

Direction

integer format: int32

Allowed values: 0 1

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Paths": [
      {
        "Steps": [
          {
            "Direction": 0
          }
        ]
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

Media typeapplication/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}