AppsApi


Delete policy partial

Delete an existing policy partial

URL

http://apis.wso2.com/api/appm/publisher/v1.1/administration/xacmlpolicies/{policyPartialId}

HTTP Method

DELETE

Scope

appm:administration

CURL Example

curl -X DELETE -H "Authorization: Bearer 5e3e12917945881407eaad1868ea4629" -d '' "http://localhost:9763/api/appm/publisher/v1.1/administration/xacmlpolicies/40"

Sample Response

HTTP/1.1 200 OK

Parameters

Type Name Description Schema Default
Path

policyPartialId

required

Policy partial ID

Integer

Header

If-Match

optional

Validator for conditional requests; based on the ETag.

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on the Last Modified header.

String

Responses

HTTP Code Description Schema

200

OK. Resource successfully deleted.

403

Forbidden. The request must be conditional but no condition has been specified.

Error

404

Not Found. Resource to be deleted does not exist.

Error

412

Precondition Failed. The request has not been performed because one of the preconditions is not met.

Error

Change App Status

Change the lifecycle of an App.

URL

http://apis.wso2.com/api/appm/publisher/v1.1/apps/{appType}/change-lifecycle

HTTP Method

POST

Scope

appm:publish

CURL Example

curl -X POST -H "Authorization: Bearer 31b72e5a9158a413187532b052953f68" -H "Content-Type: application/json" "http://localhost:9763/api/appm/publisher/v1.1/apps/mobileapp/change-lifecycle?appId=d88b826c-e560-499e-900d-eb24679b2fbf&action=Unpublish"

Sample Response

HTTP/1.1 202 OK Content-Type: application/json {"message": "Lifecycle action : Recycle has been accepted for processing "}

Parameters

Type Name Description Schema Default
Path

appType

required

The App type (either Webapp/Mobile app).

String

Query

action

required

The action determining whether to demote or promote the state of the App. Supported actions are [**Publish, Approve, Reject, Unpublish, Deprecate, Retire, Recycle, Re-Publish, Submit for Review**]

Accepted values:

Publish Approve Reject Unpublish Deprecate Retire Recycle Re-Publish Submit#for#Review
String

Query

appId

required

**APP ID** consisting of the **UUID** of the App. The following combination is also accepted as a valid App ID: the provider of the app, name of the app and the version. Should be formatted as **provider-name-version**.

String

Header

If-Match

optional

Validator for conditional requests; based on the ETag.

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on the Last Modified header.

String

Responses

HTTP Code Description Schema

202

OK. Lifecycle changed successfully.

ResponseMessage

400

Bad Request. Invalid request or validation error.

Error

404

Not Found. Requested App does not exist.

Error

412

Precondition Failed. The request has not been performed because one of the preconditions is not met.

Error

Get all Apps

Get a list of available Apps qualifying under a given search condition.

URL

http://apis.wso2.com/api/appm/publisher/v1.1/apps/{appType}

HTTP Method

GET

Scope

appm:read

CURL Example

curl -X GET -H "Authorization: Bearer f126676fc6fc2d2d7828220c992c9b15" "http://localhost:9763/api/appm/publisher/v1.1/apps/webapp"

Sample Response

{"previous":"","next":"","count":2,"appList":[{"name":"app1","context":null,"id":"af929140-1257-46ed-97c0-d26098e140e9","rating":0.0,"lifecycleState":"IN-REVIEW","provider":"admin","description":"asdasd","version":"1"},{"name":"app2","context":null,"id":"5c9c8551-d696-4c44-85a6-dcd86f1a1e25","rating":0.0,"lifecycleState":"CREATED","provider":"admin","description":"phone","version":"1.0"}]}

Parameters

Type Name Description Schema Default
Path

appType

required

The App type (either Webapp/Mobile app).

String

Query

query

optional

A search condition. You can search attributes by using an **\"attribute:\"** modifier. Eg. \"provider:wso2\" will match an App if the provider of the App contains \"wso2\". Supported attribute modifiers are [**provider, app_name, app_version, app_id, business_owner_id**] If no advanced attribute modifier has been specified, the search will match the given query string against the App name.

String

Query

field-filter

optional

Used to limit the fields in the response. Supported filters are [ **basic, all**]

Accepted values:

basic all
String

basic

Query

limit

optional

Maximum size of resource array to return.

Integer

25

Query

offset

optional

Starting point within the complete list of items qualified.

Integer

0

Header

Accept

optional

Media types acceptable for the response. Default is JSON.

String

JSON

Header

If-None-Match

optional

Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource.

String

Responses

HTTP Code Description Schema

200

OK. List of qualifying Apps is returned.

AppList

400

Bad Request. Invalid request or validation error.

Error

403

Forbidden. The request must be conditional but no condition has been specified.

Error

404

Not Found. The resource to be updated does not exist.

Error

Create a new version of an App

Create a new version of an App

URL

http://apis.wso2.com/api/appm/publisher/v1.1/apps/{appType}/id/{appId}/create-new-version

HTTP Method

POST

Scope

appm:create

CURL Example

Not Available

Sample Response

Not Available

Parameters

Type Name Description Schema Default
Path

appType

required

The App type (either Webapp/Mobile app).

String

Path

appId

required

**APP ID** consisting of the **UUID** of the App. The following combination is also accepted as a valid APP ID: the provider of the app, name of the app and the version. Should be formatted as **provider-name-version**.

String

Body

body

required

App object that needs to be added.

App (App)

Header

Content-Type

required

Media type of the entity in the body. Default is JSON.

String

JSON

Header

If-Modified-Since

optional

Validator for conditional requests; based on the Last Modified header of the formerly retrieved variant of the resource.

String

Responses

HTTP Code Description Schema

201

Created. Successful response with the newly created object as entity in the body. Location header contains the URL of the newly created entity.

App

400

Bad Request. Invalid request or validation error.

Error

415

Unsupported Media Type. The entity of the request was in an unsupported format.

Error

Delete App

Delete an existing App

URL

http://apis.wso2.com/api/appm/publisher/v1.1/apps/{appType}/id/{appId}

HTTP Method

DELETE

Scope

appm:create

CURL Example

curl -X DELETE -H "Authorization: Bearer f126676fc6fc2d2d7828220c992c9b15" "http://localhost:9763/api/appm/publisher/v1.1/apps/mobileapp/id/af929140-1257-46ed-97c0-d26098e140e9"

Sample Response

HTTP/1.1 200 OK

Parameters

Type Name Description Schema Default
Path

appType

required

The App type (either Webapp/Mobile app).

String

Path

appId

required

**APP ID** consisting of the **UUID** of the App. The following combination is also accepted as a valid APP ID: the provider of the app, name of the app and the version. Should be formatted as **provider-name-version**.

String

Header

If-Match

optional

Validator for conditional requests; based on the ETag.

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on the Last Modified header.

String

Responses

HTTP Code Description Schema

200

OK. Resource successfully deleted.

403

Forbidden. The request must be conditional but no condition has been specified.

Error

404

Not Found. Resource to be deleted does not exist.

Error

412

Precondition Failed. The request has not been performed because one of the preconditions is not met.

Error

Delete Document

Delete an existing document.

URL

http://apis.wso2.com/api/appm/publisher/v1.1/apps/{appType}/id/{appId}/docs/{documentId}

HTTP Method

DELETE

Scope

appm:create

CURL Example

curl -H "Authorization: Bearer 4fc0a364a336a37c663790364da307a3" -X DELETE "http://localhost:9763/api/appm/publisher/v1.1/apps/webapp/id/0950b09c-0afe-47f2-88d6-72e9b88b1931/docs/8150c757-ba7f-4751-8020-71d7ee3e5d76"

Sample Response

HTTP/1.1 200 OK

Parameters

Type Name Description Schema Default
Path

appType

required

The App type (either Webapp/Mobile app).

String

Path

appId

required

**APP ID** consisting of the **UUID** of the App. The following combination is also accepted as a valid APP ID: the provider of the app, name of the app and the version. Should be formatted as **provider-name-version**.

String

Path

documentId

required

Document UUID.

String

Header

If-Match

optional

Validator for conditional requests; based on the ETag.

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on the Last Modified header.

String

Responses

HTTP Code Description Schema

200

OK. Resource successfully deleted.

403

Forbidden. The request must be conditional but no condition has been specified.

Error

404

Not Found. Resource to be deleted does not exist.

Error

Get app details

Get details of an app.

URL

http://apis.wso2.com/api/appm/publisher/v1.1/apps/{appType}/id/{appId}

HTTP Method

GET

Scope

appm:read

CURL Example

curl -X GET -H "Authorization: Bearer f126676fc6fc2d2d7828220c992c9b15" "http://localhost:9763/api/appm/publisher/v1.1/apps/mobileapp/id/af929140-1257-46ed-97c0-d26098e140e9"

Sample Response

{"displayName":null,"createdTime":"00000001461645676735","bundleVersion":"1","packageName":"undefined","description":"asdasd","version":"1","category":"Business","tags":[],"appType":"webapp","appName":"asd","appUrl":"http://wso2.com","banner":"/publisher/api/mobileapp/getfile/pduoTTAgbWAuFxm.JPG","marketType":null,"recentChanges":"-","appProvider":"admin","thumbnail":"/publisher/api/mobileapp/getfile/J3TM0iKb6OiapuG.JPG","screenShots":["/publisher/api/mobileapp/getfile/zq7kNCpZkfLsxic.JPG"],"appId":null,"platform":"webapp","appVisibility":null,"availableLifecycleActions":null,"lifecycleStatus":"INREVIEW","type":"mobileapp","uuid":"af929140-1257-46ed-97c0-d26098e140e9","rating":0.0}

Parameters

Type Name Description Schema Default
Path

appType

required

The App type (either Webapp/Mobile app).

String

Path

appId

required

**APP ID** consisting of the **UUID** of the App. The following combination is also accepted as a valid APP ID: the provider of the app, name of the app and the version. Should be formatted as **provider-name-version**.

String

Header

Accept

optional

Media types acceptable for the response. Default is JSON.

String

JSON

Header

If-None-Match

optional

Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource.

String

Header

If-Modified-Since

optional

Validator for conditional requests; based on the Last Modified header of the formerly retrieved variant of the resource.

String

Responses

HTTP Code Description Schema

200

OK. Qualifying App is returned.

App

400

Bad Request. Invalid request or validation error.

Error

403

Forbidden. The request must be conditional but no condition has been specified.

Error

404

Not Found. The resource to be updated does not exist.

Error

Update an existing App

Update an existing App

URL

http://apis.wso2.com/api/appm/publisher/v1.1/apps/{appType}/id/{appId}

HTTP Method

PUT

Scope

appm:update

CURL Example

curl -v -X PUT -H "Content-Type: application/json" 'http://localhost:9763/api/appm/publisher/v1.1/apps/mobileapp/id/906249f5-529b-41f3-bf18-d95e9403e9f0' -d '{"appmeta" :{"path" : "/publisher/api/mobileapp/getfile/D3PdRxvU24WK3EN.apk", "package" : "home.jmstudios.calc", "version" : "1.0"},"name":"sample","provider":"admin","platform":"android","version":"1.0.0","banner":"/publisher/api/mobileapp/getfile/nzcYzFxpWpNHlyk.jpg","thumbnailUrl":"/publisher/api/mobileapp/getfile/nzcYzFxpWpNHlyk.jpg","screenshots":["/publisher/api/mobileapp/getfile/62gKWqOSvzu31IX.jpg"],"displayName":"fdyefyeufuegfyugefyue","description":"description","platform":"android","category":"public"}'

Sample Request

{"appmeta" :{"path" : "/publisher/api/mobileapp/getfile/D3PdRxvU24WK3EN.apk", "package" : "home.jmstudios.calc", "version" : "1.0"},"name":"sample","provider":"admin","platform":"android","version":"1.0.0","banner":"/publisher/api/mobileapp/getfile/nzcYzFxpWpNHlyk.jpg","thumbnailUrl":"/publisher/api/mobileapp/getfile/nzcYzFxpWpNHlyk.jpg","screenshots":["/publisher/api/mobileapp/getfile/62gKWqOSvzu31IX.jpg"],"displayName":"fdyefyeufuegfyugefyue","description":"description","platform":"android","category":"public"}

Sample Response

HTTP/1.1 200 OK

Parameters

Type Name Description Schema Default
Path

appType

required

The App type (either Webapp/Mobile app).

String

Path

appId

required

**APP ID** consisting of the **UUID** of the App. The following combination is also accepted as a valid APP ID: the provider of the app, name of the app and the version. Should be formatted as **provider-name-version**.

String

Body

body

required

App object that needs to be added.

App (App)

Header

Content-Type

required

Media type of the entity in the body. Default is JSON.

String

JSON

Header

If-Match

optional

Validator for conditional requests; based on the ETag.

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on the Last Modified header.

String

Responses

HTTP Code Description Schema

200

OK. Successful response with updated App object.

App

400

Bad Request. Invalid request or validation error.

Error

403

Forbidden. The request must be conditional but no condition has been specified.

Error

404

Not Found. The resource to be updated does not exist.

Error

412

Precondition Failed. The request has not been performed because one of the preconditions is not met.

Error

Get subscribed user list for an App

Get subscribed user list for an App.

URL

http://apis.wso2.com/api/appm/publisher/v1.1/apps/{appType}/id/{appId}/subscriptions

HTTP Method

GET

Scope

appm:read

CURL Example

curl -X GET -H "Authorization: Bearer e099014668a524870c2895fe0595f125" "http://localhost:9763/api/appm/publisher/v1.1/apps/webapp/id/299a478a-0df3-488d-8677-8644f8255222/subscriptions"

Sample Response

{"userIds":["admin","user1","user2"]}

Parameters

Type Name Description Schema Default
Path

appType

required

The App type (either Webapp/Mobile app).

String

Path

appId

required

**APP ID** consisting of the **UUID** of the App. The following combination is also accepted as a valid APP ID: the provider of the app, name of the app and the version. Should be formatted as **provider-name-version**.

String

Header

Accept

optional

Media types acceptable for the response. Default is JSON.

String

JSON

Header

If-None-Match

optional

Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource.

String

Header

If-Modified-Since

optional

Validator for conditional requests; based on the Last Modified header of the formerly retrieved variant of the resource.

String

Responses

HTTP Code Description Schema

200

OK. Qualifying user list is returned.

UserIdList

400

Bad Request. Invalid request or validation error.

Error

403

Forbidden. The request must be conditional but no condition has been specified.

Error

404

Not Found. The resource to be updated does not exist.

Error

Create a new App

Create a new App

URL

http://apis.wso2.com/api/appm/publisher/v1.1/apps/{appType}

HTTP Method

POST

Scope

appm:create

CURL Example

curl -v -X POST 'http://localhost:9763/api/appm/publisher/v1.1/apps/mobileapp' -H "Content-Type: application/json" -d '{"appmeta" :{"path" : "/publisher/api/mobileapp/getfile/D3PdRxvU24WK3EN.apk", "package" : "home.jmstudios.calc", "version" : "1.0"},"name":"sample","provider":"admin","platform":"android","version":"1.0.0", "banner":"/publisher/api/mobileapp/getfile/9YRDRWqOSvzu31IX.jpg","thumbnailUrl":"/publisher/api/mobileapp/getfile/62gKWqOSvzu31IX.jpg","screenshots":["/publisher/api/mobileapp/getfile/62gKWqOSvzu31IX.jpg"],"displayName":"SampleDisplay","description":"sample calculator application","platform":"android","category":"Business",”marketType”:”enterprise”}'

Sample Request

{"appmeta" :{"path" : "/publisher/api/mobileapp/getfile/D3PdRxvU24WK3EN.apk", "package" : "home.jmstudios.calc", "version" : "1.0"},"name":"sample","provider":"admin","platform":"android","version":"1.0.0", "banner":"/publisher/api/mobileapp/getfile/9YRDRWqOSvzu31IX.jpg","thumbnailUrl":"/publisher/api/mobileapp/getfile/62gKWqOSvzu31IX.jpg","screenshots":["/publisher/api/mobileapp/getfile/62gKWqOSvzu31IX.jpg"],"displayName":"SampleDisplay","description":"sample calculator application","platform":"android","category":"Business",”marketType”:”enterprise”}

Sample Response

{"id" : "aff9fb92-7e17-4ce8-8024-a747ff5aea41"}

Parameters

Type Name Description Schema Default
Path

appType

required

The App type (either Webapp/Mobile app).

String

Body

body

required

App object that needs to be added.

App (App)

Header

Content-Type

required

Media type of the entity in the body. Default is JSON.

String

JSON

Header

If-Modified-Since

optional

Validator for conditional requests; based on the Last Modified header of the formerly retrieved variant of the resource.

String

Responses

HTTP Code Description Schema

201

Created. Successful response with the newly created object as the entity in the body. Location header contains the URL of the newly created entity.

App

400

Bad Request. Invalid request or validation error.

Error

415

Unsupported Media Type. The entity of the request was in an unsupported format.

Error

Get Plist

Get the plist file of the specified iOS (Apple) mobile app.

URL

http://apis.wso2.com/api/appm/publisher/v1.1/apps/mobile/getplist/tenant/{tenantId}/file/{fileName}

HTTP Method

GET

Scope

appm:read

CURL Example

Sample Response

Parameters

Type Name Description Schema Default
Path

tenantId

required

Tenant ID.

String

Path

fileName

required

The file name.

String

Header

Accept

optional

Media types acceptable for the response. Default is JSON.

String

JSON

Header

If-None-Match

optional

Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource.

String

Responses

HTTP Code Description Schema

200

OK.

PList

400

Bad Request. Invalid request or validation error.

Error

403

Forbidden. The request must be conditional but no condition has been specified.

Error

404

Not Found. The resource to be updated does not exist.

Error

Retrieving images, pdf and documents files

Retrieving images for banners, screenshots, etc.

URL

http://apis.wso2.com/api/appm/publisher/v1.1/apps/static-contents/{fileName}

HTTP Method

GET

Scope

appm:read

CURL Example

curl -X GET -H "Authorization: Bearer c7fff7b0307472345c8652d6595b1b1c" "http://localhost:9763/api/appm/publisher/v1.1/apps/static-contents/ZQCIsEEkYM2LJ9C.jpg?appType=mobileapp"

Sample Response

HTTP/1.1 200 OK

Parameters

Type Name Description Schema Default
Query

appType

required

The application type.

String

Path

fileName

required

The file name.

String

Header

If-Match

optional

Validator for conditional requests; based on the ETag.

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on the Last Modified header.

String

Responses

HTTP Code Description Schema

200

OK. Static content retrieved successfully.

file

400

Bad Request. Invalid request or validation error.

Error

404

Not Found. Requested entity does not exist.

Error

412

Precondition Failed. The request has not been performed because one of the preconditions is not met.

Error

Uploading images, pdf and document files

Uploading images for banners, screenshots etc.

URL

http://apis.wso2.com/api/appm/publisher/v1.1/apps/static-contents

HTTP Method

POST

Scope

appm:create

CURL Example

curl -X POST -H "Authorization: Bearer 0763d28a85f20d6fd8954f955859055c" -H "Content-Type: multipart/form-data" -F "file=@/home/user/sample.jpg" "http://localhost:9763/api/appm/publisher/v1.1/apps/static-contents?appType=webapp"

Sample Response

{"id": "ZQCIsEEkYM2LJ9C.jpg"}

Parameters

Type Name Description Schema Default
Query

appType

required

The application type.

String

Form

file

optional

Document to be uploaded.

File

Header

If-Match

optional

Validator for conditional requests; based on the ETag.

String

Header

If-Unmodified-Since

optional

Validator for conditional requests; based on the Last Modified header.

String

Responses

HTTP Code Description Schema

200

OK. Static content uploaded successfully.

StaticContent

400

Bad Request. Invalid request or validation error.

Error

404

Not Found. Requested entity does not exist.

Error

412

Precondition Failed. The request has not been performed because one of the preconditions is not met.

Error

Get all Apps mapped to a policy partial

Get a list of available Apps mapped to a policy partial.

URL

http://apis.wso2.com/api/appm/publisher/v1.1/xacmlpolicies/{policyPartialId}/apps/{appType}

HTTP Method

GET

Scope

appm:read

CURL Example

curl -X GET -H "Authorization: Bearer 04b1607a56c2d51adb35912943335322" -H "Content-Type: application/json" "http://localhost:9763/api/appm/publisher/v1.1/xacmlpolicies/2/apps/webapp"

Sample Response

{"previous":"","next":"","count":2,"appList":[{"name":"app1","context":null,"id":"af929140-1257-46ed-97c0-d26098e140e9","rating":0.0,"lifecycleState":"IN-REVIEW","provider":"admin","description":"asdasd","version":"1"},{"name":"app2","context":null,"id":"5c9c8551-d696-4c44-85a6-dcd86f1a1e25","rating":0.0,"lifecycleState":"CREATED","provider":"admin","description":"phone","version":"1.0"}]}

Parameters

Type Name Description Schema Default
Path

policyPartialId

required

Policy partial ID

Integer

Path

appType

required

The App type (either Webapp/Mobile app).

String

Query

limit

optional

Maximum size of resource array to return.

Integer

25

Query

offset

optional

Starting point within the complete list of items qualified.

Integer

0

Header

Accept

optional

Media types acceptable for the response. Default is JSON.

String

JSON

Header

If-None-Match

optional

Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource.

String

Responses

HTTP Code Description Schema

200

OK. List of qualifying Apps is returned.

AppList

400

Bad Request. Invalid request or validation error.

Error

403

Forbidden. The request must be conditional but no condition has been specified.

Error

404

Not Found. The resource to be updated does not exist.

Error