Get documentations

GET

https://app.hustro.com/api/v2/project/{projectId}/documentation

OperationId:getDocumentations

Get all documentation from a project. This shows the data of all the files from the Documentation Module.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Header Params

Responses

🟢200OK

application/json

successful operation

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://app.hustro.com/api/v2/project//documentation?offset={{offset}}&size={{size}}' \
--header 'hustro-client: m2m' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Response Example

{
    "items": [
        {
            "_id": "string",
            "deleted": true,
            "createdAt": "string",
            "createdBy": "string",
            "modifiedAt": "string",
            "modifiedBy": "string",
            "name": "string",
            "number": "string",
            "parentId": "string",
            "versions": [
                {
                    "_id": "string",
                    "deleted": true,
                    "createdAt": "string",
                    "createdBy": "string",
                    "modifiedAt": "string",
                    "modifiedBy": "string",
                    "remoteVersionId": "string",
                    "uploadStatus": "string",
                    "extension": "string",
                    "imageConvertStatus": "string"
                }
            ]
        }
    ],
    "syncKey": "string",
    "entitiesWithoutAccess": [
        "string"
    ],
    "hasMore": true,
    "totalCount": 0
}

Create documentation

Update documentation