Open Health Sync
Releasesv0.1.0
Api referenceEndpointsShares

One share link, with its latest accesses

GET
/v1/users/{id}/shares/{share_id}

The share and its 50 latest manifest requests, newest first, each with the name the reader gave and the outcome.

Authorization

tenantKey
headerAuthorizationBearer <token>

Tenant API key, ohs_sk_ + 43 base62 characters.

Path Parameters

id*string
Formatuuid
share_id*string

The id of a share link of this user.

Formatuuid

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Response Body

The share.

application/json
  1. response

A share link as its owner reads it. Never the link, its key or the passcode.

id*string
Formatuuid
label*string

Shown to the reader; empty for none.

Lengthlength <= 80
categories*array<>
start*string

Inclusive start of the time window.

Formatdate-time
end*string

Exclusive end of the time window.

Formatdate-time
expires_at*string

When the link stops working.

Formatdate-time
passcode*boolean

Whether the link needs a passcode.

passcode_failures*integer

Wrong or missing passcodes so far; the 10th disables the link.

status*string

active: the link works. expired: past expires_at. revoked: stopped before its expiry (see revoked_reason). disabled: too many wrong passcodes.

Value in"active""expired""revoked""disabled"
revoked_at*|
Formatdate-time
revoked_reason*|
Value in"owner""consent""provider_erased""passcode_attempts"null
observations*integer

How many Observations the file holds.

file_bytes*integer

The size of the encrypted file when it was made.

accesses*integer

How many manifest requests were served the file.

last_accessed_at*|

The latest of them.

Formatdate-time
created_at*string
Formatdate-time
recent_accesses*array<>

The 50 latest manifest requests, newest first.

curl -X GET 'http://localhost:8080/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/shares/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Authorization: Bearer ohs_sk_...'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "label": "string",  "categories": [    "activity"  ],  "start": "2019-08-24T14:15:22Z",  "end": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "passcode": true,  "passcode_failures": 0,  "status": "active",  "revoked_at": "2019-08-24T14:15:22Z",  "revoked_reason": "owner",  "observations": 0,  "file_bytes": 0,  "accesses": 0,  "last_accessed_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "recent_accesses": [    {      "at": "2019-08-24T14:15:22Z",      "recipient": "string",      "outcome": "served"    }  ]}
Edit on GitHub