List Resources

Lists your dynamic resources.

The List Resources API returns a list of your dynamic resources. The response includes the name, flavor, and type of the indexes that you have created using the Create Text Index API. The response also includes the connectors that you have created using the Create Connector API.

You can optionally specify a type to return a list of your resources that have that type. You can also specify a flavor to return a list of your indexes or connectors that have that flavor.

Quick Start

A call to the List Resources API with just the APIKey parameter returns all the indexes and connectors that you have created, as well the public indexes.

/1/api/[sync|async]/listresources/v1

The response object contains JSON with an array of public resources and an array of private resources, listing the name, flavor, subtype, and type of the resources.

{
  "public_resources": [
    {
      "resource": "wiki_eng",
      "description": "Wikipedia in English",
      "type": "content"
    },
    {
      "resource": "wiki_fra",
      "description": "Wikipedia in French",
      "type": "content"
    },
    ...
  ],
  "private_resources": [
    {
      "resource": "myindex",
      "type": "content",
      "flavor": "standard",
      "description": "My index description",
      "date_created": "Mon Mar 10 2014 19:29:47 GMT+0000 (UTC)"
    },
    {
      "resource": "myconnector",
      "type": "connector",
      "flavor": "web",
      "description": "My connector description",
      "date_created": "Mon Mar 10 2014 19:29:47 GMT+0000 (UTC)"
    },
    {
      "resource": "myqueryprofile",
      "type": "query_profile",
      "flavor": null,
      "description": "My query profile description",
      "date_created": "Mon Mar 10 2014 19:29:47 GMT+0000 (UTC)"
    }
  ]
}

Tip: You can also view a list of your private text indexesby using the Text Indexes Account page.

Synchronous
https://api.havenondemand.com/1/api/sync/listresources/v1
Asynchronous
https://api.havenondemand.com/1/api/async/listresources/v1
Authentication

This API requires an authentication token to be supplied in the following parameter:

Parameter Description
apikey The API key to use to authenticate the API request.
Parameters

This API accepts the following parameters:

Optional
Name Type Description
flavor
array<enum> A list of specific resource configurations to return.
type
array<enum> A list of resource groups to return.
Enumeration Types

This API's parameters use the enumerations described below:

flavor
A list of specific resource configurations to return.
standard Standard Text Index Flavor
Standard text indexes that store document content.
explorer Explorer Text Index Flavor
Small text indexes that store document content.
categorization Categorization Text Index Flavor
Text indexes that store categories for use with the Categorize Documents API.
custom_fields Custom Fields Text Index Flavor
Text indexes that store additional custom fields for your documents.
querymanipulation Query Manipulation Text Index Flavor
Text indexes that store query manipulation rules for use with query profiles.
jumbo Jumbo
Jumbo Text Index Flavor
web_cloud Web Cloud Connector
Cloud flavor connectors that retrieve content from Websites.
dropbox_cloud Cloud DropBox Connector.
Cloud flavor connectors that retrieve content from Dropbox.
exchange_cloud Exchange Cloud Connector
Cloud flavor connectors that retrieve content from Exchange Online mailboxes.
imap_cloud IMAP Cloud Connector
A cloud-based connector for retrieving content from your IMAP mailboxes.
jive_cloud Jive Cloud Connector
A cloud-based connector for retrieving content from your Jive community.
sharepoint_cloud Cloud SharePoint Connector
OCloud flavor connectors that retrieve content from SharePoint.
twitter_cloud Cloud Twitter Connector.
Cloud flavor connectors that retrieve content from Twitter.
web_onsite OnSite Web Connector.
An onsite connector for retrieving content from Web pages.
filesystem_onsite File System Onsite Connector
Onsite flavor connectors that retrieve content from file systems.
sharepoint_onsite OnSite Sharepoint Connector
Onsite flavor connectors that retrieve content from SharePoint Remote servers.
type
A list of resource groups to return.
content Content
Text indexes store content of documents, categories, and query manipulation rules.
connector Connector
Connectors extract content from external systems and repositories.
query_profile Query Profiles
Query profiles configure query manipulations.
schedule Schedule
Schedule resource.
prediction_model Prediction Model
Deprecated - will not match any resources.
file_container File Containers
File container resource.

This API returns a JSON response that is described by the model below. This single model is presented both as an easy to read abstract definition and as the formal JSON schema.

Asynchronous Use

Additional requests are required to get the result if this API is invoked asynchronously.

You can use /1/job/status/<job-id> to get the status of the job, including results if the job is finished.

You can also use /1/job/result/<job-id>, which waits until the job has finished and then returns the result.

Model
This is an abstract definition of the response that describes each of the properties that might be returned.
List Resources Response {
private_resources ( array[Private_resources] ) A list of private resources.
public_resources ( array[Public_resources] ) A list of public resources.
}
List Resources Response:Private_resources {
date_created ( string ) The date the resource was created.
description ( , optional) The description of the resource.
flavor ( , optional) The flavor of the resource.
resource ( string ) The resource name.
type ( string ) The type of resource.
display_name ( , optional) A friendly name for the resource.
}
List Resources Response:Public_resources {
description ( string , optional) The description of the resource.
resource ( string ) The resource name.
type ( string ) The type of resource.
display_name ( string , optional) The friendly name of the resource.
}
Model Schema
This is a JSON schema that describes the syntax of the response. See json-schema.org for a complete reference.
{
    "properties": {
        "private_resources": {
            "items": {
                "properties": {
                    "date_created": {
                        "type": "string"
                    },
                    "flavor": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "resource": {
                        "type": "string"
                    },
                    "type": {
                        "type": "string"
                    },
                    "display_name": {
                        "type": [
                            "string",
                            "null"
                        ]
                    }
                },
                "required": [
                    "resource",
                    "type",
                    "date_created"
                ],
                "type": "object"
            },
            "type": "array"
        },
        "public_resources": {
            "items": {
                "properties": {
                    "resource": {
                        "type": "string"
                    },
                    "type": {
                        "type": "string"
                    },
                    "display_name": {
                        "type": "string"
                    }
                },
                "required": [
                    "resource",
                    "type"
                ],
                "type": "object"
            },
            "type": "array"
        }
    },
    "required": [
        "private_resources",
        "public_resources"
    ],
    "type": "object"
}
https://api.havenondemand.com/1/api/sync/listresources/v1
/api/api-example/1/api/sync/listresources/v1
Examples
See this API for yourself - select one of our examples below.
List public indexes
Show generally available public indexes.
Parameters
Optional
Name Type Value
flavor
array
type
array


Async – Response An error occurred making the API request
Response Code:
Response Body

	
Making API Request…
Checking result of job

To try this API with your own data and use it in your own applications, you need an API Key. You can create an API Key from your account page - API Keys.

Output Refresh An error occurred making the API request View Input
Rendered RawHtml Response
Result Display
Response Code:
Response Body:

			
Make this call with curl


If you would like to provide us with more information then please use the box below:

We will use your submission to help improve our product.