GET /api/v2/entity-management-profiles
List the entity's management profiles


GET /api/v2/entity-management-profiles/:id
Show an entity management profile

Params

Param name Description
id
required

Entity management profile ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


POST /api/v2/entity-management-profiles
Create a management profile

Params

Param name Description
data
required

Entity management profile Information

Validations:

  • Must be a Hash

data[type]
required

Validations:

data[attributes]
required

Validations:

  • Must be a Hash

data[attributes][title]
required

The title of the profile

Validations:

  • Must be a String

data[attributes][name]
required

The name of the profile

Validations:

  • Must be a String

data[relationships]
required

Validations:

  • Must be a Hash

data[relationships][entity]
required

Validations:

  • Must be a Hash

data[relationships][entity][data]
required

Validations:

  • Must be a Hash

data[relationships][entity][data][type]
required

`entities`

Validations:

  • Must be a String

data[relationships][entity][data][id]
required

Entity ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


PATCH /api/v2/entity-management-profiles/:id
Update a management profile

Params

Param name Description
id
required

management profile ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data
required

Entity management profile Information

Validations:

  • Must be a Hash

data[type]
optional

Validations:

data[attributes]
optional

Validations:

  • Must be a Hash

data[attributes][title]
optional

The title of the profile

Validations:

  • Must be a String

data[attributes][name]
optional

The name of the profile

Validations:

  • Must be a String

data[relationships]
optional

Validations:

  • Must be a Hash

data[relationships][entity]
optional

Validations:

  • Must be a Hash

data[relationships][entity][data]
optional

Validations:

  • Must be a Hash

data[relationships][entity][data][type]
optional

`entities`

Validations:

  • Must be a String

data[relationships][entity][data][id]
optional

Entity ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


DELETE /apiv2/entity-management-profiles/:id
Delete a management profile

Params

Param name Description
id
required

management profile ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.