13.4. REST summary

The URL templates in the table below are relative to the following URL:
  • http://server:port/business-central/rest

Table 13.2. Knowledge Store REST calls

URL Template Type Description
/jobs/{jobID} GET return the job status
/jobs/{jobID} DELETE remove the job
/organizationalunits GET return a list of organizational units
/organizationalunits POST
create an organizational unit in the Knowledge Store described by the JSON OrganizationalUnit entity
/organizationalunits/{organizationalUnitName}/repositories/{repositoryName} POST add a repository to an organizational unit
/repositories/ POST
add the repository to the organizational unit described by the JSON RepositoryReqest entity
/repositories GET return the repositories in the Knowledge Store
/repositories/{repositoryName} DELETE remove the repository from the Knowledge Store
/repositories/ POST create or clone the repository defined by the JSON RepositoryRequest entity
/repositories/{repositoryName}/projects/ POST create the project defined by the JSON entity in the repository
/repositories/{repositoryName}/projects/{projectName}/maven/compile/ POST compile the project
/repositories/{repositoryName}/projects/{projectName}/maven/install POST install the project
/repositories/{repositoryName}/projects/{projectName}/maven/test/ POST
compile the project and run tests as part of compilation
/repositories/{repositoryName}/projects/{projectName}/maven/deploy/ POST deploy the project

Table 13.3. runtime REST calls

URL Template Type Description
/runtime/{deploymentId}/process/{procDefID}/start POST start a process instance based on the Process definition (accepts query map parameters)
/runtime/{deploymentId}/process/instance/{procInstanceID} GET return a process instance details
/runtime/{deploymentId}/process/instance/{procInstanceID}/abort POST abort the process instance
/runtime/{deploymentId}/process/instance/{procInstanceID}/signal POST send a signal event to process instance (accepts query map parameters)
/runtime/{deploymentId}/process/instance/{procInstanceID}/variable/{varId} GET return a variable from a process instance
/runtime/{deploymentId}/signal/{signalCode} POST send a signal event to deployment
/runtime/{deploymentId}/workitem/{workItemID}/complete POST complete a work item (accepts query map parameters)
/runtime/{deploymentId}/workitem/{workItemID}/abort POST abort a work item
/runtime/{deploymentId}/withvars/process/{procDefinitionID}/start POST
start a process instance and return the process instance with its variables
Note that even if a passed variable is not defined in the underlying process definition, it is created and initialized with the passed value.
/runtime/{deploymentId}/withvars/process/instance/{procInstanceID}/ GET
return a process instance with its variables
/runtime/{deploymentId}/withvars/process/instance/{procInstanceID}/signal POST
send a signal event to the process instance (accepts query map parameters)
The following query parameters are accepted:
  • The signal parameter specifies the name of the signal to be sent
  • The event parameter specifies the (optional) value of the signal to be sent

Table 13.4. task REST calls

URL Template Type Description
/task/query GET
return a TaskSummary list
/task/content/{contentID} GET
returns the content of a task
/task/{taskID} GET
return the task
/task/{taskID}/activate POST
activate the task
/task/{taskID}/claim POST
claim the task
/task/{taskID}/claimnextavailable POST
claim the next available task
/task/{taskID}/complete POST
complete the task (accepts query map paramaters)
/task/{taskID}/delegate POST
delegate the task
/task/{taskID}/exit POST
exit the task
/task/{taskID}/fail POST
fail the task
/task/{taskID}/forward POST
forward the task
/task/{taskID}/nominate POST
nominate the task
/task/{taskID}/release POST
release the task
/task/{taskID}/resume POST
resume the task (after suspending)
/task/{taskID}/skip POST
skip the task
/task/{taskID}/start POST
start the task
/task/{taskID}/stop POST
stop the task
/task/{taskID}/suspend POST
suspend the task
/task/{taskID}/content GET
returns the content of a task

Table 13.5. history REST calls

URL Template Type Description
/history/clear/ POST delete all process, node and history records
/history/instances GET return the list of all process instance history records
/history/instance/{procInstId} GET return a list of process instance history records for a process instance
/history/instance/{procInstId}/child GET return a list of process instance history records for the subprocesses of the process instance
/history/instance/{procInstId}/node GET return a list of node history records for a process instance
/history/instance/{procInstId}/node/{nodeId} GET return a list of node history records for a node in a process instance
/history/instance/{procInstId}/variable GET return a list of variable history records for a process instance
/history/instance/{procInstId}/variable/{variableId} GET return a list of variable history records for a variable in a process instance
/history/process/{procDefId} GET return a list of process instance history records for process instances using a given process definition
/history/variable/{varId} GET return a list of variable history records for a variable
/history/variable/{varId}/instances GET return a list of process instance history records for process instances that contain a variable with the given variable id
/history/variable/{varId}/value/{value} GET return a list of variable history records for variable(s) with the given variable id and given value
/history/variable/{varId}/value/{value}/instances GET return a list of process instance history records for process instances with the specified variable that contains the specified variable value

Table 13.6. deployment REST calls

URL Template Type Description
/deployment GET return a list of (deployed) deployments
/deployment/{deploymentId} GET return the status and information about the deployment
/deployment/{deploymentId}/deploy POST
submit a request to deploy a deployment
/deployment/{deploymentId}/undeploy POST
submit a request to undeploy a deployment
Report a bug