KEkeboola
Components and Configurations

Update Configuration State

Updates state of an existing configuration for Development Branch. Writing state does not create a new configuration version.

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

put/v2/storage/components/{componentId}/configs/{configurationId}/state

Request

Path parameters

componentIdstring required

Id of the component.

configurationIdstring required

Id of the configuration.

Request body

stateobject required

Configuration state data; the maximum allowed size is 4MB. No other properties are accepted.

Example request

{
  "state": {
    "lastId": 123
  }
}

Response

Configuration with the updated state.

idstring required

Configuration id, unique within the component.

namestring required

Configuration name.

descriptionstring required

Configuration description.

createdstring required

When the configuration was created, ISO 8601 with a +hhmm offset; "" when none was recorded.

versioninteger required

Current version number. Use it as the If-Match precondition for update, delete and purge.

changeDescriptionstring nullable required

Change description of the current version.

isDisabledboolean required

Whether the configuration is disabled.

isDeletedboolean required

Whether the configuration is in the trash.

folderstring nullable required

Folder the configuration is grouped under; null when it is in none.

folderUpdatedstring nullable required

When the folder was last written (set, cleared, copied to a branch or merged), ISO 8601 with a +hhmm offset; null when the configuration has no folder. Read-only.

configurationobject required

Configuration data, arbitrary object defined by the component.

rowsSortOrderstring[] required

Row ids in the desired order; empty when the default order (by id) applies.

stateobject required

Configuration state data, arbitrary object.

Example response

{
  "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.