Plan Endpoints

Description

A plan endpoint represents the relationship between a plan and a service definition endpoint. It is created when a service definition endpoint is included in a plan, either directly or when its parent service definition is 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

allow_undefined_methods

For an endpoint, allow undefined methods to be allowed through by the Traffic Manager. If not set, or "false", then the Traffic Manager will block any calls to methods that it cannot find as being defined as belonging to the endpoint in question.

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 Endpoint 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_endpoints.

Service Definition Endpoint

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