GetDocumentsByPrefix

post

https://{yourlidiaurl}/document/query/documentsbyprefix

Retrieves the specified DocumentsByPrefix record.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

prefixes

array of strings | null

Gets or sets the list.

prefixes

typeCode

string | null

Gets or sets the unique alphanumeric code representing the entity.

documentTypeGroup

string

enum

Allowed values: Image (0), Video (10), BinaryFile (20), StringFile (30), Audio (40).

Allowed:

ignoreAccent

boolean

Gets or sets the ıgnore accent.

environment

string | null

Gets or sets the environment name.

applicationIP

string | null

Gets or sets the application IP address.

tenantId

string

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

Gets or sets the tenant identifier.

userToken

string | null

Gets or sets the user token.

sessionId

string | null

Gets or sets the session identifier.

userId

string

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

Gets or sets the user identifier.

userIP

string | null

Gets or sets the user IP address.

envelope

string | null

Gets or sets the envelope.

threadId

string | null

Gets or sets the thread identifier.

includes

array of strings | null

Gets or sets the list of related tables/entities to include.

includes

searchKey

string | null

Gets or sets the search key.

pageIndex

string

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

Gets or sets the page index.

pageSize

string

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

Gets or sets the page size.

sorting

string | null

Gets or sets the sorting field name.

status

array of objects | null

Gets or sets the status.

status

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

200

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here!