MetadataDiscoveryResource
Jersey Resource for metadata operations.
The following resources are applicable:
/discovery/search
GET
Search using a given query.
Parameters
name | description | type | default |
---|---|---|---|
query | search query in DSL format falling back to full text. | query | |
limit | number of rows to be returned in the result, used for pagination. maxlimit > limit > 0. -1 maps to atlas.search.defaultlimit property value | query | -1 |
offset | offset to the results returned, used for pagination. offset >= 0. -1 maps to offset 0 | query | -1 |
Response Body
element: | (custom) |
media types: | application/json |
JSON representing the type and results.
/discovery/search/dsl
GET
Search using query DSL format.
Parameters
name | description | type | default |
---|---|---|---|
query | search query in DSL format. | query | |
limit | number of rows to be returned in the result, used for pagination. maxlimit > limit > 0. -1 maps to atlas.search.defaultlimit property value | query | -1 |
offset | offset to the results returned, used for pagination. offset >= 0. -1 maps to offset 0 Limit and offset in API are used in conjunction with limit and offset in DSL query Final limit = min(API limit, max(query limit - API offset, 0)) Final offset = API offset + query offset | query | -1 |
Response Body
element: | (custom) |
media types: | application/json |
JSON representing the type and results.
/discovery/search/fulltext
GET
Search using full text search.
Parameters
name | description | type | default |
---|---|---|---|
query | search query. | query | |
limit | number of rows to be returned in the result, used for pagination. maxlimit > limit > 0. -1 maps to atlas.search.defaultlimit property value | query | -1 |
offset | offset to the results returned, used for pagination. offset >= 0. -1 maps to offset 0 | query | -1 |
Response Body
element: | (custom) |
media types: | application/json |
JSON representing the type and results.
/discovery/search/gremlin
GET
Search using raw gremlin query format.
Parameters
name | description | type | default |
---|---|---|---|
query | search query in raw gremlin format. | query |
Response Body
element: | (custom) |
media types: | application/json |
JSON representing the type and results.