Get Data Source Catalog Item
GET/projects/{projectId}/dataSourceCatalogItems/{catalogItemId}
Base URL: https://api.tinkermode.com
Get the specified data source catalog item.
Authentication
This endpoint does not require authentication.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
projectId | integer | Yes | The unique ID for a specified project. | |
catalogItemId | string | Yes | Data source catalog item ID. |
Responses
200 Data source catalog item is returned.
Content type: application/json
| 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. |
404 The requested dataSourceCatalogItem does not exist or is not accessible.
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. |