diff --git a/docs/api_doc/butler-api.html b/docs/api_doc/butler-api.html new file mode 100644 index 00000000..0b95fd8b --- /dev/null +++ b/docs/api_doc/butler-api.html @@ -0,0 +1,2315 @@ + + + + + + Butler API documentation + + + + + + + + + +
Documentation Powered by Redocly

Butler API documentation (7.3.2)

Download OpenAPI specification:Download

Butler is a microservice that provides add-on features to Qlik Sense Enterprise on Windows. +Butler offers both a REST API and things like failed reload notifications etc.

+

This page contains the API documentation. Full documentation is available at https://butler.ptarmiganlabs.com

+
Butler family of tools on GitHub

Get an array of all enabled API endpoints.

Get an array of all enabled API endpoints, using the key names from the Butler config file.

+

Note: Endpoints are enabled/disabled in the Butler main configuration file.

+

Responses

Response samples

Content type
application/json
[
  • "activeUserCount",
  • "activeUsers",
  • "apiListEnbledEndpoints"
]

Converts strings from base62 to base16.

Converts strings from base62 to base16.

+
query Parameters
base62
required
string
Example: base62=6DMW88LpSok9Z7P7hUK0wv7bF

The base62 encoded string that should be converted to base16

+

Responses

Response samples

Content type
application/json
{
  • "base62": "6DMW88LpSok9Z7P7hUK0wv7bF",
  • "base16": "3199af08bfeeaf5d420f27ed9c01e74370077"
}

Converts strings from base16 to base62.

Converts strings from base16 to base62.

+
query Parameters
base16
required
string
Example: base16=3199af08bfeeaf5d420f27ed9c01e74370077

The base16 encoded string that should be converted to base62

+

Responses

Response samples

Content type
application/json
{
  • "base16": "3199af08bfeeaf5d420f27ed9c01e74370077",
  • "base62": "6DMW88LpSok9Z7P7hUK0wv7bF"
}

Tests if Butler is alive and responding

Tests if Butler is alive and responding

+

Responses

Response samples

Content type
application/json
{
  • "response": "Butler reporting for duty",
  • "butlerVersion": "5.5.0"
}

Copy file(s) between well defined, approved locations.

Copying of files is only posttible between pre-approved directories. +Defining approved source and destination directories is done in Butler's config file.

+

If the source directory contains subdirectories, these will be copied too.

+
Request Body schema: application/json
fromFile
string

Name of source file.

+
toFile
string

Name of destination file. Can be different from source file name, if needed.

+
overwrite
boolean

Controls whether destination file should be overwritten if it already exists. Note that the copy operation will silently fail if you set this to false and the destination exists. Defaults to false.

+
preserveTimestamp
boolean

When true, the timestamp of the source file(s) will be preserved on the destination file(s). When false, timestamp behaviour is OS-dependent. Defaults to false.

+

Responses

Request samples

Content type
application/json
{
  • "fromFile": "subfolder/file1.qvd",
  • "toFile": "archive/file1_20200925.qvd",
  • "overwrite": false,
  • "preserveTimestamp": false
}

Response samples

Content type
application/json
{
  • "fromFile": "subfolder/file1.qvd",
  • "toFile": "archive/file1_20200925.qvd",
  • "overwrite": false,
  • "preserveTimestamp": false
}

Move file(s) between well defined, approved locations.

Moving of files is only posttible between pre-approved directories. +Defining approved source and destination directories is done in Butler's config file.

+

If the source directory contains subdirectories, these will be moved too.

+
Request Body schema: application/json
fromFile
string

Name of source file.

+
toFile
string

Name of destination file. Can be different from source file name, if needed.

+
overwrite
boolean

Controls whether destination file should be overwritten if it already exists. Defaults to false.

+

Responses

Request samples

Content type
application/json
{
  • "fromFile": "subfolder/file1.qvd",
  • "toFile": "archive/file1_20200925.qvd",
  • "overwrite": false
}

Response samples

Content type
application/json
{
  • "fromFile": "subfolder/file1.qvd",
  • "toFile": "archive/file1_20200925.qvd",
  • "overwrite": false
}

Delete file(s) in well defined, approved locations.

It is only possible to delete files in pre-approved directories, or subdirectories thereof. +Defining approved directories is done in Butler's config file.

+
Request Body schema: application/json
deleteFile
string

Name of file to be deleted. Use forward/backward slashes in paths as needed, depending on whether Butler runs on Windows/non-Windows platform.

+

Responses

Request samples

Content type
application/json
{
  • "deleteFile": "data/qvdstore/sales/file1.qvd"
}

Response samples

Content type
application/json
{ }

Creates a directory in designated QVD directory.

Creates a directory in QVD directory (which is defined in Butler's config file).

+
Request Body schema: application/json
directory
string

Directory that should be created.

+

Responses

Request samples

Content type
application/json
{
  • "directory": "subfolder/2020-10"
}

Response samples

Content type
application/json
{
  • "directory": "subfolder/2020-10"
}

Creates a directory anywhere in the file system.

If the directory already exists nothing will happen. +If permissions don't allow a directory to be created, or if the path is invalid, an error will be returned.

+
Request Body schema: application/json
directory
string

Path to directory that should be created. Can be a relative or absolute path.

+

Responses

Request samples

Content type
application/json
{
  • "directory": "/Users/joe/data/qvds/2020"
}

Response samples

Content type
application/json
{
  • "directory": "/Users/joe/data/qvds/2020"
}

List all currently defined namespaces.

Responses

Response samples

Content type
application/json
[
  • "Weekly sales app",
  • "Sales ETL step 1",
  • "Sales ETL step 2"
]

Get the value associated with a key, in a specific namespace.

path Parameters
namespace
required
string
Example: Sales ETL step 2
query Parameters
key
required
string
Example: key=Last extract timestamp

Responses

Response samples

Content type
application/json
{
  • "namespace": "Sales ETL step 2",
  • "key": "Last extract timestamp",
  • "value": "2020-09-29 17:14:56"
}

Create a new key-value pair in the specified namespace.

If the specified key already exists it will be overwritten.

+

If the posted data has a TTL, it will start counting when the post occur. +I.e. if a previouly posted key also had a TTL, it will be replace with the most recent TTL.

+
path Parameters
namespace
required
string
Example: Sales ETL step 2

Name of namespace.

+
Request Body schema: application/json
key
string

Key to use

+
value
string

Value to set

+
ttl
number

Time to live = how long (milliseconds) the key-value pair should exist before being automatically deleted

+

Responses

Request samples

Content type
application/json
{
  • "key": "ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1",
  • "value": "12345.789",
  • "ttl": 10000
}

Response samples

Content type
application/json
{
  • "namespace": "Sales ETL step 2",
  • "key": "Last extract timestamp",
  • "value": "2020-09-29 17:14:56",
  • "ttl": 60000
}

Delete a namespace and all key-value pairs in it.

path Parameters
namespace
required
string
Example: Sales ETL step 2

Name of namespace.

+

Responses

Response samples

Content type
application/json
""

Checks if a key exists in a namespace.

Returns true if the specified key exists, otherwise false.

+
path Parameters
namespace
required
string
Example: Sales ETL step 2
query Parameters
key
required
string
Example: key=Last extract timestamp

Responses

Response samples

Content type
application/json
{
  • "keyExists": true,
  • "keyValue": {
    }
}

Delete a key-value pair in a specific namespace.

path Parameters
namespace
required
string
Example: Sales ETL step 2

Name of namespace.

+
key
required
string
Example: ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1

Key to use

+

Responses

Response samples

Content type
application/json
""

Retrieve a list of all keys present in the specified namespace.

path Parameters
namespace
required
string
Example: Sales ETL step 2

Name of namespace whose keys should be returned.

+

Responses

Response samples

Content type
application/json
{
  • "namespace": "Sales ETL step 2",
  • "keys": [
    ]
}

Publish a message to a MQTT topic.

Request Body schema: application/json
topic
required
string

Topic to which message should be published.

+
message
required
string

The message is a generic text string and can thus contain anything that can be represented in a string, including JSON, key-value pairs, plain text etc.

+

Responses

Request samples

Content type
application/json
{
  • "topic": "qliksense/new_data_notification/sales",
  • "message": "dt=20201028"
}

Response samples

Content type
application/json
{
  • "topic": "qliksense/new_data_notification/sales",
  • "message": "dt=20201028"
}

Post metrics to New Relic.

This endpoint posts metrics to the New Relic metrics API.

+
Request Body schema: application/json
name
required
string

Metric name.

+
type
required
string

Metric type. Valid options are count, distribution, gauge, summary.

+
value
required
number

Value of the metric.

+
timestamp
number

The metric's start time in Unix time. Uses UTC time zone. This field also support seconds, microseconds, and nanoseconds. However, the data will be converted to milliseconds for storage and query. Metrics reported with a timestamp older than 48 hours ago or newer than 24 hours from the time they are reported are dropped by New Relic. If left empty Butler will use the current time as timestamp.

+
interval
number

The length of the time window. Required for count and summary metric types.

+
Array of objects[ items ]

Dimensions that will be associated with the metric.

+

Responses

Request samples

Content type
application/json
{
  • "name": "memory.heap",
  • "type": "gauge",
  • "value": 2.3,
  • "timestamp": 1642164296053,
  • "interval": 0,
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "newRelicResultCode": "202",
  • "newRelicResultText": "Data accepted."
}

Get all information available for existing schedule(s).

If a schedule ID is specified using a query parameter (and there exists a schedule with that ID), information about that schedule will be returned. +If no schedule ID is specified, all schedules will be returned.

+
query Parameters
id
string
Example: id=e4b1c455-aa15-4a51-a9cf-c5e4cfc91339

Scheduld ID

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new schedule.

Request Body schema: application/json
name
required
string

Descriptive name for the schedule.

+
cronSchedule
required
string

5 or 6 position cron schedule.

+

If 6 positions used, the leftmost position represent seconds. +If 5 positions used, leftmost position is minutes.

+

The example schedule will trigger at 00 and 30 minutes past 6:00 on Mon-Fri.

+
timezone
required
string

Time zone the schedule should use. Ex "Europe/Stockholm".

+
qlikSenseTaskId
required
string

ID of Qlik Sense task that should be started when schedule triggers.

+
startupState
required
string
Enum: "start" "started" "stop" "stopped"

If set to "start" or "started", the schedule will be started upon creation. Otherwise it will remain in stopped state.

+
tags
Array of strings

Can be used to categorise schedules.

+

Responses

Request samples

Content type
application/json
{
  • "name": "Reload sales metrics",
  • "cronSchedule": "0,30 6 * * 1-5",
  • "timezone": "Europe/Stockholm",
  • "qlikSenseTaskId": "210832b5-6174-4572-bd19-3e61eda675ef",
  • "startupState": "started",
  • "tags": "[\"tag 1\", \"tag 2\"]"
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete a schedule.

path Parameters
scheduleId
required
string
Example: e4b1c455-aa15-4a51-a9cf-c5e4cfc91339

Schedule ID.

+

Responses

Response samples

Content type
application/json
""

Start a schedule.

Start a schedule, i.e. have the scheduler run the associated reload task according to the schedule's cron settings.

+
path Parameters
scheduleId
required
string
Example: e4b1c455-aa15-4a51-a9cf-c5e4cfc91339

Schedule ID.

+

Responses

Response samples

Content type
application/json
{
  • "id": "e4b1c455-aa15-4a51-a9cf-c5e4cfc91339",
  • "created": "2020-09-29T14:29:12.283Z",
  • "name": "Reload sales metrics",
  • "cronSchedule": "0,30 6 * * 1-5",
  • "timezone": "Europe/Stockholm",
  • "qlikSenseTaskId": "210832b5-6174-4572-bd19-3e61eda675ef",
  • "startupState": "started",
  • "tags": "[\"tag 1\", \"tag 2\"]",
  • "lastKnownState": "started"
}

Start all schedules.

Start all schedules, i.e. tell the scheduler to run each schedule and start associated tasks according to each schedule's settings.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Stop a schedule.

Stop a schedule, i.e. tell the scheduler to no longer execute the schedule according to its cron settings.

+
path Parameters
scheduleId
required
string
Example: e4b1c455-aa15-4a51-a9cf-c5e4cfc91339

Schedule ID.

+

Responses

Response samples

Content type
application/json
{
  • "id": "e4b1c455-aa15-4a51-a9cf-c5e4cfc91339",
  • "created": "2020-09-29T14:29:12.283Z",
  • "name": "Reload sales metrics",
  • "cronSchedule": "0,30 6 * * 1-5",
  • "timezone": "Europe/Stockholm",
  • "qlikSenseTaskId": "210832b5-6174-4572-bd19-3e61eda675ef",
  • "startupState": "started",
  • "tags": "[\"tag 1\", \"tag 2\"]",
  • "lastKnownState": "started"
}

Stop all schedules.

Stop all schedules, i.e. tell the scheduler to no longer execute any schedule according to its cron settings.

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get scheduler status.

Get basic status from the core scheduler.

+

No schedule metadata beyond ID, cron setting and job state will be returned, but as this comes from the core scheduler it is the authorative truth about what jobs are running (and which ones are not).

+

Responses

Do a stand-alone reload of a Qlik Sense app, without using a task.

path Parameters
appId
required
string
Example: 210832b5-6174-4572-bd19-3e61eda675ef

ID of Qlik Sense app.

+
Request Body schema: application/json
reloadMode
integer

Reload mode that will be used. 0, 1 or 2. If not specified 0 will be used

+
partialReload
boolean

Should a full (=false) or partial (=true) reload be done? If not specified a full reload will be done.

+
startQSEoWTaskOnSuccess
Array of strings[ items >= 0 items ]

Array of task IDs that should be started when the app has successfully reloaded.

+
startQSEoWTaskOnFailure
Array of strings[ items >= 0 items ]

Array of task IDs that should be started if the app fails reloading.

+

Responses

Request samples

Content type
application/json
{
  • "reloadMode": 0,
  • "partialReload": true,
  • "startQSEoWTaskOnSuccess": [
    ],
  • "startQSEoWTaskOnFailure": [
    ]
}

Response samples

Content type
application/json
{
  • "appId": "210832b5-6174-4572-bd19-3e61eda675ef"
}

Dump a Sense app to JSON.

Does the same thing as /v4/app/:appId/dump

+
path Parameters
appId
required
string
Example: 210832b5-6174-4572-bd19-3e61eda675ef

ID of Qlik Sense app.

+

Responses

Response samples

Content type
application/json
{
  • "properties": { },
  • "loadScript": "",
  • "sheets": [ ],
  • "stories": [ ],
  • "masterobjects": [ ],
  • "appprops": [ ],
  • "dataconnections": [ ],
  • "dimensions": [ ],
  • "bookmarks": [ ],
  • "embeddedmedia": [ ],
  • "snapshots": [ ],
  • "fields": [ ],
  • "variables": [ ],
  • "measures": [ ]
}

Dump a Sense app to JSON.

Does the same thing as /v4/senseappdump/:appId

+
path Parameters
appId
required
string
Example: 210832b5-6174-4572-bd19-3e61eda675ef

ID of Qlik Sense app.

+

Responses

Response samples

Content type
application/json
{
  • "properties": { },
  • "loadScript": "",
  • "sheets": [ ],
  • "stories": [ ],
  • "masterobjects": [ ],
  • "appprops": [ ],
  • "dataconnections": [ ],
  • "dimensions": [ ],
  • "bookmarks": [ ],
  • "embeddedmedia": [ ],
  • "snapshots": [ ],
  • "fields": [ ],
  • "variables": [ ],
  • "measures": [ ]
}

Get a list of all apps in Sense environment.

Does the same thing as /v4/apps/list

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of all apps in Sense environment.

Does the same thing as /v4/senselistapps

+

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Start a Qlik Sense task.

An optional array of zero or more objects can be passed in the message body. It is used to pass additional info related to the reload task being started.

+

Currently supported values in this array are:

+
    +
  • A key-value pair that will be stored in Butler's KV store. If Butler's key-value store is not enabled, any key-value information passed in this parameter will simply be ignored. +Setting ttl=0 disables the TTL feature, i.e. the KV pair will not expire.
    • +
  • A task identified by its taskId that should be started.
    • +
  • Tasks identified by tags set on tasks in the QMC.
    • +
  • Tasks identified by custom properties set in the QMC.
    • +
+

This parameter uses a generic JSON/object format (type + payload). +It's thus possible to add new integrations in future Butler versions.

+
path Parameters
taskId
required
string
Example: 210832b5-6174-4572-bd19-3e61eda675ef

ID of Qlik Sense task. +Butler will ignore the "magic" task ID of "-" (=dash, hyphen). This ID will not be reported as invalid.

+
query Parameters
allTaskIdsMustExist
boolean
Example: allTaskIdsMustExist=true

If set to true, all specified taskIds must exist. If one or more taskIds does not exist in the Sense server, no tasks will be started.

+

If set to false, all existing taskIds will be started. Missing/invalid taskIds will be ignored.

+

In either case, missing/invalid taskIds will be reported in the result set back to the client calling the API.

+

Note: Tasks started by specifying tags and/or custom properties are not affected by this.

+
Request Body schema: application/json
Array
type
string
Enum: "keyvaluestore" "starttaskid" "starttasktag" "starttaskcustomproperty"
payload
object

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "tasksId": {
    },
  • "tasksTag": [
    ],
  • "tasksTagDenied": [
    ],
  • "tasksCP": [
    ],
  • "tasksCPDenied": [
    ]
}

Start a Qlik Sense task.

An optional array of zero or more objects can be passed in the message body. It is used to pass additional info related to the reload task being started.

+

Currently supported values in this array are:

+
    +
  • A key-value pair that will be stored in Butler's KV store. If Butler's key-value store is not enabled, any key-value information passed in this parameter will simply be ignored. +Setting ttl=0 disables the TTL feature, i.e. the KV pair will not expire.
    • +
  • A task identified by its taskId that should be started.
    • +
  • Tasks identified by tags set on tasks in the QMC.
    • +
  • Tasks identified by custom properties set in the QMC.
    • +
+

This parameter uses a generic JSON/object format (type + payload). +It's thus possible to add new integrations in future Butler versions.

+
path Parameters
taskId
required
string
Example: 210832b5-6174-4572-bd19-3e61eda675ef

ID of Qlik Sense task. +Butler will ignore the "magic" task ID of "-" (=dash, hyphen). This ID will not be reported as invalid.

+
query Parameters
allTaskIdsMustExist
boolean
Example: allTaskIdsMustExist=true

If set to true, all specified taskIds must exist. If one or more taskIds does not exist in the Sense server, no tasks will be started.

+

If set to false, all existing taskIds will be started. Missing/invalid taskIds will be ignored.

+

In either case, missing/invalid taskIds will be reported in the result set back to the client calling the API.

+

Note: Tasks started by specifying tags and/or custom properties are not affected by this.

+
Request Body schema: application/json
Array
type
string
Enum: "keyvaluestore" "starttaskid" "starttasktag" "starttaskcustomproperty"
payload
object

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "tasksId": {
    },
  • "tasksTag": [
    ],
  • "tasksTagDenied": [
    ],
  • "tasksCP": [
    ],
  • "tasksCPDenied": [
    ]
}

Send message to Slack.

Sends a basic message to Slack.

+
Request Body schema: application/json
channel
required
string

Slack channel to post message into. Prefix channel name with #.

+
from_user
required
string

Name of sending user, as shown in the Slack message

+
msg
required
string

Text going into the Slack message

+
emoji
string

Emoji to shown next to Slack message

+

Responses

Request samples

Content type
application/json
{
  • "channel": "#reload-notification",
  • "from_user": "Butler the Bot",
  • "msg": "This is a message from Qlik Sense",
  • "emoji": "thumbsup"
}

Response samples

Content type
application/json
{
  • "channel": "#reload-notification",
  • "from_user": "Butler the Bot",
  • "msg": "This is a message from Qlik Sense",
  • "emoji": "thumbsup"
}
+ + + + \ No newline at end of file diff --git a/docs/api_doc/butler-api.json b/docs/api_doc/butler-api.json new file mode 100644 index 00000000..b30000a0 --- /dev/null +++ b/docs/api_doc/butler-api.json @@ -0,0 +1 @@ +{"swagger":"2.0","info":{"title":"Butler API documentation","description":"Butler is a microservice that provides add-on features to Qlik Sense Enterprise on Windows.\nButler offers both a REST API and things like failed reload notifications etc.\n\nThis page contains the API documentation. Full documentation is available at https://butler.ptarmiganlabs.com","version":"7.3.2"},"definitions":{},"paths":{"/v4/configfile/endpointsenabled":{"get":{"summary":"Get an array of all enabled API endpoints.","description":"Get an array of all enabled API endpoints, using the key names from the Butler config file.\n\nNote: Endpoints are enabled/disabled in the Butler main configuration file.","responses":{"200":{"description":"Enabled API enpooints.","schema":{"description":"Enabled API enpooints.","type":"array","items":{"type":"string"},"example":["activeUserCount","activeUsers","apiListEnbledEndpoints"]}}}}},"/v4/base62tobase16":{"get":{"summary":"Converts strings from base62 to base16.","description":"Converts strings from base62 to base16.","parameters":[{"type":"string","description":"The base62 encoded string that should be converted to base16","example":"6DMW88LpSok9Z7P7hUK0wv7bF","required":true,"in":"query","name":"base62"}],"responses":{"200":{"description":"Base conversion successful.","schema":{"description":"Base conversion successful.","type":"object","properties":{"base62":{"type":"string","description":"The base62 encoded string that should be converted to base16"},"base16":{"type":"string","description":"Resulting base16 encoded string."}},"example":{"base62":"6DMW88LpSok9Z7P7hUK0wv7bF","base16":"3199af08bfeeaf5d420f27ed9c01e74370077"}}},"400":{"description":"Required parameter missing.","schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/base16tobase62":{"get":{"summary":"Converts strings from base16 to base62.","description":"Converts strings from base16 to base62.","parameters":[{"type":"string","description":"The base16 encoded string that should be converted to base62","example":"3199af08bfeeaf5d420f27ed9c01e74370077","required":true,"in":"query","name":"base16"}],"responses":{"200":{"description":"Base conversion successful.","schema":{"description":"Base conversion successful.","type":"object","properties":{"base62":{"type":"string","description":"The base62 encoded string that should be converted to base16"},"base16":{"type":"string","description":"Resulting base62 encoded string."}},"example":{"base16":"3199af08bfeeaf5d420f27ed9c01e74370077","base62":"6DMW88LpSok9Z7P7hUK0wv7bF"}}},"400":{"description":"Required parameter missing.","schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/butlerping":{"get":{"summary":"Tests if Butler is alive and responding","description":"Tests if Butler is alive and responding","responses":{"200":{"description":"Butler is alive and well.","schema":{"description":"Butler is alive and well.","type":"object","properties":{"response":{"type":"string","example":"Butler reporting for duty"},"butlerVersion":{"type":"string","example":"5.5.0"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/filecopy":{"put":{"summary":"Copy file(s) between well defined, approved locations.","description":"Copying of files is only posttible between pre-approved directories.\nDefining approved source and destination directories is done in Butler's config file.\n\nIf the source directory contains subdirectories, these will be copied too.","parameters":[{"name":"body","in":"body","schema":{"type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","example":"subfolder/file1.qvd"},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","example":"archive/file1_20200925.qvd"},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Note that the copy operation will silently fail if you set this to false and the destination exists. Defaults to false.","example":false},"preserveTimestamp":{"type":"boolean","description":"When true, the timestamp of the source file(s) will be preserved on the destination file(s). When false, timestamp behaviour is OS-dependent. Defaults to false.","example":false}}}}],"responses":{"201":{"description":"File copied.","schema":{"description":"File copied.","type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","example":"subfolder/file1.qvd"},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","example":"archive/file1_20200925.qvd"},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Note that the copy operation will silently fail if you set this to false and the destination exists. Defaults to false.","example":false},"preserveTimestamp":{"type":"boolean","description":"When true, the timestamp of the source file(s) will be preserved on the destination file(s). When false, timestamp behaviour is OS-dependent. Defaults to false.","example":false}}}},"400":{"description":"\"Required parameter missing\" or \"fromFile not found\".","schema":{"description":"\"Required parameter missing\" or \"fromFile not found\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"403":{"description":"No approved fromDir/toDir for file copy.","schema":{"description":"No approved fromDir/toDir for file copy.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/filemove":{"put":{"summary":"Move file(s) between well defined, approved locations.","description":"Moving of files is only posttible between pre-approved directories.\nDefining approved source and destination directories is done in Butler's config file.\n\nIf the source directory contains subdirectories, these will be moved too.","parameters":[{"name":"body","in":"body","schema":{"type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","example":"subfolder/file1.qvd"},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","example":"archive/file1_20200925.qvd"},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Defaults to false.","example":false}}}}],"responses":{"201":{"description":"File moved.","schema":{"description":"File moved.","type":"object","properties":{"fromFile":{"type":"string","description":"Name of source file.","example":"subfolder/file1.qvd"},"toFile":{"type":"string","description":"Name of destination file. Can be different from source file name, if needed.","example":"archive/file1_20200925.qvd"},"overwrite":{"type":"boolean","description":"Controls whether destination file should be overwritten if it already exists. Defaults to false.","example":false}}}},"400":{"description":"\"Required parameter missing\" or \"fromFile not found\".","schema":{"description":"\"Required parameter missing\" or \"fromFile not found\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"403":{"description":"No approved fromDir/toDir for file copy.","schema":{"description":"No approved fromDir/toDir for file copy.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/filedelete":{"delete":{"summary":"Delete file(s) in well defined, approved locations.","description":"It is only possible to delete files in pre-approved directories, or subdirectories thereof.\nDefining approved directories is done in Butler's config file.","parameters":[{"name":"body","in":"body","schema":{"type":"object","properties":{"deleteFile":{"type":"string","description":"Name of file to be deleted. Use forward/backward slashes in paths as needed, depending on whether Butler runs on Windows/non-Windows platform.","example":"data/qvdstore/sales/file1.qvd"}}}}],"responses":{"204":{"description":"File deleted.","schema":{"description":"File deleted.","type":"object"}},"400":{"description":"\"Required parameter missing\" or \"File requested for delete not found\".","schema":{"description":"\"Required parameter missing\" or \"File requested for delete not found\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"403":{"description":"No approved directory matches the delete request.","schema":{"description":"No approved directory matches the delete request.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/createdirqvd":{"post":{"summary":"Creates a directory in designated QVD directory.","description":"Creates a directory in QVD directory (which is defined in Butler's config file).","parameters":[{"name":"body","in":"body","schema":{"type":"object","properties":{"directory":{"type":"string","description":"Directory that should be created.","example":"subfolder/2020-10"}}}}],"responses":{"201":{"description":"Directory created.","schema":{"description":"Directory created.","type":"object","properties":{"directory":{"type":"string","description":"Directory that was created.","example":"subfolder/2020-10"}}}},"400":{"description":"Required parameter missing.","schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/createdir":{"post":{"summary":"Creates a directory anywhere in the file system.","description":"If the directory already exists nothing will happen.\nIf permissions don't allow a directory to be created, or if the path is invalid, an error will be returned.","parameters":[{"name":"body","in":"body","schema":{"type":"object","properties":{"directory":{"type":"string","description":"Path to directory that should be created. Can be a relative or absolute path.","example":"/Users/joe/data/qvds/2020"}}}}],"responses":{"201":{"description":"Directory created.","schema":{"description":"Directory created.","type":"object","properties":{"directory":{"type":"string","description":"Directory that was created.","example":"/Users/joe/data/qvds/2020"}}}},"400":{"description":"Required parameter missing.","schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error (file system permissions etc).","schema":{"description":"Internal error (file system permissions etc).","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/keyvaluesnamespaces":{"get":{"summary":"List all currently defined namespaces.","responses":{"200":{"description":"Array of all namespaces.","schema":{"description":"Array of all namespaces.","type":"array","items":{"type":"string"},"example":["Weekly sales app","Sales ETL step 1","Sales ETL step 2"]}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/keyvalues/{namespace}":{"get":{"summary":"Get the value associated with a key, in a specific namespace.","parameters":[{"type":"string","description":"","example":"Last extract timestamp","required":true,"in":"query","name":"key"},{"type":"string","description":"","example":"Sales ETL step 2","required":true,"in":"path","name":"namespace"}],"responses":{"200":{"description":"Key and it's associated value and metadata returned.","schema":{"description":"Key and it's associated value and metadata returned.","type":"object","properties":{"namespace":{"type":"string","description":"Namespace name.","example":"Sales ETL step 2"},"key":{"type":"string","description":"Key name.","example":"Last extract timestamp"},"value":{"type":"string","description":"Value stored in the key-value pair.","example":"2020-09-29 17:14:56"}}}},"400":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","schema":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"post":{"summary":"Create a new key-value pair in the specified namespace.","description":"If the specified key already exists it will be overwritten.\n\nIf the posted data has a TTL, it will start counting when the post occur.\nI.e. if a previouly posted key also had a TTL, it will be replace with the most recent TTL.","parameters":[{"name":"body","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Key to use","example":"ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1"},"value":{"type":"string","description":"Value to set","example":"12345.789"},"ttl":{"type":"number","description":"Time to live = how long (milliseconds) the key-value pair should exist before being automatically deleted","example":10000}}}},{"type":"string","description":"Name of namespace.","example":"Sales ETL step 2","required":true,"in":"path","name":"namespace"}],"responses":{"201":{"description":"Key successfully set.","schema":{"description":"Key successfully set.","type":"object","properties":{"namespace":{"type":"string","description":"Name of namespace.","example":"Sales ETL step 2"},"key":{"type":"string","description":"Key name.","example":"Last extract timestamp"},"value":{"type":"string","description":"Value stored in the key-value pair.","example":"2020-09-29 17:14:56"},"ttl":{"type":"number","description":"Time-to-live for the key-value pair. 0 if no ttl was set, otherwise in milliseconds.","example":60000}}}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"delete":{"summary":"Delete a namespace and all key-value pairs in it.","parameters":[{"type":"string","description":"Name of namespace.","example":"Sales ETL step 2","required":true,"in":"path","name":"namespace"}],"responses":{"204":{"description":"Namespace successfully deleted.","schema":{"description":"Namespace successfully deleted.","type":"string","example":""}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/keyvalues/{namespace}/keyexists":{"get":{"summary":"Checks if a key exists in a namespace.","description":"Returns true if the specified key exists, otherwise false.","parameters":[{"type":"string","description":"","example":"Last extract timestamp","required":true,"in":"query","name":"key"},{"type":"string","description":"","example":"Sales ETL step 2","required":true,"in":"path","name":"namespace"}],"responses":{"200":{"description":"Key exist/no-exist returned, together with the data if the does exist.","schema":{"description":"Key exist/no-exist returned, together with the data if the does exist.","type":"object","properties":{"keyExists":{"type":"boolean","description":"true/false flag indicating whether the specified key exists in the given namespace."},"keyValue":{"type":"object","properties":{"namespace":{"type":"string","description":"Namespace name.","example":"Sales ETL step 2"},"key":{"type":"string","description":"Key name.","example":"Last extract timestamp"},"value":{"type":"string","description":"Value stored in the key-value pair.","example":"2020-09-29 17:14:56"}}}}}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/keyvalues/{namespace}/{key}":{"delete":{"summary":"Delete a key-value pair in a specific namespace.","parameters":[{"type":"string","description":"Name of namespace.","example":"Sales ETL step 2","required":true,"in":"path","name":"namespace"},{"type":"string","description":"Key to use","example":"ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1","required":true,"in":"path","name":"key"}],"responses":{"204":{"description":"Key-value pair successfully deleted.","schema":{"description":"Key-value pair successfully deleted.","type":"string","example":""}},"400":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","schema":{"description":"\"Namespace or key not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/keylist/{namespace}":{"get":{"summary":"Retrieve a list of all keys present in the specified namespace.","parameters":[{"type":"string","description":"Name of namespace whose keys should be returned.","example":"Sales ETL step 2","required":true,"in":"path","name":"namespace"}],"responses":{"200":{"description":"Object containing namespace name + list of allkeys in the namespace.","schema":{"description":"Object containing namespace name + list of allkeys in the namespace.","type":"object","properties":{"namespace":{"type":"string","description":"","example":"Sales ETL step 2"},"keys":{"type":"array","items":{"type":"object","key":{"type":"string"}},"example":[{"key":"ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1"},{"key":"ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_2"}]}}}},"400":{"description":"\"Namespace not found\" or \"Required parameter missing\".","schema":{"description":"\"Namespace not found\" or \"Required parameter missing\".","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/mqttpublishmessage":{"put":{"summary":"Publish a message to a MQTT topic.","parameters":[{"name":"body","in":"body","schema":{"type":"object","properties":{"topic":{"type":"string","description":"Topic to which message should be published.","example":"qliksense/new_data_notification/sales"},"message":{"type":"string","description":"The message is a generic text string and can thus contain anything that can be represented in a string, including JSON, key-value pairs, plain text etc.","example":"dt=20201028"}},"required":["topic","message"]}}],"responses":{"201":{"description":"MQTT message successfully published.","schema":{"description":"MQTT message successfully published.","type":"object","properties":{"topic":{"type":"string","example":"qliksense/new_data_notification/sales"},"message":{"type":"string","example":"dt=20201028"}}}},"400":{"description":"Required parameter missing.","schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/newrelic/metric":{"post":{"summary":"Post metrics to New Relic.","description":"This endpoint posts metrics to the New Relic metrics API.","parameters":[{"name":"body","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Metric name.","example":"memory.heap"},"type":{"type":"string","description":"Metric type. Valid options are count, distribution, gauge, summary.","example":"gauge"},"value":{"type":"number","description":"Value of the metric.","example":2.3},"timestamp":{"type":"number","description":"The metric's start time in Unix time. Uses UTC time zone. This field also support seconds, microseconds, and nanoseconds. However, the data will be converted to milliseconds for storage and query. Metrics reported with a timestamp older than 48 hours ago or newer than 24 hours from the time they are reported are dropped by New Relic. If left empty Butler will use the current time as timestamp.","example":1642164296053},"interval":{"type":"number","description":"The length of the time window. Required for count and summary metric types."},"attributes":{"type":"array","description":"Dimensions that will be associated with the metric.","items":{"type":"object","properties":{"name":{"type":"string","example":"host.name"},"value":{"type":"string","example":"dev.server.com"}}}}},"required":["name","type","value"]}}],"responses":{"202":{"description":"Data accepted and sent to New Relic.","schema":{"description":"Data accepted and sent to New Relic.","type":"object","properties":{"newRelicResultCode":{"type":"number","example":"202"},"newRelicResultText":{"type":"string","example":"Data accepted."}}}},"400":{"description":"Required parameter missing.","schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/schedules":{"get":{"summary":"Get all information available for existing schedule(s).","description":"If a schedule ID is specified using a query parameter (and there exists a schedule with that ID), information about that schedule will be returned.\nIf no schedule ID is specified, all schedules will be returned.","parameters":[{"type":"string","description":"Scheduld ID","example":"e4b1c455-aa15-4a51-a9cf-c5e4cfc91339","required":false,"in":"query","name":"id"}],"responses":{"200":{"description":"Schedule successfully retrieved.","schema":{"description":"Schedule successfully retrieved.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Schedule ID","example":"e4b1c455-aa15-4a51-a9cf-c5e4cfc91339"},"created":{"type":"string","description":"Timestamp when schedule was created","example":"2020-09-29T14:29:12.283Z"},"name":{"type":"string","description":"Schedule name.","example":"Reload sales metrics"},"cronSchedule":{"type":"string","description":"5 or 6 position cron schedule.\n\nIf 6 positions used, the leftmost position represent seconds.\nIf 5 positions used, leftmost position is minutes.\n\nThe example schedule will trigger at 00 and 30 minutes past 6:00 on Mon-Fri.","example":"0,30 6 * * 1-5"},"timezone":{"type":"string","description":"Time zone the schedule should use. Ex \"Europe/Stockholm\".","example":"Europe/Stockholm"},"qlikSenseTaskId":{"type":"string","description":"ID of Qlik Sense task that should be started when schedule triggers.","example":"210832b5-6174-4572-bd19-3e61eda675ef"},"startupState":{"type":"string","enum":["start","started","stop","stopped"],"description":"If set to \"start\" or \"started\", the schedule will be started upon creation. Otherwise it will remain in stopped state.","example":"started"},"tags":{"type":"array","items":{"type":"string"},"description":"Can be used to categorise schedules.","example":"[\"tag 1\", \"tag 2\"]"},"lastKnownState":{"type":"string","description":"Last known state (started/stopped) for the schedule.","enum":["started","stopped"],"example":"started"}}}}},"400":{"description":"Schedule not found.","schema":{"description":"Schedule not found.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"post":{"summary":"Create a new schedule.","parameters":[{"name":"body","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Descriptive name for the schedule.","example":"Reload sales metrics"},"cronSchedule":{"type":"string","description":"5 or 6 position cron schedule.\n\nIf 6 positions used, the leftmost position represent seconds.\nIf 5 positions used, leftmost position is minutes.\n\nThe example schedule will trigger at 00 and 30 minutes past 6:00 on Mon-Fri.","example":"0,30 6 * * 1-5"},"timezone":{"type":"string","description":"Time zone the schedule should use. Ex \"Europe/Stockholm\".","example":"Europe/Stockholm"},"qlikSenseTaskId":{"type":"string","description":"ID of Qlik Sense task that should be started when schedule triggers.","example":"210832b5-6174-4572-bd19-3e61eda675ef"},"startupState":{"type":"string","enum":["start","started","stop","stopped"],"description":"If set to \"start\" or \"started\", the schedule will be started upon creation. Otherwise it will remain in stopped state.","example":"started"},"tags":{"type":"array","items":{"type":"string"},"description":"Can be used to categorise schedules.","example":"[\"tag 1\", \"tag 2\"]"}},"required":["name","cronSchedule","timezone","qlikSenseTaskId","startupState"]}}],"responses":{"201":{"description":"Schedule successfully retrieved.","schema":{"description":"Schedule successfully retrieved.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Schedule ID","example":"e4b1c455-aa15-4a51-a9cf-c5e4cfc91339"},"created":{"type":"string","description":"Timestamp when schedule was created","example":"2020-09-29T14:29:12.283Z"},"name":{"type":"string","description":"Schedule name.","example":"Reload sales metrics"},"cronSchedule":{"type":"string","description":"5 or 6 position cron schedule.\n\nIf 6 positions used, the leftmost position represent seconds.\nIf 5 positions used, leftmost position is minutes.\n\nThe example schedule will trigger at 00 and 30 minutes past 6:00 on Mon-Fri.","example":"0,30 6 * * 1-5"},"timezone":{"type":"string","description":"Time zone the schedule should use. Ex \"Europe/Stockholm\".","example":"Europe/Stockholm"},"qlikSenseTaskId":{"type":"string","description":"ID of Qlik Sense task that should be started when schedule triggers.","example":"210832b5-6174-4572-bd19-3e61eda675ef"},"startupState":{"type":"string","enum":["start","started","stop","stopped"],"description":"If set to \"start\" or \"started\", the schedule will be started upon creation. Otherwise it will remain in stopped state.","example":"started"},"tags":{"type":"array","items":{"type":"string"},"description":"Can be used to categorise schedules.","example":"[\"tag 1\", \"tag 2\"]"},"lastKnownState":{"type":"string","enum":["start","started","stop","stopped"],"description":"Last known state of the schedule","example":"started"}}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/schedules/{scheduleId}":{"delete":{"summary":"Delete a schedule.","parameters":[{"type":"string","description":"Schedule ID.","example":"e4b1c455-aa15-4a51-a9cf-c5e4cfc91339","required":true,"in":"path","name":"scheduleId"}],"responses":{"204":{"description":"Schedule successfully deleted.","schema":{"description":"Schedule successfully deleted.","type":"string","example":""}},"400":{"description":"Schedule not found.","schema":{"description":"Schedule not found.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/schedules/{scheduleId}/start":{"put":{"summary":"Start a schedule.","description":"Start a schedule, i.e. have the scheduler run the associated reload task according to the schedule's cron settings.","parameters":[{"type":"string","description":"Schedule ID.","example":"e4b1c455-aa15-4a51-a9cf-c5e4cfc91339","required":true,"in":"path","name":"scheduleId"}],"responses":{"200":{"description":"Schedule successfully started.\n\nAn object with all information about the started schedule is returned.","schema":{"description":"Schedule successfully started.\n\nAn object with all information about the started schedule is returned.","type":"object","properties":{"id":{"type":"string","description":"Schedule ID","example":"e4b1c455-aa15-4a51-a9cf-c5e4cfc91339"},"created":{"type":"string","description":"Timestamp when schedule was created","example":"2020-09-29T14:29:12.283Z"},"name":{"type":"string","description":"Schedule name.","example":"Reload sales metrics"},"cronSchedule":{"type":"string","description":"5 or 6 position cron schedule.\n\nIf 6 positions used, the leftmost position represent seconds.\nIf 5 positions used, leftmost position is minutes.\n\nThe example schedule will trigger at 00 and 30 minutes past 6:00 on Mon-Fri.","example":"0,30 6 * * 1-5"},"timezone":{"type":"string","description":"Time zone the schedule should use. Ex \"Europe/Stockholm\".","example":"Europe/Stockholm"},"qlikSenseTaskId":{"type":"string","description":"ID of Qlik Sense task that should be started when schedule triggers.","example":"210832b5-6174-4572-bd19-3e61eda675ef"},"startupState":{"type":"string","enum":["start","started","stop","stopped"],"description":"If set to \"start\" or \"started\", the schedule will be started upon creation. Otherwise it will remain in stopped state.","example":"started"},"tags":{"type":"array","items":{"type":"string"},"description":"Can be used to categorise schedules.","example":"[\"tag 1\", \"tag 2\"]"},"lastKnownState":{"type":"string","description":"Last known state (started/stopped) for the schedule.","enum":["started","stopped"],"example":"started"}}}},"400":{"description":"Schedule not found.","schema":{"description":"Schedule not found.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/schedules/startall":{"put":{"summary":"Start all schedules.","description":"Start all schedules, i.e. tell the scheduler to run each schedule and start associated tasks according to each schedule's settings.","responses":{"200":{"description":"Schedules successfully started.\n\nAn array with all information about the started schedules is returned.","schema":{"description":"Schedules successfully started.\n\nAn array with all information about the started schedules is returned.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Schedule ID","example":"e4b1c455-aa15-4a51-a9cf-c5e4cfc91339"},"created":{"type":"string","description":"Timestamp when schedule was created","example":"2020-09-29T14:29:12.283Z"},"name":{"type":"string","description":"Schedule name.","example":"Reload sales metrics"},"cronSchedule":{"type":"string","description":"5 or 6 position cron schedule.\n\nIf 6 positions used, the leftmost position represent seconds.\nIf 5 positions used, leftmost position is minutes.\n\nThe example schedule will trigger at 00 and 30 minutes past 6:00 on Mon-Fri.","example":"0,30 6 * * 1-5"},"timezone":{"type":"string","description":"Time zone the schedule should use. Ex \"Europe/Stockholm\".","example":"Europe/Stockholm"},"qlikSenseTaskId":{"type":"string","description":"ID of Qlik Sense task that should be started when schedule triggers.","example":"210832b5-6174-4572-bd19-3e61eda675ef"},"startupState":{"type":"string","enum":["start","started","stop","stopped"],"description":"If set to \"start\" or \"started\", the schedule will be started upon creation. Otherwise it will remain in stopped state.","example":"started"},"tags":{"type":"array","items":{"type":"string"},"description":"Can be used to categorise schedules.","example":"[\"tag 1\", \"tag 2\"]"}}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/schedules/{scheduleId}/stop":{"put":{"summary":"Stop a schedule.","description":"Stop a schedule, i.e. tell the scheduler to no longer execute the schedule according to its cron settings.","parameters":[{"type":"string","description":"Schedule ID.","example":"e4b1c455-aa15-4a51-a9cf-c5e4cfc91339","required":true,"in":"path","name":"scheduleId"}],"responses":{"200":{"description":"Schedule successfully stopped.\n\nAn object with all information about the stopped schedule is returned.","schema":{"description":"Schedule successfully stopped.\n\nAn object with all information about the stopped schedule is returned.","type":"object","properties":{"id":{"type":"string","description":"Schedule ID","example":"e4b1c455-aa15-4a51-a9cf-c5e4cfc91339"},"created":{"type":"string","description":"Timestamp when schedule was created","example":"2020-09-29T14:29:12.283Z"},"name":{"type":"string","description":"Schedule name.","example":"Reload sales metrics"},"cronSchedule":{"type":"string","description":"5 or 6 position cron schedule.\n\nIf 6 positions used, the leftmost position represent seconds.\nIf 5 positions used, leftmost position is minutes.\n\nThe example schedule will trigger at 00 and 30 minutes past 6:00 on Mon-Fri.","example":"0,30 6 * * 1-5"},"timezone":{"type":"string","description":"Time zone the schedule should use. Ex \"Europe/Stockholm\".","example":"Europe/Stockholm"},"qlikSenseTaskId":{"type":"string","description":"ID of Qlik Sense task that should be started when schedule triggers.","example":"210832b5-6174-4572-bd19-3e61eda675ef"},"startupState":{"type":"string","enum":["start","started","stop","stopped"],"description":"If set to \"start\" or \"started\", the schedule will be started upon creation. Otherwise it will remain in stopped state.","example":"started"},"tags":{"type":"array","items":{"type":"string"},"description":"Can be used to categorise schedules.","example":"[\"tag 1\", \"tag 2\"]"},"lastKnownState":{"type":"string","description":"Last known state (started/stopped) for the schedule.","enum":["started","stopped"],"example":"started"}}}},"400":{"description":"Schedule not found.","schema":{"description":"Schedule not found.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/schedules/stopall":{"put":{"summary":"Stop all schedules.","description":"Stop all schedules, i.e. tell the scheduler to no longer execute any schedule according to its cron settings.","responses":{"200":{"description":"Schedules successfully stopped.\n\nAn array with all information about the stopped schedules is returned.","schema":{"description":"Schedules successfully stopped.\n\nAn array with all information about the stopped schedules is returned.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Schedule ID","example":"e4b1c455-aa15-4a51-a9cf-c5e4cfc91339"},"created":{"type":"string","description":"Timestamp when schedule was created","example":"2020-09-29T14:29:12.283Z"},"name":{"type":"string","description":"Schedule name.","example":"Reload sales metrics"},"cronSchedule":{"type":"string","description":"5 or 6 position cron schedule.\n\nIf 6 positions used, the leftmost position represent seconds.\nIf 5 positions used, leftmost position is minutes.\n\nThe example schedule will trigger at 00 and 30 minutes past 6:00 on Mon-Fri.","example":"0,30 6 * * 1-5"},"timezone":{"type":"string","description":"Time zone the schedule should use. Ex \"Europe/Stockholm\".","example":"Europe/Stockholm"},"qlikSenseTaskId":{"type":"string","description":"ID of Qlik Sense task that should be started when schedule triggers.","example":"210832b5-6174-4572-bd19-3e61eda675ef"},"startupState":{"type":"string","enum":["start","started","stop","stopped"],"description":"If set to \"start\" or \"started\", the schedule will be started upon creation. Otherwise it will remain in stopped state.","example":"started"},"tags":{"type":"array","items":{"type":"string"},"description":"Can be used to categorise schedules.","example":"[\"tag 1\", \"tag 2\"]"}}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/schedules/status":{"get":{"summary":"Get scheduler status.","description":"Get basic status from the core scheduler.\n\nNo schedule metadata beyond ID, cron setting and job state will be returned, but as this comes from the core scheduler it is the authorative truth about what jobs are running (and which ones are not).","produces":["text/plain"],"responses":{"200":{"description":"Status for all jobs that exist in the core scheduler.","schema":{"description":"Status for all jobs that exist in the core scheduler.","type":"string","example":"{\n'3702cec1-b6c8-463e-bda3-58d6a94dd9ac': * */2 * * * status: Running \n'2d5dcebc-2440-4bd7-9aa1-fb69708715c8': */45 * * * * * status: Running \n'a93ca0f3-7980-439b-9eda-723a167352e3': */10 * * * * * status: Running \n'ad250f49-ffd8-45dc-9b2b-f76028e969a4': */5 * * * * * status: Running \n}"}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/app/{appId}/reload":{"put":{"summary":"Do a stand-alone reload of a Qlik Sense app, without using a task.","parameters":[{"name":"body","in":"body","schema":{"type":"object","properties":{"reloadMode":{"type":"integer","description":"Reload mode that will be used. 0, 1 or 2. If not specified 0 will be used"},"partialReload":{"type":"boolean","description":"Should a full (=false) or partial (=true) reload be done? If not specified a full reload will be done.","example":true},"startQSEoWTaskOnSuccess":{"type":"array","description":"Array of task IDs that should be started when the app has successfully reloaded.","items":{"type":"string","minItems":0},"example":["09b3c78f-04dd-45e3-a4bf-1b074d6572fa","eaf1da4f-fd44-4cea-b2de-7b67a6496ee3"]},"startQSEoWTaskOnFailure":{"type":"array","description":"Array of task IDs that should be started if the app fails reloading.","items":{"type":"string","minItems":0},"example":["09b3c78f-04dd-45e3-a4bf-1b074d6572fa","eaf1da4f-fd44-4cea-b2de-7b67a6496ee3"]}}}},{"type":"string","description":"ID of Qlik Sense app.","example":"210832b5-6174-4572-bd19-3e61eda675ef","required":true,"in":"path","name":"appId"}],"responses":{"201":{"description":"App successfully reloaded.","schema":{"description":"App successfully reloaded.","type":"object","properties":{"appId":{"type":"string","description":"ID of reloaded app","example":"210832b5-6174-4572-bd19-3e61eda675ef"}}}},"400":{"description":"Required parameter missing.","schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/senseappdump/{appId}":{"get":{"summary":"Dump a Sense app to JSON.","description":"Does the same thing as `/v4/app/:appId/dump`","parameters":[{"type":"string","description":"ID of Qlik Sense app.","example":"210832b5-6174-4572-bd19-3e61eda675ef","required":true,"in":"path","name":"appId"}],"responses":{"200":{"description":"App dump successful. App metadata returned as JSON.","schema":{"description":"App dump successful. App metadata returned as JSON.","type":"object","example":{"properties":{},"loadScript":"","sheets":[],"stories":[],"masterobjects":[],"appprops":[],"dataconnections":[],"dimensions":[],"bookmarks":[],"embeddedmedia":[],"snapshots":[],"fields":[],"variables":[],"measures":[]}}},"400":{"description":"Required parameter missing.","schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"422":{"description":"App not found in Qlik Sense.","schema":{"description":"App not found in Qlik Sense.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/app/{appId}/dump":{"get":{"summary":"Dump a Sense app to JSON.","description":"Does the same thing as `/v4/senseappdump/:appId`","parameters":[{"type":"string","description":"ID of Qlik Sense app.","example":"210832b5-6174-4572-bd19-3e61eda675ef","required":true,"in":"path","name":"appId"}],"responses":{"200":{"description":"App dump successful. App metadata returned as JSON.","schema":{"description":"App dump successful. App metadata returned as JSON.","type":"object","example":{"properties":{},"loadScript":"","sheets":[],"stories":[],"masterobjects":[],"appprops":[],"dataconnections":[],"dimensions":[],"bookmarks":[],"embeddedmedia":[],"snapshots":[],"fields":[],"variables":[],"measures":[]}}},"400":{"description":"Required parameter missing.","schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"422":{"description":"App not found in Qlik Sense.","schema":{"description":"App not found in Qlik Sense.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/senselistapps":{"get":{"summary":"Get a list of all apps in Sense environment.","description":"Does the same thing as `/v4/apps/list`","responses":{"200":{"description":"App list successfully retrieved.","schema":{"description":"App list successfully retrieved.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"App ID","example":"5d7ae888-61cd-4539-97b2-6cf5baaa6f9d"},"name":{"type":"string","description":"App name","example":"2021 sales targets"}}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/apps/list":{"get":{"summary":"Get a list of all apps in Sense environment.","description":"Does the same thing as `/v4/senselistapps`","responses":{"200":{"description":"App list successfully retrieved.","schema":{"description":"App list successfully retrieved.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"App ID","example":"5d7ae888-61cd-4539-97b2-6cf5baaa6f9d"},"name":{"type":"string","description":"App name","example":"2021 sales targets"}}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/reloadtask/{taskId}/start":{"put":{"summary":"Start a Qlik Sense task.","description":"An optional array of zero or more objects can be passed in the message body. It is used to pass additional info related to the reload task being started.\n\nCurrently supported values in this array are:\n\n- A key-value pair that will be stored in Butler's KV store. If Butler's key-value store is not enabled, any key-value information passed in this parameter will simply be ignored.\nSetting `ttl=0` disables the TTL feature, i.e. the KV pair will not expire.\n- A task identified by its taskId that should be started.\n- Tasks identified by tags set on tasks in the QMC.\n- Tasks identified by custom properties set in the QMC.\n\nThis parameter uses a generic JSON/object format (type + payload).\nIt's thus possible to add new integrations in future Butler versions.","parameters":[{"type":"boolean","description":"If set to `true`, all specified taskIds must exist. If one or more taskIds does not exist in the Sense server, *no* tasks will be started.\n\nIf set to `false`, all existing taskIds will be started. Missing/invalid taskIds will be ignored.\n\nIn either case, missing/invalid taskIds will be reported in the result set back to the client calling the API.\n\nNote: Tasks started by specifying tags and/or custom properties are not affected by this.","example":true,"required":false,"in":"query","name":"allTaskIdsMustExist"},{"name":"body","in":"body","schema":{"type":"array","description":"Optional object with extra info.","items":{"type":"object","properties":{"type":{"type":"string","example":"keyvaluestore","enum":["keyvaluestore","starttaskid","starttasktag","starttaskcustomproperty"]},"payload":{"type":"object"}}},"example":[{"type":"starttaskid","payload":{"taskId":"7552d9fc-d1bb-4975-9a38-18357de531ea"}},{"type":"starttasktag","payload":{"tag":"startTask1"}},{"type":"starttaskcustomproperty","payload":{"customPropertyName":"taskGroup","customPropertyValue":"tasks2"}},{"type":"keyvaluestore","payload":{"namespace":"MyFineNamespace","key":"AnImportantKey","value":"TheValue","ttl":10000}}]}},{"type":"string","description":"ID of Qlik Sense task.\nButler will ignore the \"magic\" task ID of \"-\" (=dash, hyphen). This ID will not be reported as invalid.","example":"210832b5-6174-4572-bd19-3e61eda675ef","required":true,"in":"path","name":"taskId"}],"responses":{"200":{"description":"Task successfully started.","schema":{"description":"Task successfully started.","type":"object","example":{"tasksId":{"started":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"invalid":[{"taskId":"abc"}],"denied":[{"taskId":"a1a11a11-b1c0-4879-88fc-c7cdd9c1cf3e"}]},"tasksTag":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksTagDenied":[{"tag":"startTask_invalid1"}],"tasksCP":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksCPDenied":[{"name":"taskGroup","value":"cp_value_denied1"}]}}},"400":{"description":"Required parameter missing.","schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}},"post":{"summary":"Start a Qlik Sense task.","description":"An optional array of zero or more objects can be passed in the message body. It is used to pass additional info related to the reload task being started.\n\nCurrently supported values in this array are:\n\n- A key-value pair that will be stored in Butler's KV store. If Butler's key-value store is not enabled, any key-value information passed in this parameter will simply be ignored.\nSetting `ttl=0` disables the TTL feature, i.e. the KV pair will not expire.\n- A task identified by its taskId that should be started.\n- Tasks identified by tags set on tasks in the QMC.\n- Tasks identified by custom properties set in the QMC.\n\nThis parameter uses a generic JSON/object format (type + payload).\nIt's thus possible to add new integrations in future Butler versions.","parameters":[{"type":"boolean","description":"If set to `true`, all specified taskIds must exist. If one or more taskIds does not exist in the Sense server, *no* tasks will be started.\n\nIf set to `false`, all existing taskIds will be started. Missing/invalid taskIds will be ignored.\n\nIn either case, missing/invalid taskIds will be reported in the result set back to the client calling the API.\n\nNote: Tasks started by specifying tags and/or custom properties are not affected by this.","example":true,"required":false,"in":"query","name":"allTaskIdsMustExist"},{"name":"body","in":"body","schema":{"type":"array","description":"Optional object with extra info.","items":{"type":"object","properties":{"type":{"type":"string","example":"keyvaluestore","enum":["keyvaluestore","starttaskid","starttasktag","starttaskcustomproperty"]},"payload":{"type":"object"}}},"example":[{"type":"starttaskid","payload":{"taskId":"7552d9fc-d1bb-4975-9a38-18357de531ea"}},{"type":"starttasktag","payload":{"tag":"startTask1"}},{"type":"starttaskcustomproperty","payload":{"customPropertyName":"taskGroup","customPropertyValue":"tasks2"}},{"type":"keyvaluestore","payload":{"namespace":"MyFineNamespace","key":"AnImportantKey","value":"TheValue","ttl":10000}}]}},{"type":"string","description":"ID of Qlik Sense task.\nButler will ignore the \"magic\" task ID of \"-\" (=dash, hyphen). This ID will not be reported as invalid.","example":"210832b5-6174-4572-bd19-3e61eda675ef","required":true,"in":"path","name":"taskId"}],"responses":{"200":{"description":"Task successfully started.","schema":{"description":"Task successfully started.","type":"object","example":{"tasksId":{"started":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"invalid":[{"taskId":"abc"}],"denied":[{"taskId":"a1a11a11-b1c0-4879-88fc-c7cdd9c1cf3e"}]},"tasksTag":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksTagDenied":[{"tag":"startTask_invalid1"}],"tasksCP":[{"taskId":"e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e","taskName":"Reload task of App1"}],"tasksCPDenied":[{"name":"taskGroup","value":"cp_value_denied1"}]}}},"400":{"description":"Required parameter missing.","schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}},"/v4/slackpostmessage":{"put":{"summary":"Send message to Slack.","description":"Sends a basic message to Slack.","parameters":[{"name":"body","in":"body","schema":{"type":"object","properties":{"channel":{"type":"string","description":"Slack channel to post message into. Prefix channel name with #.","example":"#reload-notification"},"from_user":{"type":"string","description":"Name of sending user, as shown in the Slack message","example":"Butler the Bot"},"msg":{"type":"string","description":"Text going into the Slack message","example":"This is a message from Qlik Sense"},"emoji":{"type":"string","description":"Emoji to shown next to Slack message","example":"thumbsup"}},"required":["channel","from_user","msg"]}}],"responses":{"201":{"description":"Message successfully sent to Slack.","schema":{"description":"Message successfully sent to Slack.","type":"object","properties":{"channel":{"type":"string","description":"Slack channel to post message into. Prefix channel name with #.","example":"#reload-notification"},"from_user":{"type":"string","description":"Name of sending user, as shown in the Slack message","example":"Butler the Bot"},"msg":{"type":"string","description":"Text going into the Slack message","example":"This is a message from Qlik Sense"},"emoji":{"type":"string","description":"Emoji to shown next to Slack message","example":"thumbsup"}}}},"400":{"description":"Required parameter missing.","schema":{"description":"Required parameter missing.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}},"500":{"description":"Internal error.","schema":{"description":"Internal error.","type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"},"time":{"type":"string"}}}}}}}},"host":"192.168.1.168:8081","schemes":["http"],"produces":["application/json"],"externalDocs":{"url":"https://github.com/ptarmiganlabs","description":"Butler family of tools on GitHub"}} \ No newline at end of file diff --git a/docs/api_doc/butler-api.yaml b/docs/api_doc/butler-api.yaml new file mode 100644 index 00000000..07c81fc5 --- /dev/null +++ b/docs/api_doc/butler-api.yaml @@ -0,0 +1,2753 @@ +swagger: '2.0' +info: + title: Butler API documentation + description: >- + Butler is a microservice that provides add-on features to Qlik Sense + Enterprise on Windows. + + Butler offers both a REST API and things like failed reload notifications + etc. + + + This page contains the API documentation. Full documentation is available at + https://butler.ptarmiganlabs.com + version: 7.3.2 +definitions: {} +paths: + /v4/configfile/endpointsenabled: + get: + summary: Get an array of all enabled API endpoints. + description: >- + Get an array of all enabled API endpoints, using the key names from the + Butler config file. + + + Note: Endpoints are enabled/disabled in the Butler main configuration + file. + responses: + '200': + description: Enabled API enpooints. + schema: + description: Enabled API enpooints. + type: array + items: + type: string + example: + - activeUserCount + - activeUsers + - apiListEnbledEndpoints + /v4/base62tobase16: + get: + summary: Converts strings from base62 to base16. + description: Converts strings from base62 to base16. + parameters: + - type: string + description: The base62 encoded string that should be converted to base16 + example: 6DMW88LpSok9Z7P7hUK0wv7bF + required: true + in: query + name: base62 + responses: + '200': + description: Base conversion successful. + schema: + description: Base conversion successful. + type: object + properties: + base62: + type: string + description: The base62 encoded string that should be converted to base16 + base16: + type: string + description: Resulting base16 encoded string. + example: + base62: 6DMW88LpSok9Z7P7hUK0wv7bF + base16: 3199af08bfeeaf5d420f27ed9c01e74370077 + '400': + description: Required parameter missing. + schema: + description: Required parameter missing. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/base16tobase62: + get: + summary: Converts strings from base16 to base62. + description: Converts strings from base16 to base62. + parameters: + - type: string + description: The base16 encoded string that should be converted to base62 + example: 3199af08bfeeaf5d420f27ed9c01e74370077 + required: true + in: query + name: base16 + responses: + '200': + description: Base conversion successful. + schema: + description: Base conversion successful. + type: object + properties: + base62: + type: string + description: The base62 encoded string that should be converted to base16 + base16: + type: string + description: Resulting base62 encoded string. + example: + base16: 3199af08bfeeaf5d420f27ed9c01e74370077 + base62: 6DMW88LpSok9Z7P7hUK0wv7bF + '400': + description: Required parameter missing. + schema: + description: Required parameter missing. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/butlerping: + get: + summary: Tests if Butler is alive and responding + description: Tests if Butler is alive and responding + responses: + '200': + description: Butler is alive and well. + schema: + description: Butler is alive and well. + type: object + properties: + response: + type: string + example: Butler reporting for duty + butlerVersion: + type: string + example: 5.5.0 + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/filecopy: + put: + summary: Copy file(s) between well defined, approved locations. + description: >- + Copying of files is only posttible between pre-approved directories. + + Defining approved source and destination directories is done in Butler's + config file. + + + If the source directory contains subdirectories, these will be copied + too. + parameters: + - name: body + in: body + schema: + type: object + properties: + fromFile: + type: string + description: Name of source file. + example: subfolder/file1.qvd + toFile: + type: string + description: >- + Name of destination file. Can be different from source file + name, if needed. + example: archive/file1_20200925.qvd + overwrite: + type: boolean + description: >- + Controls whether destination file should be overwritten if it + already exists. Note that the copy operation will silently + fail if you set this to false and the destination exists. + Defaults to false. + example: false + preserveTimestamp: + type: boolean + description: >- + When true, the timestamp of the source file(s) will be + preserved on the destination file(s). When false, timestamp + behaviour is OS-dependent. Defaults to false. + example: false + responses: + '201': + description: File copied. + schema: + description: File copied. + type: object + properties: + fromFile: + type: string + description: Name of source file. + example: subfolder/file1.qvd + toFile: + type: string + description: >- + Name of destination file. Can be different from source file + name, if needed. + example: archive/file1_20200925.qvd + overwrite: + type: boolean + description: >- + Controls whether destination file should be overwritten if it + already exists. Note that the copy operation will silently + fail if you set this to false and the destination exists. + Defaults to false. + example: false + preserveTimestamp: + type: boolean + description: >- + When true, the timestamp of the source file(s) will be + preserved on the destination file(s). When false, timestamp + behaviour is OS-dependent. Defaults to false. + example: false + '400': + description: '"Required parameter missing" or "fromFile not found".' + schema: + description: '"Required parameter missing" or "fromFile not found".' + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '403': + description: No approved fromDir/toDir for file copy. + schema: + description: No approved fromDir/toDir for file copy. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/filemove: + put: + summary: Move file(s) between well defined, approved locations. + description: >- + Moving of files is only posttible between pre-approved directories. + + Defining approved source and destination directories is done in Butler's + config file. + + + If the source directory contains subdirectories, these will be moved + too. + parameters: + - name: body + in: body + schema: + type: object + properties: + fromFile: + type: string + description: Name of source file. + example: subfolder/file1.qvd + toFile: + type: string + description: >- + Name of destination file. Can be different from source file + name, if needed. + example: archive/file1_20200925.qvd + overwrite: + type: boolean + description: >- + Controls whether destination file should be overwritten if it + already exists. Defaults to false. + example: false + responses: + '201': + description: File moved. + schema: + description: File moved. + type: object + properties: + fromFile: + type: string + description: Name of source file. + example: subfolder/file1.qvd + toFile: + type: string + description: >- + Name of destination file. Can be different from source file + name, if needed. + example: archive/file1_20200925.qvd + overwrite: + type: boolean + description: >- + Controls whether destination file should be overwritten if it + already exists. Defaults to false. + example: false + '400': + description: '"Required parameter missing" or "fromFile not found".' + schema: + description: '"Required parameter missing" or "fromFile not found".' + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '403': + description: No approved fromDir/toDir for file copy. + schema: + description: No approved fromDir/toDir for file copy. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/filedelete: + delete: + summary: Delete file(s) in well defined, approved locations. + description: >- + It is only possible to delete files in pre-approved directories, or + subdirectories thereof. + + Defining approved directories is done in Butler's config file. + parameters: + - name: body + in: body + schema: + type: object + properties: + deleteFile: + type: string + description: >- + Name of file to be deleted. Use forward/backward slashes in + paths as needed, depending on whether Butler runs on + Windows/non-Windows platform. + example: data/qvdstore/sales/file1.qvd + responses: + '204': + description: File deleted. + schema: + description: File deleted. + type: object + '400': + description: >- + "Required parameter missing" or "File requested for delete not + found". + schema: + description: >- + "Required parameter missing" or "File requested for delete not + found". + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '403': + description: No approved directory matches the delete request. + schema: + description: No approved directory matches the delete request. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/createdirqvd: + post: + summary: Creates a directory in designated QVD directory. + description: >- + Creates a directory in QVD directory (which is defined in Butler's + config file). + parameters: + - name: body + in: body + schema: + type: object + properties: + directory: + type: string + description: Directory that should be created. + example: subfolder/2020-10 + responses: + '201': + description: Directory created. + schema: + description: Directory created. + type: object + properties: + directory: + type: string + description: Directory that was created. + example: subfolder/2020-10 + '400': + description: Required parameter missing. + schema: + description: Required parameter missing. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/createdir: + post: + summary: Creates a directory anywhere in the file system. + description: >- + If the directory already exists nothing will happen. + + If permissions don't allow a directory to be created, or if the path is + invalid, an error will be returned. + parameters: + - name: body + in: body + schema: + type: object + properties: + directory: + type: string + description: >- + Path to directory that should be created. Can be a relative or + absolute path. + example: /Users/joe/data/qvds/2020 + responses: + '201': + description: Directory created. + schema: + description: Directory created. + type: object + properties: + directory: + type: string + description: Directory that was created. + example: /Users/joe/data/qvds/2020 + '400': + description: Required parameter missing. + schema: + description: Required parameter missing. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error (file system permissions etc). + schema: + description: Internal error (file system permissions etc). + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/keyvaluesnamespaces: + get: + summary: List all currently defined namespaces. + responses: + '200': + description: Array of all namespaces. + schema: + description: Array of all namespaces. + type: array + items: + type: string + example: + - Weekly sales app + - Sales ETL step 1 + - Sales ETL step 2 + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/keyvalues/{namespace}: + get: + summary: Get the value associated with a key, in a specific namespace. + parameters: + - type: string + description: '' + example: Last extract timestamp + required: true + in: query + name: key + - type: string + description: '' + example: Sales ETL step 2 + required: true + in: path + name: namespace + responses: + '200': + description: Key and it's associated value and metadata returned. + schema: + description: Key and it's associated value and metadata returned. + type: object + properties: + namespace: + type: string + description: Namespace name. + example: Sales ETL step 2 + key: + type: string + description: Key name. + example: Last extract timestamp + value: + type: string + description: Value stored in the key-value pair. + example: '2020-09-29 17:14:56' + '400': + description: '"Namespace or key not found" or "Required parameter missing".' + schema: + description: '"Namespace or key not found" or "Required parameter missing".' + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + post: + summary: Create a new key-value pair in the specified namespace. + description: >- + If the specified key already exists it will be overwritten. + + + If the posted data has a TTL, it will start counting when the post + occur. + + I.e. if a previouly posted key also had a TTL, it will be replace with + the most recent TTL. + parameters: + - name: body + in: body + schema: + type: object + properties: + key: + type: string + description: Key to use + example: ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1 + value: + type: string + description: Value to set + example: '12345.789' + ttl: + type: number + description: >- + Time to live = how long (milliseconds) the key-value pair + should exist before being automatically deleted + example: 10000 + - type: string + description: Name of namespace. + example: Sales ETL step 2 + required: true + in: path + name: namespace + responses: + '201': + description: Key successfully set. + schema: + description: Key successfully set. + type: object + properties: + namespace: + type: string + description: Name of namespace. + example: Sales ETL step 2 + key: + type: string + description: Key name. + example: Last extract timestamp + value: + type: string + description: Value stored in the key-value pair. + example: '2020-09-29 17:14:56' + ttl: + type: number + description: >- + Time-to-live for the key-value pair. 0 if no ttl was set, + otherwise in milliseconds. + example: 60000 + '400': + description: '"Namespace not found" or "Required parameter missing".' + schema: + description: '"Namespace not found" or "Required parameter missing".' + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + delete: + summary: Delete a namespace and all key-value pairs in it. + parameters: + - type: string + description: Name of namespace. + example: Sales ETL step 2 + required: true + in: path + name: namespace + responses: + '204': + description: Namespace successfully deleted. + schema: + description: Namespace successfully deleted. + type: string + example: '' + '400': + description: '"Namespace not found" or "Required parameter missing".' + schema: + description: '"Namespace not found" or "Required parameter missing".' + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/keyvalues/{namespace}/keyexists: + get: + summary: Checks if a key exists in a namespace. + description: Returns true if the specified key exists, otherwise false. + parameters: + - type: string + description: '' + example: Last extract timestamp + required: true + in: query + name: key + - type: string + description: '' + example: Sales ETL step 2 + required: true + in: path + name: namespace + responses: + '200': + description: >- + Key exist/no-exist returned, together with the data if the does + exist. + schema: + description: >- + Key exist/no-exist returned, together with the data if the does + exist. + type: object + properties: + keyExists: + type: boolean + description: >- + true/false flag indicating whether the specified key exists in + the given namespace. + keyValue: + type: object + properties: + namespace: + type: string + description: Namespace name. + example: Sales ETL step 2 + key: + type: string + description: Key name. + example: Last extract timestamp + value: + type: string + description: Value stored in the key-value pair. + example: '2020-09-29 17:14:56' + '400': + description: '"Namespace not found" or "Required parameter missing".' + schema: + description: '"Namespace not found" or "Required parameter missing".' + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/keyvalues/{namespace}/{key}: + delete: + summary: Delete a key-value pair in a specific namespace. + parameters: + - type: string + description: Name of namespace. + example: Sales ETL step 2 + required: true + in: path + name: namespace + - type: string + description: Key to use + example: ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1 + required: true + in: path + name: key + responses: + '204': + description: Key-value pair successfully deleted. + schema: + description: Key-value pair successfully deleted. + type: string + example: '' + '400': + description: '"Namespace or key not found" or "Required parameter missing".' + schema: + description: '"Namespace or key not found" or "Required parameter missing".' + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/keylist/{namespace}: + get: + summary: Retrieve a list of all keys present in the specified namespace. + parameters: + - type: string + description: Name of namespace whose keys should be returned. + example: Sales ETL step 2 + required: true + in: path + name: namespace + responses: + '200': + description: Object containing namespace name + list of allkeys in the namespace. + schema: + description: >- + Object containing namespace name + list of allkeys in the + namespace. + type: object + properties: + namespace: + type: string + description: '' + example: Sales ETL step 2 + keys: + type: array + items: + type: object + key: + type: string + example: + - key: ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_1 + - key: ce68c8ca-b3ff-4371-8285-7c9ce5040e42_parameter_2 + '400': + description: '"Namespace not found" or "Required parameter missing".' + schema: + description: '"Namespace not found" or "Required parameter missing".' + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/mqttpublishmessage: + put: + summary: Publish a message to a MQTT topic. + parameters: + - name: body + in: body + schema: + type: object + properties: + topic: + type: string + description: Topic to which message should be published. + example: qliksense/new_data_notification/sales + message: + type: string + description: >- + The message is a generic text string and can thus contain + anything that can be represented in a string, including JSON, + key-value pairs, plain text etc. + example: dt=20201028 + required: + - topic + - message + responses: + '201': + description: MQTT message successfully published. + schema: + description: MQTT message successfully published. + type: object + properties: + topic: + type: string + example: qliksense/new_data_notification/sales + message: + type: string + example: dt=20201028 + '400': + description: Required parameter missing. + schema: + description: Required parameter missing. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/newrelic/metric: + post: + summary: Post metrics to New Relic. + description: This endpoint posts metrics to the New Relic metrics API. + parameters: + - name: body + in: body + schema: + type: object + properties: + name: + type: string + description: Metric name. + example: memory.heap + type: + type: string + description: >- + Metric type. Valid options are count, distribution, gauge, + summary. + example: gauge + value: + type: number + description: Value of the metric. + example: 2.3 + timestamp: + type: number + description: >- + The metric's start time in Unix time. Uses UTC time zone. This + field also support seconds, microseconds, and nanoseconds. + However, the data will be converted to milliseconds for + storage and query. Metrics reported with a timestamp older + than 48 hours ago or newer than 24 hours from the time they + are reported are dropped by New Relic. If left empty Butler + will use the current time as timestamp. + example: 1642164296053 + interval: + type: number + description: >- + The length of the time window. Required for count and summary + metric types. + attributes: + type: array + description: Dimensions that will be associated with the metric. + items: + type: object + properties: + name: + type: string + example: host.name + value: + type: string + example: dev.server.com + required: + - name + - type + - value + responses: + '202': + description: Data accepted and sent to New Relic. + schema: + description: Data accepted and sent to New Relic. + type: object + properties: + newRelicResultCode: + type: number + example: '202' + newRelicResultText: + type: string + example: Data accepted. + '400': + description: Required parameter missing. + schema: + description: Required parameter missing. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/schedules: + get: + summary: Get all information available for existing schedule(s). + description: >- + If a schedule ID is specified using a query parameter (and there exists + a schedule with that ID), information about that schedule will be + returned. + + If no schedule ID is specified, all schedules will be returned. + parameters: + - type: string + description: Scheduld ID + example: e4b1c455-aa15-4a51-a9cf-c5e4cfc91339 + required: false + in: query + name: id + responses: + '200': + description: Schedule successfully retrieved. + schema: + description: Schedule successfully retrieved. + type: array + items: + type: object + properties: + id: + type: string + description: Schedule ID + example: e4b1c455-aa15-4a51-a9cf-c5e4cfc91339 + created: + type: string + description: Timestamp when schedule was created + example: '2020-09-29T14:29:12.283Z' + name: + type: string + description: Schedule name. + example: Reload sales metrics + cronSchedule: + type: string + description: >- + 5 or 6 position cron schedule. + + + If 6 positions used, the leftmost position represent + seconds. + + If 5 positions used, leftmost position is minutes. + + + The example schedule will trigger at 00 and 30 minutes past + 6:00 on Mon-Fri. + example: 0,30 6 * * 1-5 + timezone: + type: string + description: Time zone the schedule should use. Ex "Europe/Stockholm". + example: Europe/Stockholm + qlikSenseTaskId: + type: string + description: >- + ID of Qlik Sense task that should be started when schedule + triggers. + example: 210832b5-6174-4572-bd19-3e61eda675ef + startupState: + type: string + enum: + - start + - started + - stop + - stopped + description: >- + If set to "start" or "started", the schedule will be started + upon creation. Otherwise it will remain in stopped state. + example: started + tags: + type: array + items: + type: string + description: Can be used to categorise schedules. + example: '["tag 1", "tag 2"]' + lastKnownState: + type: string + description: Last known state (started/stopped) for the schedule. + enum: + - started + - stopped + example: started + '400': + description: Schedule not found. + schema: + description: Schedule not found. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + post: + summary: Create a new schedule. + parameters: + - name: body + in: body + schema: + type: object + properties: + name: + type: string + description: Descriptive name for the schedule. + example: Reload sales metrics + cronSchedule: + type: string + description: >- + 5 or 6 position cron schedule. + + + If 6 positions used, the leftmost position represent seconds. + + If 5 positions used, leftmost position is minutes. + + + The example schedule will trigger at 00 and 30 minutes past + 6:00 on Mon-Fri. + example: 0,30 6 * * 1-5 + timezone: + type: string + description: Time zone the schedule should use. Ex "Europe/Stockholm". + example: Europe/Stockholm + qlikSenseTaskId: + type: string + description: >- + ID of Qlik Sense task that should be started when schedule + triggers. + example: 210832b5-6174-4572-bd19-3e61eda675ef + startupState: + type: string + enum: + - start + - started + - stop + - stopped + description: >- + If set to "start" or "started", the schedule will be started + upon creation. Otherwise it will remain in stopped state. + example: started + tags: + type: array + items: + type: string + description: Can be used to categorise schedules. + example: '["tag 1", "tag 2"]' + required: + - name + - cronSchedule + - timezone + - qlikSenseTaskId + - startupState + responses: + '201': + description: Schedule successfully retrieved. + schema: + description: Schedule successfully retrieved. + type: array + items: + type: object + properties: + id: + type: string + description: Schedule ID + example: e4b1c455-aa15-4a51-a9cf-c5e4cfc91339 + created: + type: string + description: Timestamp when schedule was created + example: '2020-09-29T14:29:12.283Z' + name: + type: string + description: Schedule name. + example: Reload sales metrics + cronSchedule: + type: string + description: >- + 5 or 6 position cron schedule. + + + If 6 positions used, the leftmost position represent + seconds. + + If 5 positions used, leftmost position is minutes. + + + The example schedule will trigger at 00 and 30 minutes past + 6:00 on Mon-Fri. + example: 0,30 6 * * 1-5 + timezone: + type: string + description: Time zone the schedule should use. Ex "Europe/Stockholm". + example: Europe/Stockholm + qlikSenseTaskId: + type: string + description: >- + ID of Qlik Sense task that should be started when schedule + triggers. + example: 210832b5-6174-4572-bd19-3e61eda675ef + startupState: + type: string + enum: + - start + - started + - stop + - stopped + description: >- + If set to "start" or "started", the schedule will be started + upon creation. Otherwise it will remain in stopped state. + example: started + tags: + type: array + items: + type: string + description: Can be used to categorise schedules. + example: '["tag 1", "tag 2"]' + lastKnownState: + type: string + enum: + - start + - started + - stop + - stopped + description: Last known state of the schedule + example: started + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/schedules/{scheduleId}: + delete: + summary: Delete a schedule. + parameters: + - type: string + description: Schedule ID. + example: e4b1c455-aa15-4a51-a9cf-c5e4cfc91339 + required: true + in: path + name: scheduleId + responses: + '204': + description: Schedule successfully deleted. + schema: + description: Schedule successfully deleted. + type: string + example: '' + '400': + description: Schedule not found. + schema: + description: Schedule not found. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/schedules/{scheduleId}/start: + put: + summary: Start a schedule. + description: >- + Start a schedule, i.e. have the scheduler run the associated reload task + according to the schedule's cron settings. + parameters: + - type: string + description: Schedule ID. + example: e4b1c455-aa15-4a51-a9cf-c5e4cfc91339 + required: true + in: path + name: scheduleId + responses: + '200': + description: >- + Schedule successfully started. + + + An object with all information about the started schedule is + returned. + schema: + description: >- + Schedule successfully started. + + + An object with all information about the started schedule is + returned. + type: object + properties: + id: + type: string + description: Schedule ID + example: e4b1c455-aa15-4a51-a9cf-c5e4cfc91339 + created: + type: string + description: Timestamp when schedule was created + example: '2020-09-29T14:29:12.283Z' + name: + type: string + description: Schedule name. + example: Reload sales metrics + cronSchedule: + type: string + description: >- + 5 or 6 position cron schedule. + + + If 6 positions used, the leftmost position represent seconds. + + If 5 positions used, leftmost position is minutes. + + + The example schedule will trigger at 00 and 30 minutes past + 6:00 on Mon-Fri. + example: 0,30 6 * * 1-5 + timezone: + type: string + description: Time zone the schedule should use. Ex "Europe/Stockholm". + example: Europe/Stockholm + qlikSenseTaskId: + type: string + description: >- + ID of Qlik Sense task that should be started when schedule + triggers. + example: 210832b5-6174-4572-bd19-3e61eda675ef + startupState: + type: string + enum: + - start + - started + - stop + - stopped + description: >- + If set to "start" or "started", the schedule will be started + upon creation. Otherwise it will remain in stopped state. + example: started + tags: + type: array + items: + type: string + description: Can be used to categorise schedules. + example: '["tag 1", "tag 2"]' + lastKnownState: + type: string + description: Last known state (started/stopped) for the schedule. + enum: + - started + - stopped + example: started + '400': + description: Schedule not found. + schema: + description: Schedule not found. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/schedules/startall: + put: + summary: Start all schedules. + description: >- + Start all schedules, i.e. tell the scheduler to run each schedule and + start associated tasks according to each schedule's settings. + responses: + '200': + description: >- + Schedules successfully started. + + + An array with all information about the started schedules is + returned. + schema: + description: >- + Schedules successfully started. + + + An array with all information about the started schedules is + returned. + type: array + items: + type: object + properties: + id: + type: string + description: Schedule ID + example: e4b1c455-aa15-4a51-a9cf-c5e4cfc91339 + created: + type: string + description: Timestamp when schedule was created + example: '2020-09-29T14:29:12.283Z' + name: + type: string + description: Schedule name. + example: Reload sales metrics + cronSchedule: + type: string + description: >- + 5 or 6 position cron schedule. + + + If 6 positions used, the leftmost position represent + seconds. + + If 5 positions used, leftmost position is minutes. + + + The example schedule will trigger at 00 and 30 minutes past + 6:00 on Mon-Fri. + example: 0,30 6 * * 1-5 + timezone: + type: string + description: Time zone the schedule should use. Ex "Europe/Stockholm". + example: Europe/Stockholm + qlikSenseTaskId: + type: string + description: >- + ID of Qlik Sense task that should be started when schedule + triggers. + example: 210832b5-6174-4572-bd19-3e61eda675ef + startupState: + type: string + enum: + - start + - started + - stop + - stopped + description: >- + If set to "start" or "started", the schedule will be started + upon creation. Otherwise it will remain in stopped state. + example: started + tags: + type: array + items: + type: string + description: Can be used to categorise schedules. + example: '["tag 1", "tag 2"]' + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/schedules/{scheduleId}/stop: + put: + summary: Stop a schedule. + description: >- + Stop a schedule, i.e. tell the scheduler to no longer execute the + schedule according to its cron settings. + parameters: + - type: string + description: Schedule ID. + example: e4b1c455-aa15-4a51-a9cf-c5e4cfc91339 + required: true + in: path + name: scheduleId + responses: + '200': + description: >- + Schedule successfully stopped. + + + An object with all information about the stopped schedule is + returned. + schema: + description: >- + Schedule successfully stopped. + + + An object with all information about the stopped schedule is + returned. + type: object + properties: + id: + type: string + description: Schedule ID + example: e4b1c455-aa15-4a51-a9cf-c5e4cfc91339 + created: + type: string + description: Timestamp when schedule was created + example: '2020-09-29T14:29:12.283Z' + name: + type: string + description: Schedule name. + example: Reload sales metrics + cronSchedule: + type: string + description: >- + 5 or 6 position cron schedule. + + + If 6 positions used, the leftmost position represent seconds. + + If 5 positions used, leftmost position is minutes. + + + The example schedule will trigger at 00 and 30 minutes past + 6:00 on Mon-Fri. + example: 0,30 6 * * 1-5 + timezone: + type: string + description: Time zone the schedule should use. Ex "Europe/Stockholm". + example: Europe/Stockholm + qlikSenseTaskId: + type: string + description: >- + ID of Qlik Sense task that should be started when schedule + triggers. + example: 210832b5-6174-4572-bd19-3e61eda675ef + startupState: + type: string + enum: + - start + - started + - stop + - stopped + description: >- + If set to "start" or "started", the schedule will be started + upon creation. Otherwise it will remain in stopped state. + example: started + tags: + type: array + items: + type: string + description: Can be used to categorise schedules. + example: '["tag 1", "tag 2"]' + lastKnownState: + type: string + description: Last known state (started/stopped) for the schedule. + enum: + - started + - stopped + example: started + '400': + description: Schedule not found. + schema: + description: Schedule not found. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/schedules/stopall: + put: + summary: Stop all schedules. + description: >- + Stop all schedules, i.e. tell the scheduler to no longer execute any + schedule according to its cron settings. + responses: + '200': + description: >- + Schedules successfully stopped. + + + An array with all information about the stopped schedules is + returned. + schema: + description: >- + Schedules successfully stopped. + + + An array with all information about the stopped schedules is + returned. + type: array + items: + type: object + properties: + id: + type: string + description: Schedule ID + example: e4b1c455-aa15-4a51-a9cf-c5e4cfc91339 + created: + type: string + description: Timestamp when schedule was created + example: '2020-09-29T14:29:12.283Z' + name: + type: string + description: Schedule name. + example: Reload sales metrics + cronSchedule: + type: string + description: >- + 5 or 6 position cron schedule. + + + If 6 positions used, the leftmost position represent + seconds. + + If 5 positions used, leftmost position is minutes. + + + The example schedule will trigger at 00 and 30 minutes past + 6:00 on Mon-Fri. + example: 0,30 6 * * 1-5 + timezone: + type: string + description: Time zone the schedule should use. Ex "Europe/Stockholm". + example: Europe/Stockholm + qlikSenseTaskId: + type: string + description: >- + ID of Qlik Sense task that should be started when schedule + triggers. + example: 210832b5-6174-4572-bd19-3e61eda675ef + startupState: + type: string + enum: + - start + - started + - stop + - stopped + description: >- + If set to "start" or "started", the schedule will be started + upon creation. Otherwise it will remain in stopped state. + example: started + tags: + type: array + items: + type: string + description: Can be used to categorise schedules. + example: '["tag 1", "tag 2"]' + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/schedules/status: + get: + summary: Get scheduler status. + description: >- + Get basic status from the core scheduler. + + + No schedule metadata beyond ID, cron setting and job state will be + returned, but as this comes from the core scheduler it is the + authorative truth about what jobs are running (and which ones are not). + produces: + - text/plain + responses: + '200': + description: Status for all jobs that exist in the core scheduler. + schema: + description: Status for all jobs that exist in the core scheduler. + type: string + example: >- + { + + '3702cec1-b6c8-463e-bda3-58d6a94dd9ac': * */2 * * * status: + Running + + '2d5dcebc-2440-4bd7-9aa1-fb69708715c8': */45 * * * * * status: + Running + + 'a93ca0f3-7980-439b-9eda-723a167352e3': */10 * * * * * status: + Running + + 'ad250f49-ffd8-45dc-9b2b-f76028e969a4': */5 * * * * * status: + Running + + } + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/app/{appId}/reload: + put: + summary: Do a stand-alone reload of a Qlik Sense app, without using a task. + parameters: + - name: body + in: body + schema: + type: object + properties: + reloadMode: + type: integer + description: >- + Reload mode that will be used. 0, 1 or 2. If not specified 0 + will be used + partialReload: + type: boolean + description: >- + Should a full (=false) or partial (=true) reload be done? If + not specified a full reload will be done. + example: true + startQSEoWTaskOnSuccess: + type: array + description: >- + Array of task IDs that should be started when the app has + successfully reloaded. + items: + type: string + minItems: 0 + example: + - 09b3c78f-04dd-45e3-a4bf-1b074d6572fa + - eaf1da4f-fd44-4cea-b2de-7b67a6496ee3 + startQSEoWTaskOnFailure: + type: array + description: >- + Array of task IDs that should be started if the app fails + reloading. + items: + type: string + minItems: 0 + example: + - 09b3c78f-04dd-45e3-a4bf-1b074d6572fa + - eaf1da4f-fd44-4cea-b2de-7b67a6496ee3 + - type: string + description: ID of Qlik Sense app. + example: 210832b5-6174-4572-bd19-3e61eda675ef + required: true + in: path + name: appId + responses: + '201': + description: App successfully reloaded. + schema: + description: App successfully reloaded. + type: object + properties: + appId: + type: string + description: ID of reloaded app + example: 210832b5-6174-4572-bd19-3e61eda675ef + '400': + description: Required parameter missing. + schema: + description: Required parameter missing. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/senseappdump/{appId}: + get: + summary: Dump a Sense app to JSON. + description: Does the same thing as `/v4/app/:appId/dump` + parameters: + - type: string + description: ID of Qlik Sense app. + example: 210832b5-6174-4572-bd19-3e61eda675ef + required: true + in: path + name: appId + responses: + '200': + description: App dump successful. App metadata returned as JSON. + schema: + description: App dump successful. App metadata returned as JSON. + type: object + example: + properties: {} + loadScript: '' + sheets: [] + stories: [] + masterobjects: [] + appprops: [] + dataconnections: [] + dimensions: [] + bookmarks: [] + embeddedmedia: [] + snapshots: [] + fields: [] + variables: [] + measures: [] + '400': + description: Required parameter missing. + schema: + description: Required parameter missing. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '422': + description: App not found in Qlik Sense. + schema: + description: App not found in Qlik Sense. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/app/{appId}/dump: + get: + summary: Dump a Sense app to JSON. + description: Does the same thing as `/v4/senseappdump/:appId` + parameters: + - type: string + description: ID of Qlik Sense app. + example: 210832b5-6174-4572-bd19-3e61eda675ef + required: true + in: path + name: appId + responses: + '200': + description: App dump successful. App metadata returned as JSON. + schema: + description: App dump successful. App metadata returned as JSON. + type: object + example: + properties: {} + loadScript: '' + sheets: [] + stories: [] + masterobjects: [] + appprops: [] + dataconnections: [] + dimensions: [] + bookmarks: [] + embeddedmedia: [] + snapshots: [] + fields: [] + variables: [] + measures: [] + '400': + description: Required parameter missing. + schema: + description: Required parameter missing. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '422': + description: App not found in Qlik Sense. + schema: + description: App not found in Qlik Sense. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/senselistapps: + get: + summary: Get a list of all apps in Sense environment. + description: Does the same thing as `/v4/apps/list` + responses: + '200': + description: App list successfully retrieved. + schema: + description: App list successfully retrieved. + type: array + items: + type: object + properties: + id: + type: string + description: App ID + example: 5d7ae888-61cd-4539-97b2-6cf5baaa6f9d + name: + type: string + description: App name + example: 2021 sales targets + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/apps/list: + get: + summary: Get a list of all apps in Sense environment. + description: Does the same thing as `/v4/senselistapps` + responses: + '200': + description: App list successfully retrieved. + schema: + description: App list successfully retrieved. + type: array + items: + type: object + properties: + id: + type: string + description: App ID + example: 5d7ae888-61cd-4539-97b2-6cf5baaa6f9d + name: + type: string + description: App name + example: 2021 sales targets + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/reloadtask/{taskId}/start: + put: + summary: Start a Qlik Sense task. + description: >- + An optional array of zero or more objects can be passed in the message + body. It is used to pass additional info related to the reload task + being started. + + + Currently supported values in this array are: + + + - A key-value pair that will be stored in Butler's KV store. If Butler's + key-value store is not enabled, any key-value information passed in this + parameter will simply be ignored. + + Setting `ttl=0` disables the TTL feature, i.e. the KV pair will not + expire. + + - A task identified by its taskId that should be started. + + - Tasks identified by tags set on tasks in the QMC. + + - Tasks identified by custom properties set in the QMC. + + + This parameter uses a generic JSON/object format (type + payload). + + It's thus possible to add new integrations in future Butler versions. + parameters: + - type: boolean + description: >- + If set to `true`, all specified taskIds must exist. If one or more + taskIds does not exist in the Sense server, *no* tasks will be + started. + + + If set to `false`, all existing taskIds will be started. + Missing/invalid taskIds will be ignored. + + + In either case, missing/invalid taskIds will be reported in the + result set back to the client calling the API. + + + Note: Tasks started by specifying tags and/or custom properties are + not affected by this. + example: true + required: false + in: query + name: allTaskIdsMustExist + - name: body + in: body + schema: + type: array + description: Optional object with extra info. + items: + type: object + properties: + type: + type: string + example: keyvaluestore + enum: + - keyvaluestore + - starttaskid + - starttasktag + - starttaskcustomproperty + payload: + type: object + example: + - type: starttaskid + payload: + taskId: 7552d9fc-d1bb-4975-9a38-18357de531ea + - type: starttasktag + payload: + tag: startTask1 + - type: starttaskcustomproperty + payload: + customPropertyName: taskGroup + customPropertyValue: tasks2 + - type: keyvaluestore + payload: + namespace: MyFineNamespace + key: AnImportantKey + value: TheValue + ttl: 10000 + - type: string + description: >- + ID of Qlik Sense task. + + Butler will ignore the "magic" task ID of "-" (=dash, hyphen). This + ID will not be reported as invalid. + example: 210832b5-6174-4572-bd19-3e61eda675ef + required: true + in: path + name: taskId + responses: + '200': + description: Task successfully started. + schema: + description: Task successfully started. + type: object + example: + tasksId: + started: + - taskId: e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e + taskName: Reload task of App1 + invalid: + - taskId: abc + denied: + - taskId: a1a11a11-b1c0-4879-88fc-c7cdd9c1cf3e + tasksTag: + - taskId: e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e + taskName: Reload task of App1 + tasksTagDenied: + - tag: startTask_invalid1 + tasksCP: + - taskId: e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e + taskName: Reload task of App1 + tasksCPDenied: + - name: taskGroup + value: cp_value_denied1 + '400': + description: Required parameter missing. + schema: + description: Required parameter missing. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + post: + summary: Start a Qlik Sense task. + description: >- + An optional array of zero or more objects can be passed in the message + body. It is used to pass additional info related to the reload task + being started. + + + Currently supported values in this array are: + + + - A key-value pair that will be stored in Butler's KV store. If Butler's + key-value store is not enabled, any key-value information passed in this + parameter will simply be ignored. + + Setting `ttl=0` disables the TTL feature, i.e. the KV pair will not + expire. + + - A task identified by its taskId that should be started. + + - Tasks identified by tags set on tasks in the QMC. + + - Tasks identified by custom properties set in the QMC. + + + This parameter uses a generic JSON/object format (type + payload). + + It's thus possible to add new integrations in future Butler versions. + parameters: + - type: boolean + description: >- + If set to `true`, all specified taskIds must exist. If one or more + taskIds does not exist in the Sense server, *no* tasks will be + started. + + + If set to `false`, all existing taskIds will be started. + Missing/invalid taskIds will be ignored. + + + In either case, missing/invalid taskIds will be reported in the + result set back to the client calling the API. + + + Note: Tasks started by specifying tags and/or custom properties are + not affected by this. + example: true + required: false + in: query + name: allTaskIdsMustExist + - name: body + in: body + schema: + type: array + description: Optional object with extra info. + items: + type: object + properties: + type: + type: string + example: keyvaluestore + enum: + - keyvaluestore + - starttaskid + - starttasktag + - starttaskcustomproperty + payload: + type: object + example: + - type: starttaskid + payload: + taskId: 7552d9fc-d1bb-4975-9a38-18357de531ea + - type: starttasktag + payload: + tag: startTask1 + - type: starttaskcustomproperty + payload: + customPropertyName: taskGroup + customPropertyValue: tasks2 + - type: keyvaluestore + payload: + namespace: MyFineNamespace + key: AnImportantKey + value: TheValue + ttl: 10000 + - type: string + description: >- + ID of Qlik Sense task. + + Butler will ignore the "magic" task ID of "-" (=dash, hyphen). This + ID will not be reported as invalid. + example: 210832b5-6174-4572-bd19-3e61eda675ef + required: true + in: path + name: taskId + responses: + '200': + description: Task successfully started. + schema: + description: Task successfully started. + type: object + example: + tasksId: + started: + - taskId: e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e + taskName: Reload task of App1 + invalid: + - taskId: abc + denied: + - taskId: a1a11a11-b1c0-4879-88fc-c7cdd9c1cf3e + tasksTag: + - taskId: e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e + taskName: Reload task of App1 + tasksTagDenied: + - tag: startTask_invalid1 + tasksCP: + - taskId: e3b27f50-b1c0-4879-88fc-c7cdd9c1cf3e + taskName: Reload task of App1 + tasksCPDenied: + - name: taskGroup + value: cp_value_denied1 + '400': + description: Required parameter missing. + schema: + description: Required parameter missing. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + /v4/slackpostmessage: + put: + summary: Send message to Slack. + description: Sends a basic message to Slack. + parameters: + - name: body + in: body + schema: + type: object + properties: + channel: + type: string + description: >- + Slack channel to post message into. Prefix channel name with + #. + example: '#reload-notification' + from_user: + type: string + description: Name of sending user, as shown in the Slack message + example: Butler the Bot + msg: + type: string + description: Text going into the Slack message + example: This is a message from Qlik Sense + emoji: + type: string + description: Emoji to shown next to Slack message + example: thumbsup + required: + - channel + - from_user + - msg + responses: + '201': + description: Message successfully sent to Slack. + schema: + description: Message successfully sent to Slack. + type: object + properties: + channel: + type: string + description: >- + Slack channel to post message into. Prefix channel name with + #. + example: '#reload-notification' + from_user: + type: string + description: Name of sending user, as shown in the Slack message + example: Butler the Bot + msg: + type: string + description: Text going into the Slack message + example: This is a message from Qlik Sense + emoji: + type: string + description: Emoji to shown next to Slack message + example: thumbsup + '400': + description: Required parameter missing. + schema: + description: Required parameter missing. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string + '500': + description: Internal error. + schema: + description: Internal error. + type: object + properties: + statusCode: + type: number + code: + type: string + error: + type: string + message: + type: string + time: + type: string +host: 192.168.1.168:8081 +schemes: + - http +produces: + - application/json +externalDocs: + url: https://github.com/ptarmiganlabs + description: Butler family of tools on GitHub