CustomQuery
  • 23 May 2023
  • 1 Minute to read
  • Contributors
  • Dark
    Light

CustomQuery

  • Dark
    Light

Article summary


 GET   /customquery


Run and return the results of a custom query configured in VisualVault.

Query Parameters
ParameterTypeDescription
queryNameStringName of the custom query.
filterStringString containing a valid query filter.
valueStringQuery search value.
offsetStringSets an offset to the start of the search.
sortStringThe name of a data column to sort by.
sortDirStringSort direction.
  • asc: Ascending order
  • desc: Descending order
qStringA VisualVault REST API Data Query.
paramsStringList of query parameters.
Response Codes
CodeDescription
400Bad Request
404Not Found


 GET   /customquery/{id}


Run and return the results of a custom query configured in VisualVault by ID.

Route Parameters
ParameterTypeDescription
id*GuidThe custom query id.
Query Parameters
ParameterTypeDescription
filterStringString containing a valid query filter.
offsetStringSets an offset to the start of the search.
sortStringThe name of a data column to sort by.
sortDirStringSort direction.
  • asc: Ascending order
  • desc: Descending order
qStringA VisualVault REST API Data Query.
paramsStringList of query parameters.
Response Codes
CodeDescription
400Bad Request
404Not Found


 GET   /customquery/querydependency/{id}


No Description.

Route Parameters
ParameterTypeDescription
id*GuidThe custom query id.
Query Parameters
ParameterTypeDescription
sourceTypeStringDropdown list source type.
  • UserQuery
  • GroupQuery
  • VisualVaultDropDownList
  • CustomQuery
  • Image
hashonlyBoolReturn only a hash code.
Response Codes
CodeDescription
400Bad Request


 GET   /customquery/imagedependency/{id}


No Description.

Route Parameters
ParameterTypeDescription
id*GuidThe custom query id.
Query Parameters
ParameterTypeDescription
imageSourceTypeStringImage source.
  • ImageLibrary
  • DocumentLibrary
  • MarketPlaceImageLibrary
Response Codes
CodeDescription
400Bad Request


 GET   /customquery/smalldependencies


No Description.

No Parameters.

Response Codes
CodeDescription
400Bad Request

Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence