Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The /entity resource provides access to entities that have been configured on Weave. An entity is a grouping of items that are searchable and reportable in Weave.


Info
titleRelated reading

Entity configuration


Top level resource: services/v1/entity


Sub resources

1. /entity/list

Provides a listing of all entities configured and accessible to the user.


Example 1 - Get a list of entities

Code Block
languagebash
themeEmacs
curl -X GET --header 'Accept: application/json' 'http://localhost:8080/weave/services/v1/entity/list'


Result:

Code Block
languagejs
collapsetrue
{
  "count": 4,
  "entities": [
    {
      "size": 0,
      "active": true,
      "id": "state_significant_dev_sites",
      "label": "State Significant Dev Sites",
      "published": true,
      "spatial": true
    },
    {
      "size": 0,
      "active": false,
      "id": "landscaped_area",
      "label": "Landscaped Area",
      "published": true,
      "spatial": false
    },
    {
      "size": 0,
      "active": false,
      "id": "environmental_cons_area",
      "label": "Environmental Cons Area",
      "published": true,
      "spatial": true
    },
    {
      "size": 0,
      "active": false,
      "id": "new_local_government_area",
      "label": "Proclamation of Councils",
      "published": true,
      "spatial": false
    }]
}