Applications

Description

An Application is the name of the client system that a developer is building that consumes your API.  For example, it might be the name of a mobile application, the name/URL of a website, or the name of an internal business system.  The Application object is optional within Mashery but is useful in providing better and more business relevant visibility into what 3rd party applications are using your API.

Object Fields

id

The primary identifier for the application object.

type maxLength format default optional readonly createonly queryable sortable
integer

yes yes no yes no

created

Indicates when this object was created

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

updated

Indicates when this object was last updated

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

username

The user name of the member that owns this application.

type maxLength format default optional readonly createonly queryable sortable
string 255

yes
 yes
 no
 yes
 no

name

The name of the application

type maxLength format default optional readonly createonly queryable sortable
string 127

no
 no
 no
 yes
 yes

description

The description of the application

type maxLength format default optional readonly createonly queryable sortable
string


yes no
 no
 yes
 no

type

This is an optional survey question often added to the application registration form.

Type is restricted to a specific set of values.  See object.describe for a list of available options.

type maxLength format default optional readonly createonly queryable sortable
string 255

yes
 no
 no
 yes
 no

commercial

This is an optional survey question often added to the application registration form.

type maxLength format default optional readonly createonly queryable sortable
boolean


yes
 no
 no
 yes
 no

ads

Will the application run advertising?  This is an optional survey question often added to the application registration form.

type maxLength format default optional readonly createonly queryable sortable
boolean


yes
 no
 no
 yes
 no

ads_system

This is an optional survey question often added to the application registration form.

type maxLength format default optional readonly createonly queryable sortable
string 64

yes
 no
 no
 yes
 no

usage_model

This is an optional survey question often added to the application registration form.

usage_model is restricted to a specific set of values.  See object.describe for a list of available options.

type maxLength format default optional readonly createonly queryable sortable
string 32

yes
 no
 no
 yes
 no

notes

This is an optional survey question often added to the application registration form.

type maxLength format default optional readonly createonly queryable sortable
string


yes
 no
 no yes
 no

how_did_you_hear

This is an optional survey question often added to the application registration form.

type maxLength format default optional readonly createonly queryable sortable
string 255

yes
 no
 no
 yes
 no

preferred_protocol

This is an optional survey question often added to the application registration form.

preferred_protocol is restricted to a specific set of values.  See object.describe for a list of available options.

type maxLength format default optional readonly createonly queryable sortable
string
 32

yes
 no
 no
 yes
 no

preferred_output

This is an optional survey question often added to the application registration form.

preferred_protocol is restricted to a specific set of values.  See object.describe for a list of available options.

type maxLength format default optional readonly createonly queryable sortable
string 32

true
 no
 no
 yes
 no

external_id

External Id is used for synchronizing applications with external systems.

type maxLength format default optional readonly createonly queryable sortable
string 255

yes
 no
 no
 yes
 yes

uri

Uri of the application.

type maxLength format default optional readonly createonly queryable sortable
string 255

yes
 no
 no
 yes
 no

status

Controls application visibility if public applications are turned on.  This option is not turned on by default for most customers.

Allowable values are "draft" which means the application is kept private or "published" which allows users other than the application's owner to see selected fields from the application.

type maxLength format default optional readonly createonly queryable sortable
string 16
"draft"
 yes
 no
 no
 yes
 no

object_type

For applications this will always contain the value 'application'.

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

Relationships

member

Every application belongs to exactly one member.  It is not possible to have a memberless application.  When the member relationship is fetched for an application, it will appear in the member field.  The value of that field will be a member object.

keys

An applicaiton may have multiple keys assigned to it.  An application may only have one key per service.  When this relationship is included with the application, it will contain an array of key objects.

Object Methods

The application namespace contains methods for manipulating application objects.

application.fetch
returns an application object based on a specified id.
application.create
create a new application object.
application.update
modifies an existing applicaiton object.
applicaiton.validate
validates fields on an application object.
applicaiton.delete
validates fields on an application object.

version 37 as of 2 months ago by Mashery Jeff

Comments

New comments are not being accepted at this time.