UiSpec proxy server API

Component UiSpec Server

Overview

These endpoints allow to obtain UiSpec representations of the component/configuration types properties.

Version information

Version : v1

Contact information

Contact : Talend
Contact Email : contact@talend.com

License information

License : Apache 2.0
License URL : www.apache.org/licenses/LICENSE-2.0.html
Terms of service : null

URI scheme

Host : host:port
BasePath : /componentproxy/api/v1
Schemes : HTTP, HTTPS

Tags

  • action

  • configuration

  • configurations

  • dataset

  • datastore

  • form

  • icon

  • persistence

  • ui spec

  • uispec

Paths

This endpoint execute an action required by a form.

POST /actions/execute
Description

configuration types has action that can be executed using this endpoint

Parameters
Type Name Schema

Query

action
optional

string

Query

family
optional

string

Query

language
optional

string

Query

type
optional

string
Responses
HTTP Code Description Schema

200

successful operation
Headers :
Talend-Component-Server-Error (boolean) : This header indicate the error origin. true indicate an error from the component server, false indicate that the error is from this proxy.

< string, CompletionStageMapStringObject > map

400

This response is returned when the action is null

ProxyErrorPayload

404

This response is returned when no action is found

ProxyErrorPayload

520

This response is returned when the action raise an unhandled error

ProxyErrorPayload
Consumes

  • application/json

Produces

  • application/json

Tags

  • action

  • configurations

Return all the available root configuration (Data store like) from the component server

GET /configurations
Description

Every configuration has an icon. In the response an icon key is returned. this icon key can be one of the bundled icons or a custom one. The consumer of this endpoint will need to check if the icon key is in the icons bundle otherwise the icon need to be gathered using the familyId from this endpoint configurations/{id}/icon

Responses
HTTP Code Description Schema

200

successful operation
Headers :
Talend-Component-Server-Error (boolean) : This header indicate the error origin. true indicate an error from the component server, false indicate that the error is from this proxy.

Nodes
Consumes

  • application/json

Produces

  • application/json

Tags

  • configurations

  • datastore

Return a form description ( Ui Spec ) without a specific configuration

GET /configurations/form/initial/{type}
Parameters
Type Name Schema

Path

type
required

string
Responses
HTTP Code Description Schema

200

successful operation
Headers :
Talend-Component-Server-Error (boolean) : This header indicate the error origin. true indicate an error from the component server, false indicate that the error is from this proxy.

Nodes
Consumes

  • application/json

Produces

  • application/json

Tags

  • configurations

  • dataset

  • datastore

  • form

  • ui spec

Return a form description ( Ui Spec ) of a specific configuration

GET /configurations/form/{id}
Parameters
Type Name Schema

Path

id
required

string
Responses
HTTP Code Description Schema

200

successful operation
Headers :
Talend-Component-Server-Error (boolean) : This header indicate the error origin. true indicate an error from the component server, false indicate that the error is from this proxy.

UiNode
Consumes

  • application/json

Produces

  • application/json

Tags

  • configurations

  • dataset

  • datastore

  • form

  • ui spec

Return the configuration icon file in png format

GET /configurations/icon/{id}
Parameters
Type Name Schema

Path

id
required

string
Responses
HTTP Code Description Schema

200

successful operation
Headers :
Talend-Component-Server-Error (boolean) : This header indicate the error origin. true indicate an error from the component server, false indicate that the error is from this proxy.

CompletionStageByte[]
Consumes

  • application/json

Produces

  • application/json

  • application/octet-stream

Tags

  • icon

Update a configuration.

POST /configurations/persistence/edit/{id}
Parameters
Type Name Schema

Path

id
required

string
Responses
HTTP Code Description Schema

200

successful operation
Headers :
Talend-Component-Server-Error (boolean) : This header indicate the error origin. true indicate an error from the component server, false indicate that the error is from this proxy.

EntityRef
Consumes

  • application/json

Produces

  • application/json

Tags

  • configurations

  • dataset

  • datastore

  • form

  • persistence

  • ui spec

Saves a configuration based on a type. Concretely it is the same as /persistence/save/{formId} but the formId is contained into the payload itself and marked in the metadata as such.

POST /configurations/persistence/save-from-type/{type}
Parameters
Type Name Schema

Path

type
required

string
Responses
HTTP Code Description Schema

200

successful operation
Headers :
Talend-Component-Server-Error (boolean) : This header indicate the error origin. true indicate an error from the component server, false indicate that the error is from this proxy.

EntityRef
Consumes

  • application/json

Produces

  • application/json

Tags

  • configurations

  • dataset

  • datastore

  • form

  • persistence

  • ui spec

Saves a configuration based on a form identifier.

POST /configurations/persistence/save/{formId}
Parameters
Type Name Schema

Path

formId
required

string
Responses
HTTP Code Description Schema

200

successful operation
Headers :
Talend-Component-Server-Error (boolean) : This header indicate the error origin. true indicate an error from the component server, false indicate that the error is from this proxy.

EntityRef
Consumes

  • application/json

Produces

  • application/json

Tags

  • configurations

  • dataset

  • datastore

  • form

  • persistence

  • ui spec

Definitions

CompletionStage

Type : object

CompletionStageByte[]

Type : object

CompletionStageCollectionSimplePropertyDefinition

Type : object

CompletionStageMapStringObject

Type : object

CompletionStageMapStringString

Type : object

CompletionStageNodes

Type : object

EntityRef

Name Description Schema

id
optional

The identifier of the entity related to current request. It is generally thecreated entity of updated one.

string

JsonSchema

Name Schema

defaultValue
optional

object

description
optional

string

enumValues
optional

< string > array

id
optional

string

items
optional

JsonSchema

maxItems
optional

integer (int32)

maxLength
optional

integer (int32)

maximum
optional

number (double)

minItems
optional

integer (int32)

minLength
optional

integer (int32)

minimum
optional

number (double)

pattern
optional

string

properties
optional

< string, JsonSchema > map

ref
optional

string

required
optional

< string > array

schema
optional

string

title
optional

string

type
optional

string

uniqueItems
optional

boolean

NameValue

Name Schema

name
optional

string

value
optional

string

Node

Name Description Schema

children
optional

The list of configuration reusing this one as a reference (can be created "next").

< string > array

familyId
optional

The identifier of the family of this configuration.

string

familyLabel
optional

The display name of the family of this configuration.

string

icon
optional

The icon of this configuration. If you use an existing bundle (@talend/ui/icon), ensure it is present by default and if not do a request using the family on the related endpoint.

string

id
optional

The identifier of this configuration/node.

string

label
optional

The display name of this configuration.

string

name
optional

The technical name of this node (it is human readable but not i18n friendly), useful for debug purposes.

string

version
optional

The version of this configuration for the migration management.

integer (int32)

Nodes

Name Description Schema

nodes
optional

The list of nodes matching the request. The key is the node identifier.

< string, Node > map

Option

Name Schema

path
optional

string

type
optional

string

Parameter

Name Schema

key
optional

string

path
optional

string

ProxyErrorPayload

Name Description Schema

code
optional

The error code independently of the locale and not as precise as a message (not context aware).

string

message
optional

A human readable message to help understanding the error

string

Trigger

Name Schema

action
optional

string

family
optional

string

onEvent
optional

string

options
optional

< Option > array

parameters
optional

< Parameter > array

type
optional

string

Ui

Name Schema

jsonSchema
optional

JsonSchema

properties
optional

object

uiSchema
optional

< UiSchema > array

UiNode

Name Description Schema

metadata
optional

The metadata associated to the node if needed by the UI.

Node

ui
optional

The ui specification corresponding to the requested node. It is literally the form representing this configuration.

Ui

UiSchema

Name Schema

autoFocus
optional

boolean

condition
optional

< string, < object > array > map

description
optional

string

disabled
optional

boolean

itemWidget
optional

string

items
optional

< UiSchema > array

key
optional

string

options
optional

< string, string > map

placeholder
optional

string

readOnly
optional

boolean

required
optional

boolean

restricted
optional

boolean

title
optional

string

titleMap
optional

< NameValue > array

triggers
optional

< Trigger > array

type
optional

string

widget
optional

string
Scroll to top