Tools Jobs

Jobs tools

This page is generated from the code by scripts/gen_wiki_tools.py — do not edit by hand.

3 tools · category token jobs · enable with DATAVERSE_TOOLS=jobs (unset enables every category)

Tool-Index · Home

Every tool returns JSON. Errors return {"error": true, "message": "..."}. Write tools require DATAVERSE_ALLOW_WRITE=true; delete tools require DATAVERSE_ALLOW_DELETE=true.

---

dataverse_cancel_async_operation

Write · idempotent · category jobs

Cancel a running or waiting asyncoperation (system job).

Note: The asyncoperation entity supports direct statecode/statuscode PATCH (verified against the Dataverse Web API v9.2 asyncoperation entity reference — unlike systemuser which has no statecode, asyncoperation's state IS mutable via PATCH).

Param	Type	Req	Default	Notes
dataverse_url	str	yes	—	Required Dataverse organization URL for this request (e.g., 'https://yourorg.crm.dynamics.com').
async_operation_id	str	yes	—	GUID of the asyncoperation record to cancel. The job must be in a cancellable state (statecode 0=Ready, 1=Suspended, or 2=Locked). Completed jobs (statecode 3) cannot be canceled.

Returns {"cancelled": ..., "async_operation_id": ...}.

---

dataverse_get_async_operation

Read · idempotent · category jobs

Retrieve a single asyncoperation (system job) record by its GUID.

Param	Type	Req	Default	Notes
dataverse_url	str	yes	—	Required Dataverse organization URL for this request (e.g., 'https://yourorg.crm.dynamics.com').
async_operation_id	str	yes	—	GUID of the asyncoperation record to retrieve (e.g., 'a1b2c3d4-1234-5678-abcd-ef0123456789').

Returns {"record": ...}.

---

dataverse_list_async_operations

Read · idempotent · category jobs

List asyncoperation (system job) records in the Dataverse environment.

Param	Type	Req	Default	Notes
dataverse_url	str	yes	—	Required Dataverse organization URL for this request (e.g., 'https://yourorg.crm.dynamics.com').
state_code	int | None	no	None	Filter by statecode. 0=Ready, 1=Suspended, 2=Locked, 3=Completed.
status_code	int | None	no	None	Filter by statuscode. 0=Waiting For Resources, 10=Waiting, 20=In Progress, 21=Pausing, 22=Canceling, 30=Succeeded, 31=Failed, 32=Canceled.
operation_type	int | None	no	None	Filter by operationtype (Picklist). Common values: 1=System Event, 2=Bulk Email, 6=Import, 9=Quick Campaign, 12=Export to Excel, 25=Solution Import, 27=Import Translations, 32=Bulk Delete, 38=Solution Export, 56=Power Automate Flow, 79=Bulk Duplicate Detection. Accept the raw integer from asyncoperation records.
top	int	no	50	Maximum number of records to return (1–5000). (ge=1, le=5000)
select	list[str] | None	no	None	Columns to return. Defaults to asyncoperationid, name, operationtype, statecode, statuscode, message, friendlymessage, startedon, completedon, createdon, modifiedon, _regardingobjectid_value.

Returns {"records": ..., "count": ..., "has_more": ...}.

---