Resource

Search resources

get/api/resource/search/

Request

  • Base URL: https://demo.nextgis.ru (the document declares no server; this is the origin it was published from)
  • URL: https://demo.nextgis.ru/api/resource/search/
  • Auth: none declared

Query parameters

serialization'full' | 'resource'

Resource serialization mode

If set to full, all resource keys are returned, but this is significantly slower. Otherwise, only the resource key is serialized.

breadcrumbboolean

Include breadcrumb paths for returned resources

limitinteger

Maximum number of resources to return

offsetinteger

Number of resources to skip

orderstring[]

Ordering tokens. Supported fields: name, type, owner, created. Use '-' prefix for descending order, e.g. '-created'.

rootinteger

Starting resource ID for recursive search

parent_id__recursiveinteger

Use root instead

idinteger

Filter by exact ID

id__eqinteger

Use id instead

id__ininteger[]

Filter by list of IDs

clsstring

Filter by exact type

cls__eqstring

Use cls instead

cls__likestring

Filter by type pattern with case sensitivity

cls__ilikestring

Filter by type pattern without case sensitivity

cls__instring[]

Filter by list of types

parentinteger

Filter by exact parent ID

parent__ininteger[]

Filter by list of parent IDs

parent_idinteger

Use parent instead

parent_id__eqinteger

Use parent instead

parent_id__ininteger[]

Use parent__in instead

keynamestring

Filter by exact keyname

keyname__eqstring

Use keyname instead

keyname__instring[]

Filter by list of keynames

display_namestring

Filter by exact display name

display_name__eqstring

Use display_name instead

display_name__likestring

Filter by display name pattern with case sensitivity

display_name__ilikestring

Filter by display name pattern without case sensitivity

display_name__instring[]

Filter by list of display names

owner_userinteger

Filter by owner user ID

Example:4
owner_user__ininteger[]

Filter by list of owner user IDs

[
  4
]
owner_user_idinteger

Use owner_user instead

Example:4
owner_user_id__eqinteger

Use owner_user instead

Example:4
owner_user_id__ininteger[]

Use owner_user__in instead

[
  4
]
resmeta__hasobject

Filter by the presence of metadata keys

If true, only resources that include the specified metadata key will be returned. If false, only resources that do not contain the key will be returned.

resmeta__jsonobject

Filter by metadata values

Values should be JSON-encoded, e.g., "foo" for a string match, 42 for a number match, and true for a boolean match.

resmeta__likeobject

Filter by metadata value pattern with case sensitivity

resmeta__ilikeobject

Filter by metadata value pattern without case sensitivity

Response

List of resources matching the search criteria

OR

Changes

No recorded changes to this operation across all 1 revision of this API.