Hanzo
OpenapiO11y

Moves one queue item between PENDING and COMPLETED and sets its assignee.

Moves one queue item between PENDING and COMPLETED and sets its assignee. Completing an item stamps its completedAt.

PATCH /v1/o11y/reviews/{id}/items/{itemId}

Addresshttps://api.hanzo.ai/v1/o11y/reviews/{id}/items/{itemId}
MethodPATCH
Operationpatch_o11y_reviews_by_id_items_by_itemid
AuthAuthorization: Bearer $HANZO_API_KEY

Moves one queue item between PENDING and COMPLETED and sets its assignee. Completing an item stamps its completedAt. An item that exists under a different queue answers the same 404 an unknown item does, and so does a queue belonging to another org.

Request

6 fields, body application/json (required).

FieldInTypeRequiredDescription
idpathstringyesID is the annotation queue the item belongs to, from the path.
itemIdpathstringyesItemID is the item to update, from the path.
assigneebodystringAssignee replaces the reviewer this item is for, up to 512 characters.
idbodystringID is the annotation queue the item belongs to, from the path.
itemIdbodystringItemID is the item to update, from the path.
statusbodystringStatus is the item's new review state: PENDING or COMPLETED.

Response

StatusBodyMeaning
200o11y.annItemViewok

200 body — 12 fields.

FieldInTypeAlwaysDescription
assigneebodystringAssignee is the reviewer it is for, omitted when unassigned.
completedAtbodystringCompletedAt is when it was reviewed, omitted while pending.
createdAtbodystringCreatedAt is when it was enqueued, RFC3339 in UTC.
idbodystringID is the item's id.
objectIdbodystringObjectID is the referenced object's id.
objectTypebodystringObjectType is what it references: TRACE, OBSERVATION or SESSION.
observationIdbodystringObservationID echoes objectId when objectType is OBSERVATION.
queueIdbodystringQueueID is the queue it belongs to.
sessionIdbodystringSessionID echoes objectId when objectType is SESSION.
statusbodystringStatus is PENDING or COMPLETED.
traceIdbodystringTraceID echoes objectId when objectType is TRACE.
updatedAtbodystringUpdatedAt is when it last changed, RFC3339 in UTC.

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y reviews items update <id> <itemId>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page