Schedule

Retrieve a set of run policies by query

Changed on

Used to query run policies

get/schedule/runPolicy

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/schedule/runPolicy
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Query parameters

organization_idstring required

The organization id to query

deployment_idstring

The deployment id to query

test_idstring

The test id to filter by; returns only plans that include this test. When supplied, organization_id is required (returns 400 otherwise) - tests are workspace-scoped so the workspace context is needed to use the indexed lookup.

limitinteger

The limit to use for pagination

cursorstring

The cursor to use for pagination

namestring

Return only plans whose name equals this value, ignoring case and surrounding whitespace. Applied in memory after a full workspace scan, so the response contains every match up to limit and the returned cursor is empty; truncated is true when limit cut the match set short. Cannot be combined with cursor (returns 400) - the scan has to start at the beginning to see every match.

include_labelsstring[]

Return only plans carrying at least one of these labels, matched ignoring case and surrounding whitespace. All plans are considered when it is absent. Applied in memory after a full workspace scan on the same terms as name, so the returned cursor is empty, truncated is true when limit cut the match set short, and it cannot be combined with cursor (returns 400).

Response

Array of run policies matching the query

cursorstring

Cursor used for pagination

truncatedboolean

True when an in-memory filter - name or include_labels - matched more plans than limit allowed. The response carries no cursor, so the remaining matches are only reachable by raising limit.

Changes

    • warning

      added the new zephyr enum value to the //////// response property for the response status

    • info

      added the new optional query request parameter include_labels