GBDX

Lesson: Vector Services General Searching

The workflow of API requests in which a user sends when using the Vector Services

Basic General Search

Don't know what you're looking for? To get a good idea about what vectors are available in a given area, start with the basic search. The basic search takes the user step-by-step through the process of seeing what vector items they might want to retrieve. From a basic search, the user must progress through the vector ingest source and the vector item type prior to viewing vector items. If at any point, there is a more specific focus, simply switch from the basic search to querying, either by term alone, or the more specific item type and term. If what you are looking for is specific to an index, the faster and more concise method of returning vector results is through index queries.

Step 1: List Vector Ingest Sources

If the user is just browsing, the best way to get a sense for the results is to see what ingest sources exist within the chosen area of interest (aoi). This is a basic call, and will return available ingest sources based on both the user's account permissions and the given aoi. This means that users who do not have permissions to see certain ingest sources will not see those ingest sources within the Vector Services even if said ingest sources do exist within the aoi.

Step 2: List Vector Item Types

After viewing the ingest sources available within the aoi, the user can then dig into each ingest source for the item types available. Each ingest source has different item types available.

Step 3: List Vector Items OR Get Paging ID

Now that the user has seen the ingest sources and the item types of interest, they can begin the process of gaining the actual vector items, based on the vector item type they select. This process is split at this point, based on the results. If there are less than 1000 vector items to retrieve, the user can safely run a request to simply get the vector items in one go.

However, if there are more than 1000 vector items to retrieve, the user must use paging to retrieve the results. The List Vector Items api call is restricted to 1000 items or less, regardless of whether the user includes the count parameter.

For simplicity, if the user is unsure of whether there are less than 1000 vector items to retrieve, it is best to use the paging request instead.

Step 4: Retrieve Page of Vector Items

After acquiring the paging ID in the last step, the user can then begin paging requests to retrieve all of the resulting vector items they want. Paging is the preferred method of returning vector items, and more often than not the user will need to follow all four steps to acquire everything they need from the Vector Services.

Step 5: Download Vector Items

If the user is satisfied with what they see in the retrieved vector items, the user is able to download the vector items as json for use in other applications.

General Search by Term

Have an idea of what you're looking for? Querying is a more streamlined way of returning the vector items the user is looking for. Searching by term does not require the user to know anything beyond the basic concept of what they are looking for, and the only results returned will match that query. For the item type and term variation of the Vector Services query, go here.

Don't know what you're looking for? Start with a basic search.

If what you are looking for is specific to an index, the faster and more concise method of returning vector results is through index queries.

For more information on querying and query construction, check the Query Syntax, Fields, and Item Type Suffixes page and Vector Services Example Query Constructions page.

Step 1: List Vector Items OR Get Paging ID

Since the user already has an idea of what they are searching for, they can immediately begin the process of gaining the actual vector items. This process is split based on several factors. The first of which is a division based on the number of vector items to retrieve; if there are less than 1000 vector items, the user can safely run a request to simply get the vector items in one go. This request does allow the user to either retrieve the vectors with the default fields, or the user can select the fields to return.

However, if there are more than 1000 vector items to retrieve, the user must use paging to retrieve the results. The List Vector Items api call is restricted to 1000 items or less, regardless of whether the user includes the count parameter.

For simplicity, if the user is unsure of whether there are less than 1000 vector items to retrieve, it is best to use the paging request instead.

Step 2: Retrieve Page of Vector Items

After acquiring the paging ID, the user can then begin paging requests to retrieve all of the resulting vector items they want. Paging is the preferred method of returning vector items, and more often than not the user will need to follow both steps to acquire everything they need from the Vector Services.

Step 3: Download Vector Items

If the user is satisfied with what they see in the retrieved vector items based on their query, the user is able to download the vector items as json for use in other applications.

General Search by Item Type and Term

Have an idea of what you're looking for? Querying is a more streamlined way of returning the vector items the user is looking for. Searching by item type and term does not initially require the user to know anything beyond the basic concept of what they are looking for, and the user may then narrow down results based on item type. For the term variation of the Vector Services query, go here.

Don't know what you're looking for? Start with a basic search.

If what you are looking for is specific to an index, the faster and more concise method of returning vector results is through index queries.

For more information on querying and query construction, check the Query Syntax, Fields, and Item Type Suffixes page and Vector Services Example Query Constructions page.

Step 1: List Vector Item Types

Since the user has an idea of what they are searching for, they can begin with a query for a term to see what item types are available.

Step 2: List Vector Items OR Get Paging ID

Now that the user has seen the item types of interest, they can begin the process of gaining the actual vector items, based on the vector item type they select. This process is split based on several factors. The first of which is a division based on the number of vector items to retrieve; if there are less than 1000 vector items, the user can safely run a request to simply get the vector items in one go. This request does allow the user to either retrieve the vectors with the default fields, or the user can select the fields to return.

However, if there are more than 1000 vector items to retrieve, the user must use paging to retrieve the results. The List Vector Items api call is restricted to 1000 items or less, regardless of whether the user includes the count parameter.

For simplicity, if the user is unsure of whether there are less than 1000 vector items to retrieve, it is best to use the paging request instead.

Step 3: Retrieve Page of Vector Items

After acquiring the paging ID, the user can then begin paging requests to retrieve all of the resulting vector items they want. Paging is the preferred method of returning vector items, and more often than not the user will need to follow all three steps to acquire everything they need from the Vector Services.

Step 4: Download Vector Items

If the user is satisfied with what they see in the retrieved vector items based on their query, the user is able to download the vector items as json for use in other applications.