Plan Methods

Description

A plan method represents the relationship between a plan and a service definition method. It is created when a service definition method is included in a plan, either directly or when its parent service definition endpoint or its ancestor service definition are included.

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

rate_limit_ceiling

API Key specific Rate Limit the Proxy Service will enforce if both Rate Limit Enforcement is enabled and Rate Limit Overrides are allowed in the Dashboard API Settings Tab. This value takes precidence over the Service Definition Default Rate Limit. Note: The period ("Minute", "Hour", "Day", "Month") for the rate_limit_ceiling (Custom Rate Limit) is set in the Service Definition's Rate Limit Period configuration item in the Dashboard API Settings Tab.

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

rate_limit_exempt

Toggle whether this key has an unlimited rate limit. This setting is only applied by the Proxy Service at runtime if the Rate Limit feature is enabled and the Default Rate Limit Override is allowed.

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

rate_limit_period

Time period for which calls are counted and compared against the limit set.

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

qps_limit_ceiling

API Key specific QPS Limit the Proxy Service will enforce if both Throttling Limit Enforcement is enabled and Throttling Limit Overrides are allowed in the Dashboard API Settings Tab. This value takes precedence over the Service Definition Default Rate Limit. This value is only enforced if the Aggregate QPS has not been reached for the Service Definition.

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

qps_limit_exempt

Toggle whether this key allows unlimted qps. This setting is only applied by the Proxy Service at runtime if the Throttling Limit Enforcement feature is enabled and Throttling Limit Override is allowed. This setting does not take precidence over any Aggregate QPS setting on the service definition.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
boolean				no	no	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 Method 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_services.

Service Definition Method

A Plan Method has one and only one related Service Definition Method object. The related Service Definition Method object can be accessed directly via the object.query API method by including this relationship in the query, e.g. select *, service_definition_method from plan_services.