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-sfr-tasks
(main | bs-sfr-tasks)
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: BlueSpiceSimpleFarmerAPI
- License: unknown
Parameters:
- format
The format of the result
- One of the following values: json, jsonfm
- Default: json
- task
The task that should be executed
- createInstanceVault
- Schema, parameter examples
- installInstance
- Schema, parameter examples
- copyInstanceData
- Schema, parameter examples
- runUpdate
- Schema, parameter examples
- runPostInstanceCreationCommands
- Schema, parameter examples
- archiveInstance
- Schema, parameter examples
- copyUser
- Schema, parameter examples
- suspend
- Schema, parameter examples
- searchable
- Schema, parameter examples
- setMeta
- Schema, parameter examples
- runPreInstanceDeletionCommands
- Schema, parameter examples
- runPostInstanceDeletionCommands
- Schema, parameter examples
- getUserTaskPermissions
- Schema, parameter examples
- This parameter is required.
- One of the following values: archiveInstance, copyInstanceData, copyUser, createInstanceVault, getUserTaskPermissions, installInstance, runPostInstanceCreationCommands, runPostInstanceDeletionCommands, runPreInstanceDeletionCommands, runUpdate, searchable, setMeta, suspend
- 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.