Returns the list of registered domains for the Entity.

GET 
/entities/{entity-id}/domains

Returns the list of registered domains for the Entity.

Request

Path Parameters

entity-id uuidrequired
Entity ID
Example: 45416a62-1eb5-456b-a25c-a70b3e1c323d

Responses

200

OK

application/json

Schema

Schema

domains

object[]

Array [

name DomainName (string)required

Possible values: non-empty and <= 2000 characters

status DomainStatus (string)required

Possible values: [ACTIVE, DISABLED]

]

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "domains": [
    {
      "name": "string",
      "status": "ACTIVE"
    }
  ],
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

400

Bad Request

application/json

Schema

Schema

domains

object[]

Array [

name DomainName (string)required

Possible values: non-empty and <= 2000 characters

status DomainStatus (string)required

Possible values: [ACTIVE, DISABLED]

]

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "domains": [
    {
      "name": "string",
      "status": "ACTIVE"
    }
  ],
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

domains

object[]

Array [

name DomainName (string)required

Possible values: non-empty and <= 2000 characters

status DomainStatus (string)required

Possible values: [ACTIVE, DISABLED]

]

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "domains": [
    {
      "name": "string",
      "status": "ACTIVE"
    }
  ],
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

403

Forbidden

application/json

Schema

Schema

domains

object[]

Array [

name DomainName (string)required

Possible values: non-empty and <= 2000 characters

status DomainStatus (string)required

Possible values: [ACTIVE, DISABLED]

]

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "domains": [
    {
      "name": "string",
      "status": "ACTIVE"
    }
  ],
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

404

Not Found

application/json

Schema

Schema

domains

object[]

Array [

name DomainName (string)required

Possible values: non-empty and <= 2000 characters

status DomainStatus (string)required

Possible values: [ACTIVE, DISABLED]

]

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "domains": [
    {
      "name": "string",
      "status": "ACTIVE"
    }
  ],
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

500

Internal Server Error

application/json

Schema

Schema

domains

object[]

Array [

name DomainName (string)required

Possible values: non-empty and <= 2000 characters

status DomainStatus (string)required

Possible values: [ACTIVE, DISABLED]

]

result

object

required

status BaseResultStatus (string)required

Status of the request: success | error

Possible values: [success, error]

errors

object

If an error occurred on the request side, an error code is returned in this parameter.

code stringrequired

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Internal Processing Error

Example (from schema)

{
  "domains": [
    {
      "name": "string",
      "status": "ACTIVE"
    }
  ],
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Internal Processing Error"
    }
  }
}

Loading...