Test report delivery REST API

POST

/api/reports/{report_id}/test-send

curl --request POST \
  --url http://127.0.0.1:25737/api/reports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/test-send \
  --cookie hk_token=<hk_token>

Builds the current report content for its latest completed period and sends it only to the current user. Team tests are audited.

Authorizations

• cookieAuth

Parameters

Path Parameters

report_id

required

string format: uuid

Report definition UUID.

Responses

200

Accepted by mail server

Media typeapplication/json

object

message_id

required

string

sent_at

required

string format: date-time

status

required

string

Allowed values: accepted

Example

{
  "status": "accepted"
}

409

Mail unavailable

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

422

Report content unavailable or suppressed

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

502

Mail server did not accept message

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}