Entity Abilities

All Entity Abilities

You can get a list of all the entity-abilities of an entity by using the following endpoint.

{warning} Don't forget that all endpoints documented here need to be prefixed with 1.0/campaigns/{campaign.id}/.

Method URI Headers
GET/HEAD entities/{entity.id}/entity_abilities Default

Results

{
    "data": [
        {
            "ability_id": 33,
            "created_at": "2019-01-28 19:42:33.000000Z",
            "created_by": 1,
            "entity_id": 70,
            "id": 31,
            "visibility_id": 1,
            "updated_at": "2019-01-28 19:42:33.000000Z",
            "updated_by": 1,
            "charges": 3,
            "position": 0,
            "note": null
        }
    ]
}

Entity Ability

To get the details of a single entity-ability, use the following endpoint.

Method URI Headers
GET/HEAD entities/{entity.id}/entity_abilities/{entity_ability.id} Default

Results

{
    "data": {
        "ability_id": 33,
        "created_at": "2019-01-28 19:42:33.000000Z",
        "created_by": 1,
        "entity_id": 70,
        "id": 31,
        "visibility_id": 1,
        "updated_at": "2019-01-28 19:42:33.000000Z",
        "updated_by": 1,
        "charges": 3,
        "position": 0,
        "note": null
    }
}

Create an Entity Ability

To create an entity-ability, use the following endpoint.

Method URI Headers
POST entities/{entity.id}/entity_abilities Default

Body

Parameter Type Detail
ability_id int (Required) The ability id
visibility_id int The visibility ID: 1 for all, 2 self, 3 admin, 4 self-admin or 5 members.
charges int How many times the ability was used.
note string Custom note attached to the ability.
position int Position of the ability in the list

Results

{success} Code 200 with JSON body of the new entity-ability.

Update an Entity Ability

To update an entity-ability, use the following endpoint.

Method URI Headers
PUT/PATCH entities/{entity.id}/entity_abilities/{entity_ability.id} Default

Body

The same body parameters are available as for when creating an entity-ability.

Results

{success} Code 200 with JSON body of the updated entity-ability.

Delete an Entity Ability

To delete an entity-ability, use the following endpoint.

Method URI Headers
DELETE entities/{entity.id}/entity_abilities/{entity_ability.id} Default

Results

{success} Code 200 with JSON.