Search

API that returns information about the streams that are shared with communities

List Streams By Community

Searches for streams within a community by query

Request

GET /api/v1-preview/search/communities/{communityId}/streams
?query={query}&skip={skip}&count={count}&pageSize={pageSize}&maxPages={maxPages}&continuationToken={continuationToken}&orderBy={orderBy}

Parameters

string communityId
Community identifier

[optional] string query
Query to execute. The query uses the same format as SDS. See Search in SDS.

[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
The maximum number of results to return.

[optional] integer pageSize
The number of results to return per page. Supercedes 'count' if specified. Will also cause a Link response header to be created with links to subsequent result sets. Those result sets are first, last, next or previous.

[optional] integer maxPages
The maximum number of result records that can be returned. This is used in conjunction with pageSize.

[optional] string continuationToken
If specified, this call retrieves a set of results as specified within the token. The possible result sets are first, last, next or previous.

[optional] string orderBy
The search result order specification. If not specified, the results are ordered by ascending stream name. If a search result order is specified, it should consist of one stream result attribute name (attribute-name) with an optional sort order (sort-order). The sort-order, if specified, is separated from the attribute-name by a space. The supported stream result attribute names are Id, Name, TypeId, Description, Self, TenantId, NamespaceId, TenantName, and CommunityId. The sort order values are ASC, for ascending, which is the default, and DESC, for descending. Attribute names and sort order values are not case sensitive. Example: NamespaceID DESC

Response

Example response body

200 Response (StreamSearchResult[])

[
  {
    "Id": "string",
    "Name": "string",
    "TypeId": "string",
    "Description": "string",
    "Self": "string",
    "TenantId": "string",
    "TenantName": "string",
    "NamespaceId": "string",
    "CommunityId": "string",
    "PropertyOverrides": [
      {
        "SdsTypePropertyId": "string",
        "Uom": "string",
        "InterpolationMode": 0
      }
    ]
  }
]

List Streams By Namespace 1

Searches for shared streams within a namespace by query.

Request

GET /api/v1-preview/tenants/{tenantId}/search/namespaces/{namespaceId}/streams
?query={query}&skip={skip}&count={count}&orderBy={orderBy}

Parameters

string tenantId
Calling tenant identifier.

string namespaceId
Namespace identifier.

[optional] string query
Query to execute. The query uses the same format as SDS. See Search in SDS.

[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
Maximum total results.

[optional] string orderBy
The search result order specification. If not specified, the results are ordered by ascending stream name. If a search result order is specified, it should consist of one stream result attribute name (attribute-name) with an optional sort order (sort-order). The sort-order, if specified, is separated from the attribute-name by a space. The supported stream result attribute names are Id, Name, TypeId, and Description. The sort order values are ASC, for ascending, which is the default, and DESC, for descending. Attribute names and sort order values are not case sensitive. Example: TypeID DESC

Response

Example response body

200 Response (StreamFromSearchByNamespace[])

[
  {
    "Id": "string",
    "Name": "string",
    "TypeId": "string",
    "Description": "string",
    "PropertyOverrides": [
      {
        "SdsTypePropertyId": "string",
        "Uom": "string",
        "InterpolationMode": 0
      }
    ]
  }
]

Search Streams By Namespace 2

Searches for shared streams within a namespace by query.

Request

POST /api/v1-preview/tenants/{tenantId}/search/namespaces/{namespaceId}/streams
?query={query}&skip={skip}&count={count}&orderBy={orderBy}

Parameters

string tenantId
Calling tenant identifier.

string namespaceId
Namespace identifier.

[optional] string query
Query to execute. The query uses the same format as SDS. See Search in SDS.

[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
Maximum total results.

[optional] string orderBy
The search result order specification. If not specified, the results are ordered by ascending stream name. If a search result order is specified, it should consist of one stream result attribute name (attribute-name) with an optional sort order (sort-order). The sort-order, if specified, is separated from the attribute-name by a space. The supported stream result attribute names are Id, Name, TypeId, and Description. The sort order values are ASC, for ascending, which is the default, and DESC, for descending. Attribute names and sort order values are not case sensitive. Example: TypeID DESC

Request Body

Input used to search namespace.

{
  "CommunityIds": [
    "string"
  ]
}

Response

Example response body

200 Response (StreamFromSearchByNamespace[])

[
  {
    "Id": "string",
    "Name": "string",
    "TypeId": "string",
    "Description": "string",
    "PropertyOverrides": [
      {
        "SdsTypePropertyId": "string",
        "Uom": "string",
        "InterpolationMode": 0
      }
    ]
  }
]

Definitions

StreamSearchResult

The StreamSearchResult object. This is the model representation exposed to callers of controller endpoints.

Properties

{
  "Id": "string",
  "Name": "string",
  "TypeId": "string",
  "Description": "string",
  "Self": "string",
  "TenantId": "string",
  "TenantName": "string",
  "NamespaceId": "string",
  "CommunityId": "string",
  "PropertyOverrides": [
    {
      "SdsTypePropertyId": "string",
      "Uom": "string",
      "InterpolationMode": 0
    }
  ]
}

SdsStreamPropertyOverride

Properties

{
  "SdsTypePropertyId": "string",
  "Uom": "string",
  "InterpolationMode": 0
}

SdsInterpolationMode

Enumerated Values

PartialFailureResult

PartialFailureResult object. Used for HTTP status code 207 responses. This is a model representation exposed to callers of the Search Streams By Community controller endpoint.

Properties

{
  "OperationId": "string",
  "Error": "string",
  "ReasonPhrase": "string",
  "ChildErrors": [
    {
      "OperationId": "string",
      "TenantId": "string",
      "NamespaceId": "string",
      "Error": "string",
      "Reason": "string",
      "Resolution": "string",
      "StatusCode": 0
    }
  ],
  "Data": [
    {
      "Id": "string",
      "Name": "string",
      "TypeId": "string",
      "Description": "string",
      "Self": "string",
      "TenantId": "string",
      "TenantName": "string",
      "NamespaceId": "string",
      "CommunityId": "string",
      "PropertyOverrides": [
        {
          "SdsTypePropertyId": "string",
          "Uom": "string",
          "InterpolationMode": 0
        }
      ]
    }
  ]
}

ChildError

The ChildError object. This is a model representation exposed to callers of the Search Streams By Community controller endpoint.

Properties

{
  "OperationId": "string",
  "TenantId": "string",
  "NamespaceId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "StatusCode": 0
}

ErrorResponse

Properties

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string"
}

StreamFromSearchByNamespace

The StreamFromSearchByNamespace object. This is the model representation exposed to called of controller endpoints.

Properties

{
  "Id": "string",
  "Name": "string",
  "TypeId": "string",
  "Description": "string",
  "PropertyOverrides": [
    {
      "SdsTypePropertyId": "string",
      "Uom": "string",
      "InterpolationMode": 0
    }
  ]
}

SearchStreamsByNamespaceInput

The SearchStreamsByNamespaceInput object.

Properties

{
  "CommunityIds": [
    "string"
  ]
}