COconductorone
Task

List

Changed on

List audit trail events for a task.

post/api/v1/task/audits

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/task/audits
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Request body

commentsOnlyboolean

When true, only comment events are returned, so a page of page_size holds page_size comments rather than a mix of comments and state-change events.

excludeCommentsboolean

When true, comment events are excluded from the response and the count, so a page of page_size holds page_size non-comment events. Mutually exclusive with comments_only.

newestFirstboolean

When true, events are returned newest-first (descending created_at) instead of the default chronological (ascending) order.

pageSizeinteger

The maximum number of audit events to return per page.

pageTokenstring

A pagination token from a previous response to retrieve the next page.

taskIdstring

The ID of the task to list audit events for.

Response

Successful response

nextPageTokenstring

A pagination token to retrieve the next page of results.

totalCountstring int64 nullable

The total number of audit events the list returns for this request: comment events when comments_only is true, non-comment events when exclude_comments is true, all events otherwise. This is an upper bound: a small number of internal-only events (e.g. connector-action results with no pending reason) are omitted from list, so the count can exceed the rows reachable by paging. Only returned for the first page (a request with no page_token). Unset when the request filters by refs (the count is undefined for ref lookups) or when the count could not be computed.

Changes

  • fe943bedf41bRevision changes
    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

  • f76d07868c0cRevision changes
    • info

      added the new optional request property

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property to the response with the status