Public Web API: Get a list of report items

Request

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

Path parameters

Parameter name	Value	Description	Additional
namespace	string	Workspace code	Required
code	string	Report code	Required

Request body

The resource sent in the request body is Get a list of report items — Request. It contains the following writable properties:

{
    "filter": {
        "<key>": {}
    },
    "from": "uint32",
    "size": "uint32",
    "sortExpressions": [
        {
            "ascend": "boolean",
            "column": "string"
        }
    ]
}

Properties

Name	Type	Description	Additional
filter	object	Filtering (only "Table Operation")	Optional
filter.<key>	map of object		Optional
from	uint32	Return starting from item	Optional
size	uint32	Number of returned items (10000 max)	Optional
sortExpressions[]	array	Sorting rules	Optional
sortExpressions[].ascend	boolean	Ascending sorting order flag	Optional
sortExpressions[].column	string	Sorting column	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 a list of report items	Model of a list of report items (Get a list of report items)