• Register

Plan Filters

Description

NOTE:This object is available when API Packager is turned on for a customer. Please contact Support or your Account Manager if you have any questions about API Packager.

Object Fields

id

The id field is the primary identifier for the object.

type maxLength format default optional readonly createonly queryable sortable
integer no yes no yes no

object_type

The type of the object.

type maxLength format default optional readonly createonly queryable sortable
string 32 yes yes no no no

Relationships

Plan

A Plan Filter has one and only one related Plan object. The related Plan object can be accessed directly via the object.query API method by including this relationship in the query, e.g. select *, plan from plan_filters.

Plan Method

A Plan Filter has one and only one related Plan Method objects. The related Plan Method objects can be accessed directly via the object.query API method by including this relationship in the query, e.g. select *, methods from plan_filters.

Reponse Filter

A Plan Filter has one and only one related Response Filter object. The related Response Filter object can be accessed directly via the object.query API method by including this relationship in the query, e.g. select *, response_filter from plan_filters.

Object Methods

The plan_filter namespace contains the following methods for manipulating services.

plan_filter.fetch
Get a specific plan filter or a list of plan filters  .
plan_filter.create
Create a plan filter  .
plan_filter.delete
Delete a plan filter  .
plan_filter.validate
Validate a plan filter  .

Docs Navigation