EQTY LabDocs

Get evaluation result

Retrieve a single evaluation result by its UUID

gethttps://localhost:10001/api/v2/evaluations/{id}
bash
curl --request GET \
  --url 'https://localhost:10001/api/v2/evaluations/{id}' \
  --header 'Authorization: Bearer <token>'
javascript
const response = await fetch("https://localhost:10001/api/v2/evaluations/{id}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

const data = await response.json();
typescript
interface EvaluationResultResponse {
  applicationId?: number;
  createdAt?: string;
  criterionResults?: Record<string, unknown>[];
  declarationIds?: number[];
  durationMs?: number;
  evaluatedAt?: string;
  extractedFields?: Record<string, unknown>;
  failureDetails?: Record<string, unknown>[];
  failureReasons?: string[];
  id?: string;
  indicatorId?: string;
  result?: "pass" | "fail" | "error" | "awaiting_evaluation";
  triggerSource?: string;
}

const response = await fetch("https://localhost:10001/api/v2/evaluations/{id}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

const data: EvaluationResultResponse = await response.json();
python
import requests

response = requests.get(
    "https://localhost:10001/api/v2/evaluations/{id}",
    headers={
        "Authorization": "Bearer <token>",
    },
)
response.raise_for_status()
print(response.json())
go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://localhost:10001/api/v2/evaluations/{id}", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <token>")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(res.Status, string(data))
}
java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://localhost:10001/api/v2/evaluations/{id}"))
            .header("Authorization", "Bearer <token>")
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
csharp
using System.Net.Http.Headers;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:10001/api/v2/evaluations/{id}");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
php
<?php

$ch = curl_init('https://localhost:10001/api/v2/evaluations/{id}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
    ],
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;
ruby
require "net/http"

uri = URI("https://localhost:10001/api/v2/evaluations/{id}")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts "#{response.code} #{response.body}"
rust
// Cargo.toml dependencies: reqwest, tokio (features "full")

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let response = reqwest::Client::new()
        .get("https://localhost:10001/api/v2/evaluations/{id}")
        .header("Authorization", "Bearer <token>")
        .send()
        .await?;

    println!("{} {}", response.status(), response.text().await?);
    Ok(())
}

Authorizations

  • BearerAuth · API key in header "Authorization" — Type "Bearer" followed by a space and JWT token.

Parameters

Path parameters

NameTypeDescription
id
required
string

Evaluation result UUID (urn:uuid optional)

Responses

200Evaluation result

application/json
  • applicationIdinteger
  • createdAtstring<date-time>
  • criterionResultscore.CriterionResult[]
    Show properties

    Array of core.CriterionResult

    • criteriaIndexinteger
    • fieldstring
    • reasonstring
    • statuscore.CriterionResultStatus

      One ofpassfailskipped

  • declarationIdsinteger[]
  • durationMsinteger

    Evaluation wall time in milliseconds

  • evaluatedAtstring<date-time>
  • extractedFieldsobject
  • failureDetailscore.EvaluationFailureDetail[]
    Show properties

    Array of core.EvaluationFailureDetail

    • actualValueany
    • arrayMatchModecore.ArrayMatchMode

      One ofallany

    • criteriaIndexinteger
    • criteriaTypecore.CriteriaType

      One ofstringnumberbooleandatelist[string]list[number]

    • elementPathstring
    • expectedValueany
    • extractionPathstring
    • fieldstring
    • indexPathinteger[]
    • missingboolean
    • operatorcore.OperatorType

      One ofeqneqgtltgtelteinnotIncontainsnotContains

    • reasonstring
  • failureReasonsstring[]
  • idstring

    urn:uuid form

  • indicatorIdstring

    urn:uuid form

  • resultcore.EvaluationResultStatus

    One ofpassfailerrorawaiting_evaluation

  • triggerSourcestring
Examplejson
{
  "applicationId": 0,
  "createdAt": "2025-01-01T00:00:00Z",
  "criterionResults": [
    {
      "criteriaIndex": 0,
      "field": "string",
      "reason": "string",
      "status": "pass"
    }
  ],
  "declarationIds": [
    0
  ],
  "durationMs": 0,
  "evaluatedAt": "2025-01-01T00:00:00Z",
  "extractedFields": {},
  "failureDetails": [
    {
      "actualValue": null,
      "arrayMatchMode": "all",
      "criteriaIndex": 0,
      "criteriaType": "string",
      "elementPath": "string",
      "expectedValue": null,
      "extractionPath": "string",
      "field": "string",
      "indexPath": [
        0
      ],
      "missing": true,
      "operator": "eq",
      "reason": "string"
    }
  ],
  "failureReasons": [
    "string"
  ],
  "id": "string",
  "indicatorId": "string",
  "result": "pass",
  "triggerSource": "string"
}

400Bad request - Invalid evaluation result ID format

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}

401Unauthorized - Authentication required

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}

403Forbidden - Insufficient permissions

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}

404Evaluation result not found

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}

500Internal server error

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}