APPDocumentApi


Get App Documents

Get a list of documents belonging to an App.

URL

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

HTTP Method

GET

Scope

appm:read

CURL Example

curl -H "Authorization: Bearer b0982cd2aacd463ff5f63cd5ebe58f4a" "http://localhost:9763/api/appm/publisher/v1.1/apps/webapp/id/0950b09c-0afe-47f2-88d6-72e9b88b1931/docs"

Sample Response

HTTP/1.1 200 OK Content-Type: application/json { "previous": "", "list": [ { "sourceType": "INLINE", "sourceUrl": null, "otherTypeName": null, "documentId": "0bcb7f05-599d-4e1a-adce-5cb89bfe58d5", "summary": "This is a sample documentation for v1.0.0", "name": "PhoneVerification App Documentation", "type": "HOWTO" }, { "sourceType": "URL", "sourceUrl": "http://wiki.cdyne.com/index.php/Phone_Verification", "otherTypeName": null, "documentId": "4145df31-04f1-440c-8d08-68952874622c", "summary": "This is the URL for online documentation", "name": "Online Documentation", "type": "SAMPLES" } ], "next": "", "count": 2 }

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

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. Document list is returned.

DocumentList

304

Not Modified. Empty body because the client already has the latest version of the requested resource.

404

Not Found. Requested resource does not exist.

Error

406

Not Acceptable. The requested media type is not supported.

Error