Documentation

Fields

• list_plan_add_onsParametersPathPlan_id :: Text

  pathPlan_id: Represents the parameter named 'plan_id'

  Plan ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-gold`.

• list_plan_add_onsParametersQueryBegin_time :: Maybe JsonDateTime

  queryBegin_time: Represents the parameter named 'begin_time'

  Inclusively filter by begin_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

• list_plan_add_onsParametersQueryEnd_time :: Maybe JsonDateTime

  queryEnd_time: Represents the parameter named 'end_time'

  Inclusively filter by end_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

• list_plan_add_onsParametersQueryIds :: Maybe [Text]

  queryIds: Represents the parameter named 'ids'

  Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`.

  • *Important notes:**
  • The `ids` parameter cannot be used with any other ordering or filtering parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
  • Invalid or unknown IDs will be ignored, so you should check that the results correspond to your request.
  • Records are returned in an arbitrary order. Since results are all returned at once you can sort the records yourself.
• list_plan_add_onsParametersQueryLimit :: Maybe Int

  queryLimit: Represents the parameter named 'limit'

  Limit number of records 1-200.

  Constraints:

  • Maxium of 200.0
  • Minimum of 1.0
• list_plan_add_onsParametersQueryOrder :: Maybe List_plan_add_onsParametersQueryOrder

  queryOrder: Represents the parameter named 'order'

  Sort order.

• list_plan_add_onsParametersQuerySort :: Maybe List_plan_add_onsParametersQuerySort

  querySort: Represents the parameter named 'sort'

  Sort field. You *really* only want to sort by `updated_at` in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

• list_plan_add_onsParametersQueryState :: Maybe List_plan_add_onsParametersQueryState

  queryState: Represents the parameter named 'state'

  Filter by state.