KEkeboola
Components and Configurations

Get components

Use this API call to obtain the definitions of all components in Development Branch together with their configurations in the project. For more information about the KBC Component architecture, see the Developers documentation.

Only components that have at least one configuration in the project (deleted ones when isDeleted=true) are returned. The include query parameter controls whether configuration, rows and state are embedded in each configuration.

The variant without branch/{branchId} in the URL is deprecated, use the branch endpoint and set branch/default.

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

Request

Path parameters

branchIdstring required

Query parameters

componentTypestring nullable

Filter components by type.

includestring nullable

Comma-separated list of data to include. Allowed values: state, configuration, rows.

isDeletedstring nullable

Whether to list deleted components instead of active ones. Accepts booleanish values.

Response

List of components with their configurations.

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"
    },
    "configurations": [
      {
        "id": "236606822",
        "name": "My new configuration",
        "created": "2017-02-13T12:01:05+0100",
        "creatorToken": {
          "id": 27978,
          "description": "dev@keboola.com"
        },
        "version": 1,
        "changeDescription": "Initial configuration",
        "folder": "Marketing",
        "folderUpdated": "2017-02-13T12:01:05+0100",
        "rows": [
          {
            "id": "row1",
            "name": "First row",
            "version": 1,
            "created": "2017-02-13T12:01:05+0100",
            "creatorToken": {
              "id": 27978,
              "description": "dev@keboola.com"
            },
            "changeDescription": "Row created",
            "versionIdentifier": "01H2W8N0ZJJB6V126C8ZSND28N"
          }
        ],
        "currentVersion": {
          "created": "2017-02-13T12:01:05+0100",
          "creatorToken": {
            "id": 27978,
            "description": "dev@keboola.com"
          },
          "changeDescription": "Initial configuration",
          "versionIdentifier": "01H2W7DAN0QT78NZQ2BD2BZT4S"
        }
      }
    ]
  }
]

Changes

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