Assets Search

Save PDF

Last UpdatedJul 16, 2025
6 minute read

`Get Assets In Search Result Format`

Searches all assets and returns a list of asset Ids and their matched fields. Use this API to identify the fields in the asset that match your query string.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Search/Assets
?filter={filter}&skip={skip}&count={count}&orderBy={orderBy}&query={query}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

[optional] string filter
String used to filter the asset search results. Filter strings are not case sensitive. The strings on which you can filter results are limited to the asset AssetTypeName property and the asset metadata properties (using the syntax filter[property_name]:property_value).

[optional] integer skip
Parameter representing the zero-based offset of the first object to retrieve. If unspecified, a default value of 0 is used.

[optional] integer count
Parameter representing the maximum number of objects to retrieve. If unspecified, a default value of 100 is used.

[optional] string orderBy
Optional parameter which returns assets ordered either by the asset Id or the asset Name. Specify asc or desc to return the results in ascending or descending order. If not specified, the default is ascending order.

[optional] string query
Query identifier.

Response

Status Code	Body Type	Description
200	SearchResultsOfSearchResult	OK.
400	ErrorTemplate	Request is not valid. See the response body for additional details.
403	ErrorTemplate	Forbidden.
408	ErrorTemplate	Request Timeout.
503	ErrorTemplate	Service unavailable.

Example response body

200 Response

{
  "Count": 1,
  "Results": [
    {
      "MatchedProperties": [
        {
          "Field": "Name",
          "Value": "Asset Mine Truck 353e3cfe-f20b-4bef-b9c4-f75fbbdc0818"
        }
      ],
      "Id": "AssetId2b5f41ae-0929-4977-bfbd-1e046d8a66f4",
      "TypeId": "AssetMineTruckType",
      "Name": "Asset Mine Truck 353e3cfe-f20b-4bef-b9c4-f75fbbdc0818",
      "Description": "First mine truck used the mine diamond hands",
      "ETag": "1",
      "CreatedDate": "2021-05-26T19:05:33.8979442Z",
      "ModifiedDate": "2021-05-26T19:05:33.8979442Z",
      "LastModifiedDate": "2021-05-26T19:05:33.8979442Z"
    }
  ]
}

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

`List Faceted List Results`

Searches for assets using facets. Asset facets are not case-sensitive. Only asset metadata can be used in faceted searches.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Search/Assets/Facets
?count={count}&name={name}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

[optional] integer count
Parameter representing the maximum number of objects to retrieve. If unspecified, a default value of 100 is used.

[optional] string name
Name of the asset metadata for which you want to retrieve the facet values.

Response

Status Code	Body Type	Description
200	FacetResult[]	OK.
204	None	No assets match your query.
400	ErrorTemplate	Request is not valid. See the response body for additional details.
408	ErrorTemplate	Request Timeout.
503	ErrorTemplate	Service unavailable.

Example response body

200 Response

[
  {
    "Name": "Location",
    "FacetValues": [
      {
        "Value": "California",
        "DocumentCount": 2
      },
      {
        "Value": "Philly",
        "DocumentCount": 1
      }
    ]
  }
]

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

`Get Autocomplete Results`

Returns a list of suggested assets based on your search criteria. The autocomplete feature can be used with the following asset properties: Name, Description, AssetTypeName, and Metadata.

Request

GET /api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/Search/Assets/Autocomplete
?term={term}&termCount={termCount}&facetCount={facetCount}

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string term
Search term that you want to search for

integer termCount
Maximum number of facet autocompleted items to return. Default is 0.

integer facetCount
Maximum number of token autocompleted items to return. Default is 0.

Response

Status Code	Body Type	Description
200	SuggestionResults	Returns the suggestions
400	ErrorTemplate	Request is not valid. See the response body for additional details.
408	ErrorTemplate	Request Timeout.
503	ErrorTemplate	Service unavailable.

Example response body

200 Response

{
  "Facets": [
    {
      "Value": "trackUnit1",
      "FacetCategories": [
        {
          "Name": "track",
          "DocumentCount": 1
        }
      ]
    },
    {
      "Value": "t1000",
      "FacetCategories": [
        {
          "Name": "tractorNumber",
          "DocumentCount": 1
        }
      ]
    }
  ],
  "Tokens": [
    {
      "Value": "tracerround",
      "DocumentCount": 2
    },
    {
      "Value": "t1000",
      "DocumentCount": 1
    }
  ]
}

400 Response (ErrorTemplate)

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

Definitions

SearchResultsOfSearchResult

The set of search results matching search query.

Properties

Property Name	Data Type	Required	Nullable	Description
TotalCount	int32	false	false	The total number of items in the assets database that matches the search query. This may be more than the number of Results returned.
Results	[SearchResult]	false	true	The search results that corresponds to the current page.
ContinuationTokens	string[]	false	true	The list of continuation tokens. Each continuation token corresponds to a page of results.

{
  "Count": 1,
  "Results": [
    {
      "MatchedProperties": [
        {
          "Field": "Name",
          "Value": "Asset Mine Truck 353e3cfe-f20b-4bef-b9c4-f75fbbdc0818"
        }
      ],
      "Id": "AssetId2b5f41ae-0929-4977-bfbd-1e046d8a66f4",
      "TypeId": "AssetMineTruckType",
      "Name": "Asset Mine Truck 353e3cfe-f20b-4bef-b9c4-f75fbbdc0818",
      "Description": "First mine truck used the mine diamond hands",
      "ETag": "1",
      "CreatedDate": "2021-05-26T19:05:33.8979442Z",
      "ModifiedDate": "2021-05-26T19:05:33.8979442Z",
      "LastModifiedDate": "2021-05-26T19:05:33.8979442Z"
    }
  ]
}

SearchResult

Search results

Properties

Property Name	Data Type	Required	Nullable	Description
MatchedFields	[MatchedField]	false	true	A list of matched field objects. Each MatchedFields object contains the matched fields and their values.
Score	double	false	false	Calculated score of the match. For internal use.
Id	string	false	true	Identifier of the matched asset.
TypeId	string	false	true	Asset type identifier of the matched asset. If the asset does not have an asset type, then this field will be null.
Name	string	false	true	Name of the matched asset.
Description	string	false	true	Description of the matched asset. If the description of the matched asset is null, the description from the asset type is returned.
LastStatus	StatusData	false	true	Last status of the matched asset. If a status is not defined for the asset, this field will be null. If a status is defined, this field will correspond to Unknown, Good, Warning, or Bad.
ETag	string	false	true	Etag of the matched asset.
CreatedDate	date-time	false	false	Created date of the matched asset.
ModifiedDate	date-time	false	false	Modified date of the matched asset.
LastModifiedDate	date-time	false	false	Modified date of the matched asset.

{
  "TotalCount": 2,
  "Results": [
    {
      "MatchedFields": [
        {
          "Field": "Description",
          "Terms": [
            "searchedDescription"
          ]
        },
        {
          "Field": "Name",
          "Terms": [
            "searchedName"
          ]
        }
      ],
      "Score": 0.07410964510231982,
      "Id": "AssetsSearchDemo1",
      "Name": "SearchedName 1",
      "Description": "SearchedDescription 1",
      "ETag": "1",
      "CreatedDate": "2021-06-28T05:57:13.4249707Z",
      "ModifiedDate": "2021-06-28T05:57:13.4249707Z",
      "LastModifiedDate": "2021-06-28T05:57:13.4249707Z"
    },
    {
      "MatchedFields": [
        {
          "Field": "Description",
          "Terms": [
            "searchedDescription"
          ]
        },
        {
          "Field": "Name",
          "Terms": [
            "searchedName"
          ]
        }
      ],
      "Score": 0.062210717451675585,
      "Id": "AssetsSearchDemo2",
      "Name": "SearchResultName 2",
      "Description": "SearchResultDescription 2",
      "ETag": "6",
      "CreatedDate": "2021-06-28T05:57:13.5965826Z",
      "ModifiedDate": "2021-06-28T05:57:13.4249707Z",
      "LastModifiedDate": "2021-06-28T05:57:13.5965826Z"
    }
  ]
}

MatchedField

Matched fields. Includes the matched property and matched terms.

Properties

Property Name	Data Type	Required	Nullable	Description
Field	string	false	true	Matching property
Terms	string[]	false	true	Matching terms

"\"MatchedFields\": [\n{\n    \"Field\": \"Description\",\n    \"Terms\": [\n        \"searchedDescription\"\n    ]\n    },{\n    \"Field\": \"Name\",\n    \"Terms\": [\n        \"searchedName\"\n    ]\n}]"

StatusData

Status data that is assocated with asset.

Properties

Property Name	Data Type	Required	Nullable	Description
Index	any	false	true	Index which the status was last updated
Status	StatusEnum	false	false	Status enumeration. Valid values are: Unknown, Good, Warning and Bad.
Value	any	false	true	Value of the last data retrieved
DisplayName	string	false	true	Status display name

{
  "Index": "2019-01-02T00:00:00Z",
  "Status": "Warning",
  "Value": 2,
  "DisplayName": "AssetInWarning"
}

StatusEnum

Pre-defined asset status values.

Enumerated Values

Property	Value
Unknown	0
Good	1
Warning	2
Bad	3

ErrorTemplate

Properties

Property Name	Data Type	Required	Nullable	Description
OperationId	string	false	true	Operation identifier
Error	string	false	true	Error string
Resolution	string	false	true	Resolution string
Reason	string	false	true	Error reason string

{
  "OperationId": "string",
  "Error": "string",
  "Resolution": "string",
  "Reason": "string",
  "property1": null,
  "property2": null
}

FacetResult

Properties

Property Name	Data Type	Required	Nullable	Description
Name	string	false	true	None
FacetValues	[FacetValue]	false	true	None

{
  "Name": "string",
  "FacetValues": [
    {
      "Value": "string",
      "DocumentCount": 0
    }
  ]
}

FacetValue

Properties

Property Name	Data Type	Required	Nullable	Description
Value	string	false	true	None
DocumentCount	int32	false	false	None

{
  "Value": "string",
  "DocumentCount": 0
}

SuggestionResults

Properties

Property Name	Data Type	Required	Nullable	Description
Facets	[FacetSuggestion]	false	true	None
Tokens	[TokenSuggestion]	false	true	None

{
  "Facets": [
    {
      "Value": "string",
      "FacetCategories": [
        {
          "Name": "string",
          "DocumentCount": 0
        }
      ]
    }
  ],
  "Tokens": [
    {
      "Value": "string",
      "DocumentCount": 0
    }
  ]
}

FacetSuggestion

Properties

Property Name	Data Type	Required	Nullable	Description
Value	string	false	true	None
FacetCategories	[FacetCategory]	false	true	None

{
  "Value": "string",
  "FacetCategories": [
    {
      "Name": "string",
      "DocumentCount": 0
    }
  ]
}

FacetCategory

Properties

Property Name	Data Type	Required	Nullable	Description
Name	string	false	true	None
DocumentCount	int32	false	false	None

{
  "Name": "string",
  "DocumentCount": 0
}

TokenSuggestion

Properties

Property Name	Data Type	Required	Nullable	Description
Value	string	false	true	None
DocumentCount	int32	false	false	None

{
  "Value": "string",
  "DocumentCount": 0
}

CONNECT data services developer documentation

Assets Search

Get Assets In Search Result Format

Request

Parameters

Response

Example response body

List Faceted List Results

Request

Parameters

Response

Example response body

Get Autocomplete Results

Request

Parameters

Response

Example response body

Definitions

SearchResultsOfSearchResult

Properties

SearchResult

Properties

MatchedField

Properties

StatusData

Properties

StatusEnum

Enumerated Values

ErrorTemplate

Properties

FacetResult

Properties

FacetValue

Properties

SuggestionResults

Properties

FacetSuggestion

Properties

FacetCategory

Properties

TokenSuggestion

Properties

In This Topic

Related Links

`Get Assets In Search Result Format`

`List Faceted List Results`

`Get Autocomplete Results`