Commands client

The SDK supports executing commands that are registered in the Sitecore Content Hub. This page describes which commands are available and how to execute them.

Note

The client variable in the following code examples refers to the ContentHubClient instance. When using the JavaScript SDK, the variable name can also be chosen freely, but 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:

RequestResponse

await client.commands.executeCommandAsync(namespace, command, args )

Supported commands

Here is the list of available commands.

Namespace

Command name

base

delete.entities

base

Delete

base

DeletePhysicalFile

base

Save

external.action

external.action

m.asset

checkin

m.asset

checkout

m.asset

create.draft

m.asset

delete.draft

m.asset

discard

m.asset

download.onedrive

m.asset

get.file.link

m.asset

import

m.asset

publish.draft

m.asset

setmaster

m.asset

unlock

m.chili

createpublication

m.chili

deletechilipublication

m.chili

duplicatepublication

m.chili

getgenerationconfiguration

m.chili

revalidatechilixml

m.collection

enable.collection

m.collection

unpublish.collection

m.drm

ask.usagerights

m.drm

order

m.drm

order.restricted.authorized

m.drm

order.restricted.nonauthorized

m.drm

validate.usagerights

m.drm

validate.usagerights.request

m.entity

removefromrelation

m.entity

updaterelation

m.file

create.video.alternative

m.file

create.video.clip

m.job

canceljob

m.portal.senddummyemail

send.email

m.portal.theme

create.theme

m.portal.theme

duplicate.theme

m.portal.theme

generate.theme

m.portal.theme

enabledisable.theme

m.portal.theme

set.default

m.portal.version

publish.version

m.print

copy.publication

m.print

create.annotation

m.print

delete.annotation

m.print

delete.publication

m.savedsearch

subscribe

m.savedsearch

unsubscribe

m.security

applyusergrouprole

m.security

applyuserrole

m.security

getpermissions

m.security

removeusergrouprole

m.security

removeuserrole

m.security

setroles

m.taxonomy

move.taxonomy

m.taxonomy

update.sortorder

portal

change.layout

portal

clone.page

portal

create.page

portal

create.pagecomponent

portal

delete.page

portal

delete.tabspagecomponenttab

portal

deleteormarkasdeleted.discussion

portal

download.excel

portal

duplicate.pagecomponent

portal

log.speedtest

portal

migrate.layout

portal

paste.pagecomponent

portal

save.translation

portal

setbackground

portal

whatsNewVisualized

project

accept.task

project

add.predecessor

project

block.review

project

cancel.task

project

complete.task

project

copy.block

project

create.activity

project

create.asset.localization

project

decline.task

project

enable.mproject

project

invoke.task

project

like

project

parallel.approve

project

remove.predecessor

project

send.to.dam

project

set.block.lifecyclestatus

project

set.deliverables.lifecyclestatus

project

set.inherits.security

project

status.deliverable

project

take.task

project

task.remind

project

update.timeline

Do you have some feedback for us?

If you have suggestions for improving this article,