{{getMsg('Help_YouAreHere')}}:
/
{{page.title}}
{{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}}
{{helpModel.downloadHelpPdfDataStatus}}
Series Definition
Returns detailed information about one available series component. The example object has the JSON structure expected for this component by the Import command.
The component ID must first be obtained from the /series list. If no available component has the specified ID, the server returns 404 Not Found.
GET /api/taskplanner/definitions/series/<SeriesID>
| REQUEST Parameter | Value Type | Description |
|---|---|---|
| SeriesID | string | Extension name of the series component, as returned by the /series list |
| RESPONSE Fields | Value Type | Description |
|---|---|---|
| id | string | Extension name of the component |
| name | string | Localized display name of the component |
| description | string | Localized description of the component |
| example | object | Example component definition for the Task Planner import/export JSON format |
| fields | object array | Configurable properties, including their types, keys, localized labels, defaults, choices, and conditions |
The fields array describes the component's configurable properties. Every field can contain the following common values. Field types can add further values, such as selectable entries, file protocols, filters, or numeric constraints.
| Field object value | Value Type | Description |
|---|---|---|
| conditions | object array or null | Conditions that control whether the field is visible or disabled |
| type | string | Input type, for example TEXTFIELD, SELECT, BOOLEAN, DATE, TIME, FILE, or FOLDER |
| key | string | Property key used in the task definition |
| label | string | Localized label of the field |
| placeholder | string or null | Placeholder shown when no value is configured |
| value | string or null | Default value; non-null defaults are also copied into the returned example.properties object |
| updateValuesOnChange | boolean | Whether changing this field requires the other field values to be refreshed |
Example Request
# Request GET /api/taskplanner/definitions/series/series.json HTTP/1.1 Authorization: Bearer <access_token> # Response HTTP/1.1 200 OK Content-Type: application/json { "id": "series.json", "name": "JSON", "description": "Executes the task for each data set in a JSON file", "example": { "id": "series.json", "properties": {} }, "fields": [ { "type": "FILE", "key": "file", "label": "JSON File", "value": null } ] }
Application Example
curl -LsH "Authorization: Bearer <access_token>" "http://127.0.0.1:9000/api/taskplanner/definitions/series/<SeriesID>"
© Copyright 1996 - 2026, i-net software GmbH; All rights Reserved. Imprint
