GetRules

post

https://{yourlidiaurl}/delivery/query/rules

Fetches detailed metadata, route coordinates, and current tracking state of the target rules.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The query request filtering constraints.

Query parameter filters defining constraints to search or list rule query.

ruleIds

array | null

Gets or sets the rule ids configuration value.

ruleIds

includeRuleIds

array | null

Gets or sets the include rule ids configuration value.

includeRuleIds

names

array of strings | null

Gets or sets the names configuration value.

names

includeNames

array of strings | null

Gets or sets the include names configuration value.

includeNames

excludeNames

array of strings | null

Gets or sets the exclude names configuration value.

excludeNames

codes

array of strings | null

Gets or sets the codes configuration value.

codes

includeCodes

array of strings | null

Gets or sets the include codes configuration value.

includeCodes

excludeCodes

array of strings | null

Gets or sets the exclude codes configuration value.

excludeCodes

applicationIP

string | null

Gets or sets the application ip configuration value.

userToken

string | null

Gets or sets the user token configuration value.

sessionId

string | null

The unique database identifier linking this record to the target session.

userId

string

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

The unique database identifier linking this record to the target user.

userIP

string | null

Gets or sets the user ip configuration value.

envelope

string | null

Gets or sets the envelope configuration value.

threadId

string | null

A correlation token used to track logs across async thread transitions.

includes

array of strings | null

Gets or sets the includes configuration value.

includes

searchKey

string | null

Gets or sets the search key configuration value.

pageIndex

string

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

Gets or sets the page index configuration value.

pageSize

string

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

Gets or sets the page size configuration value.

sorting

string | null

Gets or sets the sorting configuration value.

prefix

string | null

Gets or sets the prefix configuration value.

status

array of objects | null

The current lifecycle state of the delivery task or courier agent.

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

Credentials

Bearer

JWT

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

200An IActionResult indicating the operation outcome.