MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

action=bs-ping-tasks

(main | bs-ping-tasks)
  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: BlueSpiceFoundation
  • License: GPL-3.0-only

Ping task that provides continuous exchange of data

Parameters:
format

The format of the result

One of the following values: json, jsonfm
Default: json
task

The task that should be executed

ping
Schema, parameter examples
getUserTaskPermissions
Schema, parameter examples
This parameter is required.
One of the following values: getUserTaskPermissions, ping
taskData

JSON string encoded object with arbitrary data for the task

Default: {}
context

JSON string encoded object with context data for the task

Default: {}
schema

Show the JSON schema for the task parameters

examples

Show examples of task parameters

token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.