App

Name Description Schema Default Example

id

optional

UUID of the app registry artifact

string

null

01234567-0123-0123-0123-012345678901

name

required

string

null

CalculatorApp

type

optional

App type (either Webapp/Mobile app)

string

null

01234567-0123-0123-0123-012345678901

marketType

optional

string

null

enterprise,

recentChanges

optional

string

null

Upgraded

icon

optional

the image icon of the application

string

null

/publisher/api/mobileapp/getfile/TJXfaEeHsdeYSFS.jpg,/publisher/api/mobileapp/getfile/aCJ1MXUXWGGHS3t.JPG

isSite

optional

Either a webapp or site

string

null

for sites - TRUE

description

optional

string

null

A calculator App that supports basic operations

context

optional

string

null

CalculatorApp

version

required

string

null

1.0.0

provider

optional

If the provider value is not given user invoking the api will be used as the provider.

string

null

admin

appDefinition

required

Swagger definition of the App which contains details about URI templates and scopes

string

null

{"paths":{"\/substract":{"get":{"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","parameters":[{"name":"x","required":true,"type":"string","in":"query"},{"name":"y","required":true,"type":"string","in":"query"}],"responses":{"200":{}}}},"\/add":{"get":{"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","parameters":[{"name":"x","required":true,"type":"string","in":"query"},{"name":"y","required":true,"type":"string","in":"query"}],"responses":{"200":{}}}}},"swagger":"2.0","info":{"title":"CalculatorApp","version":"1.0.0"}}

isDefaultVersion

optional

boolean

null

false

transport

required

Supported transports for the App (http and/or https).

array

null

null

tags

optional

array

null

null

thumbnailUrl

optional

string

null

lifecycle

optional

lifecycle type of the asset

string

null

MobileAppLifeCycle

lifecycleState

optional

lifecycle state of the asset

string

null

Created

bundleversion

optional

Bundleversion of the asset

string

null

1.0

rating

optional

User rating for the app

number

null

4.0

category

optional

category of the asset

string

null

Business

displayName

optional

displayName of the asset

string

null

testapp1

screenshots

optional

Screenshots attached to the application

array

null

null

banner

optional

/publisher/api/mobileapp/getfile/uWnObGDXigTO7pl.jpg

string

null

/publisher/api/mobileapp/getfile/TJXfaEeHsdeYSFS.jpg,/publisher/api/mobileapp/getfile/aCJ1MXUXWGGHS3t.JPG,/publisher/api/mobileapp/getfile/FcFEWkaLroetXlq.JPG

appType

optional

mobile app type (eg: webapp/ios/android)

string

null

android

createdtime

optional

createdtime of the asset

string

null

1.458300149192E12

platform

optional

platform of the asset

string

null

andoid

lifecycleAvailableActions

optional

platform of the asset

string

null

[Submit for Review]

customProperties

optional

array

null

null