Applications

Resource URI

/applications

Items in curly braces represent variables.

Description

Roles control access to and visibility of APIs and Package Plans in the Portal. The Mashery v3 API supports fetching roles. Please consult the V2 API documentation for creating, updating and deleting roles.

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.

Returns

Success

Array of Roles 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

Examples

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": "morbi porttitor lorem",
        "commercial": false,
        "created": "2015-07-29T19:04:51.000+0000",
        "description": "id lobortis convallis tortor risus dapibus augue vel accumsan tellus nisi eu orci mauris lacinia sapien quis libero",
        "externalId": "justo",
        "howDidYouHear": "orci luctus",
        "id": "cf699a14-1725-4c89-b78e-546d09559163",
        "name": "donec dapibus duis at",
        "notes": "et eros vestibulum ac",
        "oauthRedirectUri": "curabitur",
        "preferredOutput": "ornare consequat",
        "preferredProtocol": "lectus pellentesque",
        "tags": "nibh",
        "type": "sapien quis",
        "updated": "2015-12-14T14:17:39.000+0000",
        "uri": "in tempus sit",
        "usageModel": "morbi quis tortor",
        "username": "vitae"
    }
]

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

Returns

Success

Array of ServiceDefinitions 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

Examples

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": "nulla tempus vivamus",
        "commercial": false,
        "created": "2015-11-18T07:55:40.000+0000",
        "description": "maecenas pulvinar lobortis est phasellus sit amet erat nulla tempus vivamus in",
        "externalId": "sodales sed tincidunt eu",
        "howDidYouHear": "nisi eu orci",
        "id": "13dd3bd0-21d5-4420-bae1-8f862ce82f5c",
        "name": "vivamus metus arcu",
        "notes": "penatibus",
        "oauthRedirectUri": "in purus",
        "preferredOutput": "vestibulum",
        "preferredProtocol": "hac habitasse",
        "tags": "suspendisse potenti",
        "type": "dignissim",
        "updated": "2015-01-30T19:28:12.000+0000",
        "uri": "auctor",
        "usageModel": "mus vivamus vestibulum",
        "username": "feugiat"
    }
]

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

ServiceDefinition 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

Examples

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":true,"adsSystem":"condimentum id","commercial":false,"created":"2015-09-24T20:29:22.000+0000","description":"donec ut dolor morbi vel lectus in quam fringilla rhoncus mauris enim leo rhoncus sed vestibulum sit amet","externalId":"faucibus","howDidYouHear":"luctus et","id":"d7175980-028f-4891-aab9-be130ccdb9d9","name":"magna vulputate","notes":"maecenas pulvinar lobortis","oauthRedirectUri":"morbi porttitor lorem","preferredOutput":"et","preferredProtocol":"maecenas tincidunt","tags":"praesent blandit lacinia erat","type":"tincidunt nulla","updated":"2015-01-28T20:24:55.000+0000","uri":"porta volutpat erat","usageModel":"tincidunt nulla mollis molestie","username":"pellentesque ultrices phasellus id"}

Response

[
    {
        "ads": true,
        "adsSystem": "iaculis congue vivamus",
        "commercial": false,
        "created": "2015-11-01T06:53:37.000+0000",
        "description": "in felis eu sapien cursus vestibulum proin eu mi nulla ac enim in tempor turpis nec euismod scelerisque quam turpis",
        "externalId": "sed magna",
        "howDidYouHear": "ut",
        "id": "df6ba09e-1e51-43fe-8196-852571384a28",
        "name": "at dolor quis",
        "notes": "aliquet pulvinar sed",
        "oauthRedirectUri": "congue elementum",
        "preferredOutput": "est phasellus sit",
        "preferredProtocol": "urna ut tellus",
        "tags": "integer aliquet",
        "type": "turpis",
        "updated": "2015-09-17T22:41:49.000+0000",
        "uri": "ultrices posuere cubilia",
        "usageModel": "mus vivamus vestibulum",
        "username": "habitasse platea dictumst aliquam"
    }
]

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

Examples

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

[
    ""
]

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

[
    ""
]

Docs Navigation