Entities utility requests

Utility requests provide metadata that you can use to make related requests, assemble inputDTOs, or see the potential values of a particular DTO.

Getting a list of entry points for entities

The entities endpoint contains a utility request that shows the entry points you can use to get lists of entities. These can be used to find the UUID and details relating to specific entities.

Example: GET https://10.10.10.10/api/v3/entities

Response: An array of Link objects, where each object contains a URL to get all entities for a specified market or group.


{
  "links":[
    {
      "rel":"Market actions",
      "href":"https://10.10.10.10/api/v3/markets/{uuid}/entities"
    },
    {
      "rel":"Group actions",
      "href":"https://10.10.10.10/api/v3/groups/{uuid}/entities"
    }
  ]
}

Getting a list of entry points for a single entity

If you pass an entity UUID to the entities endpoint, then you get a description of the entity, plus a list of entry points for entity data such as stats, constraints, actions, etc.

Example: GET https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073

Response: An array of Link objects, where each object contains a URL to get information about the entity.


{
  "links": [
    {
     "rel": "self",
     "href": "https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073?include_aspects=false"
    },
    {
     "rel": "To Stats",
     "href": "https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073/stats"
    },
    {
     "rel": "Entity notifications",
     "href": "https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073/notifications"
    },
    {
      "rel": "Entity actions",
      "href": "https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073/actions?ascending=false"
    },
    {
      "rel": "To Constraints",
      "href": "https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073/policies"
    },
    {
      "rel": "To Settings",
      "href": "https://10.10.10.10/api/v3/entities/420b1eeb-6190-a9d2-6436-4327ad3ac073/settings?include_settingspolicies=false"
    },
    {
     "rel": "To Entity List",
     "href": "https://10.10.10.10/api/v3/entities"
    }
  ],
  ...
}