Entity States API

These endpoints retrieve a list of states for entities based on their IDs.

Note: These endpoints require authentication which has been deliberately excluded from the example(s) below.

Get Entity States

GET /states

Retrieves states for entities. Each ID in the response maps to a list of states or null.

Request Parameters

• id (array of string, required): The IDs of the entities.
• is-base64 (boolean, optional, default: false): If true, the IDs will be Base64 decoded.
• sort (string, optional): Custom sorting for states (e.g., <start,<end). Default is by score.
• range-start (string, optional): Start of a range filter for states.
• range-end (string, optional): End of a range filter for states.
• range-fields (string, optional): Fields for range filtering states.
• show-security-labels (boolean, optional, default: false): If true, security labels will be returned.
• indices (string, optional): Specific indices to apply the operation on.

Example Call

curl -X GET  https://telicent.core.domain/api/search/states?id=entity1&id=entity2&sort=score

Response

• 200 OK: The state selection. Contains a StatesSelection object (map of ID to SearchResults object).
• 400 Bad Request: Insufficient information (e.g., IDs omitted).
• 500 Internal Server Error: Server failed to process the request.
• 503 Service Unavailable: No underlying search index available.

---

Get Entity States (POST)

POST /states

Identical functionality to GET /states, but allows parameters to be submitted via an application/x-www-form-urlencoded POST request.

Request Body (application/x-www-form-urlencoded)

• id (array of string, required): The IDs of the entities.
• is-base64 (boolean, optional): Set to true if IDs are Base64 encoded.
• sort (string, optional): Defines the sorting order of states.
• range-start (string, optional): Start of the range for filtering states.
• range-end (string, optional): End of the range for filtering states.
• range-fields (array of string, optional): Fields to consider when applying the range filter.
• show-security-labels (boolean, optional): Set to true to include security labels.
• indices (string, optional): Specific indices to apply the operation to.

Example Call

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \
    -d "id=entA&id=entB&sort=start" \
    https://telicent.core.domain/api/search/states

Responses

Same as GET /states.