Skip to main content

Get results of a batch

GET 
/api/v1/orgs/{orgId}/batches/{batchId}/results

Retrieve execution results for a batch under a specific organization.

Usage
GET /orgs/{orgId}/batches/{batchId}/results

Path Parameters

  • orgId (string, required): the ID of the organization.
  • batchId (Guid, required): the ID of the batch.

Query Parameters

  • triggeredBy (enum, optional): filter by trigger type. Allowed values: Manual, Scheduler.
  • triggerId (Guid, optional): filter results by a specific trigger ID.
  • groupBy (enum, optional): set to trigger to group results by trigger ID. Returns Dictionary<Guid, List<BatchActionLogDto>> when specified.
  • skipCount (int, optional): number of records to skip for pagination. Default: 0.
  • maxResultCount (int, optional): maximum number of records to return. Range: 1–1000. Default: 10.
  • sorting (string, optional): sorting expression (e.g., CreationTime DESC).

Responses

  • 200 OK: returns PagedResultDto<BatchActionLogDto> when groupBy is not set, or Dictionary<Guid, List<BatchActionLogDto>> when groupBy=trigger.
  • 400 Bad Request: invalid query parameter (e.g. unsupported triggeredBy value).
  • 404 Not Found: organization or batch not found.

Security
This API requires authentication.

Request​

Responses​

OK