Request

POST /pub/v1/app/{namespace}/{code}/list

Path parameters

Parameter name Value Description Additional
namespace string

Workspace Code

Required
code string

App Code

Required

Request body

The request body takes a complete resource  Get list of app items - Request. Containing the following writable properties:

{
    "active": "boolean",
    "filter": {
        "<key>": {}
    },
    "from": "int64",
    "ids": [
        "uuid"
    ],
    "size": "int64",
    "sortExpressions": [
        {
            "ascending": "boolean",
            "field": "string"
        }
    ],
    "statusCode": [
        "string"
    ],
    "statusGroupId": "uuid"
}

Properties

Name Type Description Additional
active boolean

Show active only (not deleted)

Optional.
filter object

Filtering

Optional.
filter.<key> map of object Optional.
from int64

Return from item

Optional.
ids[] array of uuid

ID filtering

Optional.
size int64

Number of items returned (maximum 100)

Optional.
sortExpressions[] array

Sorting rules

Optional.
sortExpressions[].ascending boolean

Sort ascending flag

Optional.
sortExpressions[].field string

Sort field

Optional.
statusCode[] array of string

Show items with certain statuses

Optional.
statusGroupId uuid

Show items of a particular status group

Optional.

Authorization

This request requires the use of one of following authorisation methods: API key

Response

The following HTTP status codes may be returned.

Status code Description Resource
200 OK

Model of an app item list.

Model of an app item list (Get list of app items)