Skip to main content
GET
/
api
/
clients
/
sample_entities
Retrieves the report representation of sample entities filtered by the provided criteria.
curl --request GET \
  --url https://api.example.com/api/clients/sample_entities
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

Query Parameters

​
Id
integer<int64> | null

Optional identifier restricting the report to a single sample entity.

Example:

42

​
api-version
string | null

Response

200 - application/json

Returned when the report data is retrieved successfully.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object[] | null

The result value returned when the operation is successful.