AppDocumentsApi


Retrieving document

Retrieving the document.

URL

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

HTTP Method

GET

Scope

appm:read

CURL Example

curl -X GET -H "Authorization: Bearer 4fc0a364a336a37c663790364da307a3" "http://localhost:9763/api/appm/store/v1.1/apps/webapp/id/a7a7dacc-8a1c-428e-930d-d181f60f14bd/docs/6d47f5d5-f046-47e9-a65d-6eb50d5cd05e"

Sample Response

HTTP/1.1 200 OK Content-Type: application/json { "sourceType": "INLINE", "sourceUrl": null, "otherTypeName": null, "documentId": "0bcb7f05-599d-4e1a-adce-5cb89bfe58d5", "summary": "This is a sample documentation", "name": "PhoneVerification Documentation", "type": "HOWTO" }

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