Execute a CircuitAdmin Scope
Note: Ensure you have installed the required package to use this SDK method.
The following code snippet details executing a circuit by referring to its unique Circuit ID and passing key-value pairs as the input JSON to the circuit. It also illustrates obtaining the circuit’s execution details by referring to its unique Execution ID saved in the execution history of the circuit.
The circuit reference used below is defined in the component instance page.
Note: Circuits is currently not available to Catalyst users accessing from the EU, AU, IN, JP, SA, or CA data centers.
copy
// Get a instance for Circuit
const circuit = new Circuits();
// execute the circuit
const executeCircuitResponse = await circuit.execute('195000000041001','sampleName',{name:'Aaron Jones'});
console.log(executeCircuitResponse);
// get the circuit status
const circuitStatusResponse = await circuit.status('195000000041001','195000000043002');
console.log(circuitStatusResponse);
// abort the running circuit
const circuitAbortResponse = await circuit.abort('195000000041001','195000000043002');
console.log(circuitAbortResponse);
Example of Expected Response
copy
{
id:"b3e2f61e-4795-428e-8365-3609bf2b5606",
name:"Name",
start_time:"Aug 18, 2021 07:35 PM",
status:"running",
status_code:1,
execution_meta:{},
circuit_details:{
name:"NewCircuit",
ref_name:"newcircuit",
description:"",
instance_id:"70454fc5-3bf6-45af-81ca-2742cc049698"
},
input:{
name:"Aaron Jones"
}
}Last Updated 2026-07-02 14:51:41 +0530 IST
Yes
No
Thank you for your feedback!
Send your feedback to us
Skip
Submit