• Register

Service Definition Methods

Description

A service definition method is necessary to support method level limiting and response filtering. When adding Methods for your Endpoints, please note that the name of the method must match exactly what the Traffic Manager will be detecting based on the Methods Configuration setting for this Endpoint . This setting is found in the Services section of the Dashboard. You can also see the result of the Methods Configuration setting by checking the Method usage reports in the Reports section of the Dashboard. Using the names of the methods as seen in these reports is the easiest and best way to ensure that your method definitions will be correct.

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

name

Name of the object

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

created

The date that this object was created.

type maxLength format default optional readonly createonly queryable sortable
string 20 date-time yes yes no yes no

updated

The date this object was last updated.

type maxLength format default optional readonly createonly queryable sortable
string 20 date-time yes 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

Service Definition Endpoint

A Service Definition Method 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 service_definitions_methods.

Service Definition Response

A Service Definition Method zero or many related Service Definition Response objects. The related Service Definition Response objects can be accessed directly via the object.query API method by including this relationship in the query, e.g. select *, service_definition_responses from service_definitions_methods.

Object Methods

The service_definition_method namespace contains the following methods for manipulating services.

service_definition_method.update
Update a method for a service definition endpoint  .
service_definition_method.create
Create a method for a service definition endpoint  .
service_definition_method.delete
Delete a service definition method or a list of methods  .
service_definition_method.fetch
Get a specific service definition method or a list of service definition methods  .
service_definition_method.validate
Validate a service definition method  .

Docs Navigation