GetCategories

post

https://{yourapiurl}/api/v1/query/categories

Gets the categories based on the provided query.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The category query.

Maps to Lidia.MetaData.API.Models.Queries.Live.CategoryQuery

categoryIds

array of int32s or int32s | null

categoryIds

names

array of strings | null

names

includesNames

array of strings | null

includesNames

excludesNames

array of strings | null

excludesNames

codes

array of strings | null

codes

integrationCodes

array of strings | null

integrationCodes

dimensionIds

array of int32s or int32s | null

dimensionIds

includeFullNames

boolean

clientId

string | null

required

Gets or sets the client identifier for the requesting application.

appKey

string | null

required

Gets or sets the application key used for authentication.

pageIndex

int32 | int32 | null

^-?(?:0|[1-9]\d*)$

Gets or sets the zero-based page index.

pageSize

int32 | int32 | null

^-?(?:0|[1-9]\d*)$

Gets or sets the number of items per page.

sorting

string | null

Gets or sets the sorting expression.

threadId

string | null

Gets or sets the trace identifier used for request logging.

status

array of objects | null

Gets or sets the status values used to filter results.

status

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200The list of categories.