VaultQueryBean

Name VaultQueryBean
Usage HandcarAuthorizationService
getVaultsByQueryParams
Type Complex

Description

A bean for querying a vault

OSID reference: VaultQuery

Structure Definition

ShortName Name Type Description Required? Read only? Implementation Notes
ids Ids StringList Ids to filter      
genusTypeIds Genus Type Ids StringList Ids of genus types to do the filtering      
keyword Keyword String Keyword or phrase used to query an object      
addedBys Added Bys StringList Audit Trail Ids of people who added object to do the filtering      
addedOnStartDate Added On Start Date String Audit Trail start date to filter on when the object was created

Expected to be in one of the following formats:

  1. YYYY-MM-DDTHH:MM:SSZ

  2. YYYY-MM-DDTHH:MM:SS

  3. YYYY-MM-DDTHH:MM

  4. YYYY-MM-DDTHH

  5. YYYY-MM-DD
      
addedOnEndDate Added On End Date String Audit Trail end date to filter on when the object was created

Expected to be in one of the following formats:

  1. YYYY-MM-DDTHH:MM:SSZ

  2. YYYY-MM-DDTHH:MM:SS

  3. YYYY-MM-DDTHH:MM

  4. YYYY-MM-DDTHH

  5. YYYY-MM-DD
      
updatedBys Added On Start Date StringList Audit Trail ids of people who last updated the object      
updatedOnStartDate Updated On Start Date String Audit Trail start date to filter on when the object was last updated

Expected to be in one of the following formats:

  1. YYYY-MM-DDTHH:MM:SSZ

  2. YYYY-MM-DDTHH:MM:SS

  3. YYYY-MM-DDTHH:MM

  4. YYYY-MM-DDTHH

  5. YYYY-MM-DD
      
updatedOnEndDate Updated On End Date String Audit Trail end date to filter on when the object was last updated

Expected to be in one of the following formats:

  1. YYYY-MM-DDTHH:MM:SSZ

  2. YYYY-MM-DDTHH:MM:SS

  3. YYYY-MM-DDTHH:MM

  4. YYYY-MM-DDTHH

  5. YYYY-MM-DD
      
startAt Start At Integer The select row to start at before returning.

This defaults to 1 if not specified and will return starting at the first row.

Start At and Max Values are the final filters to be applied to a method that returns a list of
objects.		      
maxValues Maximum Values Integer Maximum number of values (objects) to return from the method

If used in conjunction with startAt ti can be used to perform paging.

Start At and Max Values are the final filters to be applied to a method that returns a list of
objects.		      

JSON Structure

{
     "type" : "VaultQuery",
     "ids" : ["id", ...],
     "genusTypeIds" : ["id", ...],
     "keyword" : "XXXX",
     "addedBys" : ["XXXX", ...],
     "addedOnStartDate" : "YYYY-MM-DD",
     "addedOnEndDate" : "YYYY-MM-DD",
     "updatedBys" : ["XXXX", ...],
     "updatedOnStartDate" : "YYYY-MM-DD",
     "updatedOnEndDate" : "YYYY-MM-DD",
     "startAt" : 999,
     "maxValues" : 999
}