Get Data Source Catalog Items
GET/projects/{projectId}/dataSourceCatalogItems
Base URL: https://api.tinkermode.com
Get all data source catalog items available for the project. The search string may contain multiple phrases separated by whitespaces. When the search parameter is used, only items that vendor, name, or description matching exactly or partially one of the phrases will be returned.
Authentication
Send an Authorization header of the form ModeCloud <AUTH_CODE>.
Must contain a user, service account, project, or device API key.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
projectId | integer | Yes | The unique ID for a specified project. |
Query parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
catalogItemType | string | No | Filter data source catalog items by catalog item type. | |
configurationType | string | No | Filter data source catalog items by configuration type. | |
limit | integer | No | default: 100; min: 1; max: 1000 | Maximum number of data source catalog items to return. |
search | string | No | Search for data source catalog items by keywords. | |
skip | integer | No | default: 0; min: 0 | Number of users to skip over. |
Responses
200 List of available data source catalog items are returned.
Content type: application/json
Definition of a data source catalog item available for a project.
An array of objects with the following shape:
| Property | Type | Required | Constraints | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
catalogItemId | string | Yes | read-only (server-generated) | The ID of a data source catalog item. Must be unique. | |||||||||||||||
catalogItemType | string | Yes | one of: gatewayPeripheralModule, virtualDataObject | The type of a data source catalog item. | |||||||||||||||
configurationType | string | Yes | one of: gw-discovery, gw-discovery-with-driver-setup, manual | The configuration type of a data source catalog item. | |||||||||||||||
description | string | Yes | The description for a data source catalog item. | ||||||||||||||||
imageData | object | No | The image data for a data source catalog item. | ||||||||||||||||
| |||||||||||||||||||
name | string | Yes | The name for a data source catalog item. | ||||||||||||||||
vendor | string | Yes | The vendor name for a data source catalog item. | ||||||||||||||||
401 Authorization is required to access this resource.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
403 Request failed because of denied permission.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
429 Request failed because of rate limit.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
500 An unexpected error has occurred.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
503 The service is temporarily unavailable.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |