Open Health Sync
Releasesv0.1.0
Api referenceEndpointsAdmin

Retry one parked processing job (instance admin, one tenant)

POST
/v1/admin/tenants/{tenant_id}/pipeline/etl-jobs/{job_id}/retry

POST /v1/pipeline/etl-jobs/{job_id}/retry (retryETLJob) for the tenant of tenant_id, run with an instance admin key: the same body, parameters and answer as the tenant's own key gets; a Location points at the admin route. Recorded in the caller's audit log and, actor admin, in the tenant's. See docs/admin-api.md.

Authorization

tenantKey
headerAuthorizationBearer <token>

Tenant API key, ohs_sk_ + 43 base62 characters.

Path Parameters

tenant_id*string

The id of a tenant; any other value is a 404.

Formatuuid
job_id*integer
Formatint64

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Response Body

The job, pending again.

application/json
  1. response

One processing job, turning a stored raw payload into records.

id*integer
Formatint64
user_id*string
Formatuuid
provider*string
tier*string
status*string
Value in"pending""running""parked""done"
attempts*integer
error*|

The error of the last failed attempt.

created_at*string
Formatdate-time
next_attempt_at*|

Set while the job is pending.

Formatdate-time
curl -X POST 'http://localhost:8080/v1/admin/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/pipeline/etl-jobs/0/retry' \  -H 'Authorization: Bearer ohs_sk_...'
{  "id": 0,  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",  "provider": "string",  "tier": "string",  "status": "pending",  "attempts": 0,  "error": "string",  "created_at": "2019-08-24T14:15:22Z",  "next_attempt_at": "2019-08-24T14:15:22Z"}
Edit on GitHub