KEkeboola
Components and Configurations

Get component

Use this API call to obtain the definition of component for Development Branch available in KBC.

get/v2/storage/branch/{branchId}/components/{componentId}

Request

Path parameters

componentIdstring required

Id of the component.

branchIdstring required

Id of the development branch.

Response

Component detail.

idstring required

Unique identifier of the component

typestring required

Type of the component as the Developer Portal reports it, e.g. extractor, writer, application or transformation

namestring required

Display name of the component

descriptionstring required

Short description of the component

longDescriptionstring nullable required

Detailed description of the component

versioninteger required

Version number of the component

complexity'low' | 'medium' | 'high' nullable required

Complexity level of the component

categoriesstring[] required

List of component categories

hasUIboolean required

Whether the component has a user interface

hasRunboolean required

Whether the component can be run

ico32string nullable required

32x32 icon URL

ico64string nullable required

64x64 icon URL

ico128string nullable required

128x128 icon URL

flagsstring[] required

List of component flags

configurationDescriptionstring nullable required

Description of the configuration structure

featuresstring[] required

List of component features

expiredOnstring nullable required

Date when the component expires, ISO 8601 with a +hhmm offset

uristring nullable required

URI of the component

documentationUrlstring

URL to the component documentation. Present only when the component has one.

Example response

{
  "id": "keboola.ex-db-mysql",
  "type": "extractor",
  "name": "MySQL Database Extractor",
  "description": "Extracts data from MySQL database",
  "version": 2,
  "categories": [
    "extractor",
    "database"
  ],
  "expiredOn": "2017-02-13T12:01:05+0100",
  "uri": "https://connection.keboola.com/v2/storage/components/keboola.ex-db-mysql",
  "dataTypesConfiguration": {
    "dataTypesSupport": "none"
  },
  "processorConfiguration": {
    "allowedProcessorPosition": "any"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.