Commands client
The SDK provides a Commands client
to execute commands that are publicly registered in Sitecore Content Hub.
The client
variable in the following code examples refers to the IMClient
instance. When using the Web SDK, the variable name can be chosen freely, but it is also called client
at instantiation in the documentation.
Executing commands
The following information is needed to execute a command:
-
Command name
-
Command namespace
-
Command arguments (depending on the command)
To execute a command through the SDK:
JToken result = await MClient.Commands.ExecuteCommandAsync(namespace, name, args);
The result contains the output of the command.
Supported commands
Here is a list of available commands by namespace:
external.action
Command name |
Arguments |
---|---|
|
RequestResponse
|
base
Command name |
Arguments |
---|---|
|
RequestResponse
|
m.asset
Command name |
Arguments |
---|---|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
m.chili
Command name |
Arguments |
---|---|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
m.collection
Command name |
Arguments |
---|---|
|
RequestResponse
|
m.drm
Command name |
Arguments |
---|---|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
m.entity
Command name |
Arguments |
---|---|
|
RequestResponse
|
|
RequestResponse
|
m.file
Command name |
Arguments |
---|---|
|
RequestResponse
|
m.job
Command name |
Arguments |
---|---|
|
RequestResponse
|
The canceljob
command stops processes for Import and MassEdit table jobs only. It does not affect Processing jobs.
m.portal.senddummyemail
Command name |
Arguments |
---|---|
|
RequestResponse
|
m.portal.theme
Command name |
Arguments |
---|---|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
m.portal.version
Command name |
Arguments |
---|---|
|
RequestResponse
|
m.print
Command name |
Arguments |
---|---|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
m.security
Command name |
Arguments |
---|---|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
m.taxonomy
Command name |
Arguments |
---|---|
|
RequestResponse
|
|
RequestResponse
|
portal
Command name |
Arguments |
---|---|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
project
Command name |
Arguments |
---|---|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
derivatives
Command name |
Arguments |
---|---|
|
RequestResponse
|
|
RequestResponse
|
|
RequestResponse
|
stateflow
Command name |
Arguments |
---|---|
|
Example: RequestResponse
|
|
Example: RequestResponse
|