• Register

Applications

Resource URI

/applications

Items in curly braces represent variables.

Description

An Application captures information about the intended use of the API by the developers. 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 required within Mashery and is useful in providing better and more business relevant visibility into what third party applications are using your API.

This method in the Mashery v3 API supports fetching, updating and deleting Applications. If you need to create an Application please use the MemberApplications method.

Resource Schema

Property Characteristics
id Type string
Sub-type
Create Rule Ignored
Update Rule Required (if not in context)
Fetch Rule Implicit
Description Object identifier (Application UUID).
name Type string
Sub-type
Create Rule Required
Update Rule Optional
Fetch Rule Implicit
Description Application name.
created Type string
Sub-type datetime
Create Rule Ignored
Update Rule Ignored
Fetch Rule Implicit
Description Date/time the object was created.
updated Type string
Sub-type datetime
Create Rule Ignored
Update Rule Ignored
Fetch Rule Implicit
Description Date/time the object was last updated.
username Type string
Sub-type
Create Rule Required
Update Rule Optional
Fetch Rule Implicit
Description Username of the membe that the application belongs to.
description Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Description of the application.
type Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Type of application; metadata used for tracking.
commercial Type boolean
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Whether or not the application is commercial in nature.
ads Type boolean
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Whether or not the application supports ads.
adsSystem Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Advertisement system.
usageModel Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Usage model.
tags Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Tags, i.e. tracking metadata.
notes Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Notes about the application.
howDidYouHear Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description How did someone hear about the API?
preferredProtocol Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Protocol preference of developer, e.g. REST or SOAP.
preferredOutput Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description Output preference of developer, e.g. json or xml.
externalId Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description ID of the application in an external system, e.g. Salesforce
uri Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description URI of the application.
oauthRedirectUri Type string
Sub-type
Create Rule Optional
Update Rule Optional
Fetch Rule Implicit
Description OAuth 2 redirect URI.
packageKeys Type array
Sub-type Packagekey
Create Rule Optional
Update Rule Optional
Fetch Rule Explicit
Description Keys that belong to the Application.

fetch all [GET]

Retrieves collection of Applications belonging to the given Area.

Parameters

Parameter Required Type Description
fields false string Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property\[.property...\]>\[,...\]\[&fields=...\]
filter false string Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property\[.property...\]>:<value>\[&filter=...\]
sort false string Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property\[:(asc\|desc)\]>\[,...\]\[&sort=...\]
limit false int Number of objects to return in the result. Defaults to 100.
offset false int 0-based index of first object in the list to return. Defaults to 0 for /service and /packages APIs. For /members, /applications, /packageKeys, and /roles APIs, the offset field functions as a page index, where the first page is indexed as 0.
search false string

Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). This parameter uses a partial match search. The valid field names are name, username, description, type, usageModel, tags, preferredProtocol, preferredOutput, uri, isPackaged.

Example: search=name%3Acar

Example: search=name%3Acar%2Cusername%3Acar%2Cdescription%3Acar%2Ctype%3Acar%2CusageModel%3Acar%2Ctags%3Acar%2CpreferredProtocol%3Acar%2CpreferredOutput%3Acar%2Curi%3Acar%2CisPackaged%3Acar

Returns

Success

Array of Applications for the Area. If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Example

Request

curl -k 'https://api.mashery.com/v3/rest/applications' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json"

Response

[
    {
        "ads": true,
        "adsSystem": "faucibus accumsan",
        "commercial": true,
        "created": "2015-01-09T19:04:09.000+0000",
        "description": "eros elementum pellentesque quisque porta volutpat erat quisque erat eros viverra eget congue eget semper rutrum nulla nunc purus",
        "externalId": "nam ultrices libero",
        "howDidYouHear": "sit amet sem",
        "id": "4a8612dc-1b27-439f-aa96-5b02ea77aca7",
        "name": "pede",
        "notes": "mauris ullamcorper purus sit",
        "oauthRedirectUri": "odio justo sollicitudin ut",
        "preferredOutput": "suscipit ligula in",
        "preferredProtocol": "vestibulum",
        "tags": "aliquet",
        "type": "quam",
        "updated": "2015-05-09T22:57:25.000+0000",
        "uri": "ut",
        "usageModel": "proin eu mi nulla",
        "username": "dignissim"
    }
]

fetch [GET]

Retrieves the identified Application.

Parameters

Parameter Required Type Description
applicationId true string Application identifier.
fields false string Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property\[.property...\]>\[,...\]\[&fields=...\]
filter false string Colon-separated name/value pair specifying the name of property whose value must match the exact given value. Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property\[.property...\]>:<value>\[&filter=...\]
sort false string Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property\[:(asc\|desc)\]>\[,...\]\[&sort=...\]
limit false int Number of objects to return in the result. Defaults to 100.
offset false int 0-based index of first object in the list to return. Defaults to 0 for /service and /packages APIs. For /members, /applications, /packageKeys, and /roles APIs, the offset field functions as a page index, where the first page is indexed as 0.

Returns

Success

Array of Applications for the Area. If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Example

Request

curl -k 'https://api.mashery.com/v3/rest/applications/{applicationId}' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json"

Response

[
    {
        "ads": true,
        "adsSystem": "elit",
        "commercial": true,
        "created": "2015-06-23T03:58:37.000+0000",
        "description": "amet nunc viverra dapibus nulla suscipit ligula in lacus curabitur at ipsum ac tellus semper interdum mauris ullamcorper purus",
        "externalId": "et",
        "howDidYouHear": "integer a nibh in",
        "id": "23573636-ee1c-437f-8f78-8bb8682d10ca",
        "name": "a odio",
        "notes": "feugiat non pretium",
        "oauthRedirectUri": "eu massa donec",
        "preferredOutput": "praesent",
        "preferredProtocol": "lorem ipsum",
        "tags": "curabitur convallis duis consequat",
        "type": "sociis natoque penatibus",
        "updated": "2015-10-29T17:31:47.000+0000",
        "uri": "enim blandit",
        "usageModel": "aliquam sit",
        "username": "sapien iaculis congue"
    }
]

update [PUT]

Updates the identified Application.

Parameters

Parameter Required Type Description
applicationId true string Application identifier.
application true object Application object

Returns

Success

Application as persisted. If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Example

Request

curl -k 'https://api.mashery.com/v3/rest/applications/{applicationId}' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request PUT --data '{"ads":false,"adsSystem":"leo odio porttitor id","commercial":false,"created":"2015-01-12T06:56:25.000+0000","description":"gravida nisi at nibh in hac habitasse platea dictumst aliquam augue","externalId":"mollis molestie lorem","howDidYouHear":"eget","id":"42bd8940-a480-48c1-a1b6-29f5bf67d275","name":"ipsum primis","notes":"sodales scelerisque mauris sit","oauthRedirectUri":"in libero ut massa","preferredOutput":"nisi vulputate nonummy maecenas","preferredProtocol":"quis tortor id","tags":"leo pellentesque ultrices","type":"platea dictumst aliquam","updated":"2015-01-29T07:59:40.000+0000","uri":"dis parturient","usageModel":"ante vel ipsum praesent","username":"ultrices enim"}

Response

    {
        "ads": true,
        "adsSystem": "nullam porttitor",
        "commercial": false,
        "created": "2015-04-02T13:11:48.000+0000",
        "description": "consequat in consequat ut nulla sed accumsan felis ut at dolor quis odio consequat varius integer ac leo pellentesque ultrices",
        "externalId": "morbi vel lectus",
        "howDidYouHear": "tempus sit amet sem",
        "id": "de8eeec8-1687-428b-865b-cb048b808d2d",
        "name": "cras mi",
        "notes": "aenean lectus pellentesque",
        "oauthRedirectUri": "hac habitasse platea dictumst",
        "preferredOutput": "volutpat convallis",
        "preferredProtocol": "in hac",
        "tags": "dui nec nisi volutpat",
        "type": "enim blandit",
        "updated": "2015-03-25T06:02:14.000+0000",
        "uri": "potenti",
        "usageModel": "molestie",
        "username": "justo morbi ut odio"
    }

delete [DELETE]

Deletes the identified Application.

Parameters

Parameter Required Type Description
applicationId true string Application identifier.

Returns

Success

Empty response

Failure

Array of validation responses.

Example

Request

curl -k 'https://api.mashery.com/v3/rest/applications/{applicationId}' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request DELETE

Response

[
    ""
]

version 18 as of 3 years ago by jpadre

Docs Navigation