Api referenceEndpointsTags
Change a time tag
PATCH
Absent members stay as they are; null clears label, timezone, note or end_at
(null end_at reopens the tag). kind and start_at cannot be null, and source
cannot change. The tag after the change is checked as a whole: end_at must stay after
start_at. A body that changes nothing returns the tag as it is.
tenantKeyheader
AuthorizationBearer <token>Tenant API key, ohs_sk_ + 43 base62 characters.
id*stringFormat
uuidtag_id*stringThe id of a time tag of this user.
Format
uuidapplication/json- body
kind?TimeTagKindThe controlled vocabulary of time tags; see docs/time-tags.md.
Value in
"illness""injury""travel""jet_lag""vaccination""medication""alcohol""other"label?|Length
length <= 100start_at?|end_at?||nulltimezone?|Length
length <= 64note?|Length
length <= 2000The tag after the change.
application/json- response
id*stringFormat
uuidkind*TimeTagKindThe controlled vocabulary of time tags; see docs/time-tags.md.
Value in
"illness""injury""travel""jet_lag""vaccination""medication""alcohol""other"label*|Length
length <= 100start_at*stringFormat
date-timeend_at*|Exclusive end; null while the tag is ongoing.
Format
date-timetimezone*|An IANA time zone, for example the destination zone of a trip.
note*|Length
length <= 2000source*stringWho recorded the tag; user unless the creator named itself.
created_at*stringFormat
date-timeupdated_at*stringFormat
date-timecurl -X PATCH 'http://localhost:8080/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/tags/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Authorization: Bearer ohs_sk_...' \ -H 'Content-Type: application/json' \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "illness", "label": "string", "start_at": "2019-08-24T14:15:22Z", "end_at": "2019-08-24T14:15:22Z", "timezone": "Asia/Tokyo", "note": "string", "source": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}