Skip to content

Tickets API

Access with client.tickets().

Read

Ticket ticket = client.tickets().get(ticketId);

Required scope: tickets:read.

Update

Ticket updated = client.tickets().update(
    ticketId,
    new UpdateTicketRequest()
        .title("Design and review deployment runbook")
        .priority(Priority.HIGHEST)
        .archived(false)
);

Required scope: tickets:write.

Supported update fields are title, description HTML, priority, due date, assignee IDs, label IDs, and archive state.

Move

Ticket moved = client.tickets().move(
    ticketId,
    new MoveTicketRequest(destinationBoardId)
        .position(2000)
);

position is optional and must be non-negative. If it is omitted, Okatana appends the ticket to the destination board.

Comment

DynamicResource comment = client.tickets().addComment(
    ticketId,
    new CreateCommentRequest("<p>Deployment validation is complete.</p>")
);

Required scope: comments:write.

The response schema for a created comment is not defined in the OpenAPI file, so the SDK preserves it dynamically.

Delete

client.tickets().delete(ticketId);

Required scope: tickets:write. Delete is soft.