• Register

Service Definition Endpoints

Description

A service definition endpoint represents a container used to store descendant service definition methods. Service definition endpoints are automatically managed, from create to delete, by the service object.

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

epkey

GUID for the service definition endpoint

type maxLength format default optional readonly createonly queryable sortable
string 24 no no 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

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

Service Definition Method

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

Object Methods

The service_definition_endpoint namespace contains the following methods for manipulating services.

service_definition_endpoint.fetch
Get a specific service definition endpoint or a list of service definition endpoints  .

version 4 as of 11 years ago by Jeremy Pollock

Docs Navigation