• Register

Service Definitions

Description

A service definition represents a container used to store descendant service definition endpoints and methods. Service definitions 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

service_key

This is an indicator of the service that this key belongs to. Its not directly assignable.

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

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 from service_definitions.

Service Definition Endpoint

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

Object Methods

The service_definition namespace contains the following methods for manipulating services.

service_definition.fetch
Get a specific service definition or a list of service definitions  .

Docs Navigation