Results List

/v1alpha2/parents/{parent}/results

Common Parameters

  • parent (in path): string required

    Parent name refers to the namespace name or workspace name.

  • filter (in query): string

    This query can be used to pass CEL Expressions to filter the response. See more details here.

  • page_token (in query): string

    It can be used to fetch the next set of responses when the response is paginated. It corresponds to NextPageToken in the response.

  • page_size (in query): integer

    Number of response to fetch in one request. This query can be used for pagination.

  • order_by (in query): string

    This query can be used to order the response based on parameters. More details can be found here. Note: Add %20 instead of space when adding an optional direction qualifier, e.g created_by%20asc.

getGet the list of the Results

Results can be read across parents by specifying - as the parent. This is useful for listing all results stored in the system without prior knowledge about the available parents.

Response

  • 200object: List of Results with nextPageToken
    Properties:
    • results: []Result
    • nextPageToken: string

Result

Results are aggregators of Records, allowing users to refer to groups of Records as a single entity.

  • annotations: object

    Arbitrary user provided labels for the result.

  • uid: string

    server assigned identified of the Results

  • name: string

    User assigned identifier of the Result. Encodes Parent information.

  • summary: object

    RecordSummary is a high level overview of a Record, typically representing a "root" record for a result. It includes type agonstic information so that UI's and other tools do not need to be aware of underlying types.

  • createdTime: string

    DEPRECATED: Use createTime instead

  • createTime: string

    Server assigned timestamp for when the result was created.

  • updatedTime: string

    DEPRECATED: Use updateTime instead

  • updateTime: string

    Server assigned timestamp for when the result was updated.

  • id: string

    DEPRECATED: use uid instead

  • etag: string

    This is etag for Results. If this is provided on update, it must match the server's etag.

RecordSummary

RecordSummary is a high level overview of a Record, typically representing a "root" record for a result. It includes type agonstic information so that UI's and other tools do not need to be aware of underlying types.

  • record: string

    The name of the Record this summary represents.

  • type: string

    Identifier of underlying data.

  • status: string

    Completion status of the Record.

  • startTime: string
  • endTime: string
  • annotations: object

    Key-value pairs representing abitrary underlying record data that clients want to include that aren't covered by the above fields.

Status

Completion status of the Record.