POST
https://api.blockv.io/v1/vatom/discoverOverview
With the discover endpoint you can search for vAtoms which you are allowed to see (either because you own them or their visibility is set to public).
Search vAtoms Request
HTTP Headers
application/json
{app_id}
Payload Details
| Name | Type | Description |
|---|
scope | object | Scope filters the vatoms according to the key and value pair of the object |
limit | int | The max. number of records that are returned per page (default 100) |
page | int | The number of the page that should be deplayed |
[filter] | array | Collection of filters |
return | object | Response configuration |
Scope Object
| Name | Type | Description |
|---|
key | string | The key that is applied to filter the vAtoms |
value | string | List of values used to filter the vAtoms |
Valid Scope Keys
vAtom::vAtomType.ownervAtom::vAtomType.templatevAtom::vAtomType.template_variationvAtom::vAtomType.acquirablevAtom::vAtomType.parent_id
Scope Value
Up to 5 comma separated scope values are allowed. They or combined by an OR operator.
$currentuser is a special value that gets replaced by the currently logged in users ID.
Filter Elements
| Name | Type | Description |
|---|
field | string | The field that is used in the filter |
filter_op | string | The filter operation |
value | string | The value to which the field content is compared |
bool_op | string | Boolean operator that is used to combine two filter elements (
And
,
Or
) |
Supported fields
- vAtom::vAtomType.publisher_fqdn
- vAtom::vAtomType.template
- vAtom::vAtomType.template_variation
- vAtom::vAtomType.owner
- vAtom::vAtomType.author
- vAtom::vAtomType.parent_id
- vAtom::vAtomType.category
- vAtom::vAtomType.in_contract
- vAtom::vAtomType.visibility_type
Supported filter operations
Eq equalsGe greater or equal toGt greater thanLe less or equal toLt less thanNe not equal toMatch field contains value
Return Object
| Name | Type | Description |
|---|
type | string | Currently only
*
is supported, which returns the whole object. |
{
"scope": {
"key": "vAtom::vAtomType.owner",
"value": "$currentuser"
},
"filters": [
{
"filter_elems": [
{
"field": "vAtom::vAtomType.template",
"filter_op": "Match",
"value": "publisher_fqdn*",
"bool_op": "And"
},
{
"field": "vAtom::vAtomType.parent_id",
"filter_op": "Match",
"value": "*",
"bool_op": "And"
}
]
}
],
"return": {
"type": "*",
}
}
Search vAtoms Response
Return & Error Codes
| Error | Type | Description |
|---|
200 | http | Everything is OK |
403 | http | Not Authorized |