Services

Description

A service object describes a proxy service.

Object Fields

A service object contains the following fields.

service_key

The service_key field is the primary identifier for a service object.

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

name

Service name.

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

object_type

The type of the object.  This is always "service" for a service.

type maxLength format default optional readonly createonly queryable sortable
string 32    "service" yes yes no no no

Relationships

keys

A service may have many keys.  There is currently no keys property representing this relationship from the service side.  Access keys from the key object using REQUIRE RELATED service query terms.

Object Methods

The service namespace contains the following methods for manipulating services.

service.fetch
Returns a service object based on a specified service_key.
service.getCacheStatus
Returns the content cache status for a given service.
service.flushCache
Flushes the content cache status for a given service.

version 28 as of 2 months ago by Mashery Jeff

Comments

New comments are not being accepted at this time.