Help
RSS
API
Feed
Maltego
Contact
Domain > docs.epsilon3.io
×
More information on this domain is in
AlienVault OTX
Is this malicious?
Yes
No
DNS Resolutions
Date
IP Address
2025-10-02
108.138.159.100
(
ClassC
)
2025-10-02
108.138.159.50
(
ClassC
)
2025-12-05
3.169.173.116
(
ClassC
)
Port 80
HTTP/1.1 301 Moved PermanentlyServer: CloudFrontDate: Fri, 05 Dec 2025 18:51:41 GMTContent-Type: text/htmlContent-Length: 167Connection: keep-aliveLocation: https://docs.epsilon3.io/X-Cache: Redirect from cloudfrontVia: 1.1 a454a679efa1e16833b77cb6af61e11c.cloudfront.net (CloudFront)X-Amz-Cf-Pop: HIO52-P4X-Amz-Cf-Id: KRgKQdu6rrJjAcaqzBY7ZXdR53pg5K_U4Xp06GYJQtSvDcJ_XRodQA html>head>title>301 Moved Permanently/title>/head>body>center>h1>301 Moved Permanently/h1>/center>hr>center>CloudFront/center>/body>/html>
Port 443
HTTP/1.1 200 OKContent-Type: text/htmlContent-Length: 782212Connection: keep-aliveDate: Fri, 05 Dec 2025 18:51:42 GMTLast-Modified: Thu, 04 Dec 2025 21:47:51 GMTETag: 11eb53f18ec9915a7547925c640d0feex-amz-server-side-encryption: AES256x-amz-version-id: z6GtSH_Jn6g2uughD98V696t09UBWEE_Accept-Ranges: bytesServer: AmazonS3X-Cache: Miss from cloudfrontVia: 1.1 7d14d4fc1c149f1d429681a4c414c21a.cloudfront.net (CloudFront)X-Amz-Cf-Pop: HIO52-P4X-Amz-Cf-Id: OmDX6Pio5Kto5_OLwE0hXeilHaXqyr-oQrxtgbSbXHIVVrQ-Bflodw !doctype html>html> head> meta charsetutf-8> meta contentIEedge,chrome1 http-equivX-UA-Compatible> meta nameviewport contentwidthdevice-width, initial-scale1, maximum-scale1> link hrefimages/favicon-e6029eaa.ico relicon typeimage/ico /> meta namedescription contentDocumentation for Epsilon3 APIs. > title>Epsilon3 API Guide/title> style mediascreen> .highlight table td { padding: 5px; }.highlight table pre { margin: 0; }.highlight .gh { color: #999999;}.highlight .sr { color: #f6aa11;}.highlight .go { color: #888888;}.highlight .gp { color: #555555;}.highlight .gs {}.highlight .gu { color: #aaaaaa;}.highlight .nb { color: #f6aa11;}.highlight .cm { color: #75715e;}.highlight .cp { color: #75715e;}.highlight .c1 { color: #75715e;}.highlight .cs { color: #75715e;}.highlight .c, .highlight .ch, .highlight .cd, .highlight .cpf { color: #75715e;}.highlight .err { color: #960050;}.highlight .gr { color: #960050;}.highlight .gt { color: #960050;}.highlight .gd { color: #49483e;}.highlight .gi { color: #49483e;}.highlight .ge { color: #49483e;}.highlight .kc { color: #66d9ef;}.highlight .kd { color: #66d9ef;}.highlight .kr { color: #66d9ef;}.highlight .no { color: #66d9ef;}.highlight .kt { color: #66d9ef;}.highlight .mf { color: #ae81ff;}.highlight .mh { color: #ae81ff;}.highlight .il { color: #ae81ff;}.highlight .mi { color: #ae81ff;}.highlight .mo { color: #ae81ff;}.highlight .m, .highlight .mb, .highlight .mx { color: #ae81ff;}.highlight .sc { color: #ae81ff;}.highlight .se { color: #ae81ff;}.highlight .ss { color: #ae81ff;}.highlight .sd { color: #e6db74;}.highlight .s2 { color: #e6db74;}.highlight .sb { color: #e6db74;}.highlight .sh { color: #e6db74;}.highlight .si { color: #e6db74;}.highlight .sx { color: #e6db74;}.highlight .s1 { color: #e6db74;}.highlight .s, .highlight .sa, .highlight .dl { color: #e6db74;}.highlight .na { color: #a6e22e;}.highlight .nc { color: #a6e22e;}.highlight .nd { color: #a6e22e;}.highlight .ne { color: #a6e22e;}.highlight .nf, .highlight .fm { color: #a6e22e;}.highlight .vc { color: #ffffff;}.highlight .nn { color: #ffffff;}.highlight .ni { color: #ffffff;}.highlight .bp { color: #ffffff;}.highlight .vg { color: #ffffff;}.highlight .vi { color: #ffffff;}.highlight .nv, .highlight .vm { color: #ffffff;}.highlight .w { color: #ffffff;}.highlight { color: #ffffff;}.highlight .n, .highlight .py, .highlight .nx { color: #ffffff;}.highlight .nl { color: #f92672;}.highlight .ow { color: #f92672;}.highlight .nt { color: #f92672;}.highlight .k, .highlight .kv { color: #f92672;}.highlight .kn { color: #f92672;}.highlight .kp { color: #f92672;}.highlight .o { color: #f92672;} /style> style mediaprint> * { -webkit-transition:none!important; transition:none!important; } .highlight table td { padding: 5px; }.highlight table pre { margin: 0; }.highlight, .highlight .w { color: #586e75;}.highlight .err { color: #002b36; background-color: #dc322f;}.highlight .c, .highlight .ch, .highlight .cd, .highlight .cm, .highlight .cpf, .highlight .c1, .highlight .cs { color: #657b83;}.highlight .cp { color: #b58900;}.highlight .nt { color: #b58900;}.highlight .o, .highlight .ow { color: #93a1a1;}.highlight .p, .highlight .pi { color: #93a1a1;}.highlight .gi { color: #859900;}.highlight .gd { color: #dc322f;}.highlight .gh { color: #268bd2; background-color: #002b36; font-weight: bold;}.highlight .k, .highlight .kn, .highlight .kp, .highlight .kr, .highlight .kv { color: #6c71c4;}.highlight .kc { color: #cb4b16;}.highlight .kt { color: #cb4b16;}.highlight .kd { color: #cb4b16;}.highlight .s, .highlight .sb, .highlight .sc, .highlight .dl, .highlight .sd, .highlight .s2, .highlight .sh, .highlight .sx, .highlight .s1 { color: #859900;}.highlight .sa { color: #6c71c4;}.highlight .sr { color: #2aa198;}.highlight .si { color: #d33682;}.highlight .se { color: #d33682;}.highlight .nn { color: #b58900;}.highlight .nc { color: #b58900;}.highlight .no { color: #b58900;}.highlight .na { color: #268bd2;}.highlight .m, .highlight .mb, .highlight .mf, .highlight .mh, .highlight .mi, .highlight .il, .highlight .mo, .highlight .mx { color: #859900;}.highlight .ss { color: #859900;} /style> link hrefstylesheets/screen-9a948775.css relstylesheet mediascreen /> link hrefstylesheets/print-ae63b53a.css relstylesheet mediaprint /> script srcjavascripts/all-b8f947fb.js>/script> script> $(function() { setupCodeCopy(); }); /script> /head> body classindex data-languages"python","shell","powershell"> a href# idnav-button> span> NAV img srcimages/navbar-cad8cdcb.png alt /> /span> /a> div classtoc-wrapper> img srcimages/logo-093ae876.png classlogo alt /> div classlang-selector> a href# data-language-namepython>python/a> a href# data-language-nameshell>shell/a> a href# data-language-namepowershell>powershell/a> /div> div classsearch> input typetext classsearch idinput-search placeholderSearch> /div> ul classsearch-results>/ul> div classtoc-container> toc-list-title>API Reference/toc-list-title> ul idtoc classtoc-list-h1> li> a href#introduction classtoc-h1 toc-link data-titleIntroduction>Introduction/a> ul classtoc-list-h2> li> a href#on-prem-deployments classtoc-h2 toc-link data-titleOn-Prem Deployments>On-Prem Deployments/a> /li> /ul> /li> li> a href#authentication classtoc-h1 toc-link data-titleAuthentication>Authentication/a> /li> li> a href#builds-api classtoc-h1 toc-link data-titleBuilds API>Builds API/a> ul classtoc-list-h2> li> a href#work-orders classtoc-h2 toc-link data-titleWork Orders>Work Orders/a> ul classtoc-list-h3> li> a href#get-work-orders classtoc-h3 toc-link data-titleGet Work Orders>Get Work Orders/a> /li> li> a href#get-work-order classtoc-h3 toc-link data-titleGet Work Order>Get Work Order/a> /li> li> a href#create-work-orders classtoc-h3 toc-link data-titleCreate Work Orders>Create Work Orders/a> /li> li> a href#update-work-order classtoc-h3 toc-link data-titleUpdate Work Order>Update Work Order/a> /li> li> a href#delete-work-order classtoc-h3 toc-link data-titleDelete Work Order>Delete Work Order/a> /li> li> a href#update-inventory-assignments classtoc-h3 toc-link data-titleUpdate Inventory Assignments>Update Inventory Assignments/a> /li> li> a href#link-runs-to-work-order classtoc-h3 toc-link data-titleLink Runs to Work Order>Link Runs to Work Order/a> /li> li> a href#list-work-order-activity classtoc-h3 toc-link data-titleList Work Order Activity>List Work Order Activity/a> /li> /ul> /li> li> a href#parts classtoc-h2 toc-link data-titleParts>Parts/a> ul classtoc-list-h3> li> a href#get-parts classtoc-h3 toc-link data-titleGet Parts>Get Parts/a> /li> li> a href#get-part classtoc-h3 toc-link data-titleGet Part>Get Part/a> /li> li> a href#create-parts classtoc-h3 toc-link data-titleCreate Parts>Create Parts/a> /li> li> a href#update-part classtoc-h3 toc-link data-titleUpdate Part>Update Part/a> /li> li> a href#update-part-image classtoc-h3 toc-link data-titleUpdate Part Image>Update Part Image/a> /li> li> a href#attach-file-to-part classtoc-h3 toc-link data-titleAttach File to Part>Attach File to Part/a> /li> li> a href#delete-part classtoc-h3 toc-link data-titleDelete Part>Delete Part/a> /li> /ul> /li> li> a href#part-details classtoc-h2 toc-link data-titlePart Details>Part Details/a> ul classtoc-list-h3> li> a href#list-part-details classtoc-h3 toc-link data-titleList Part Details>List Part Details/a> /li> /ul> /li> li> a href#inventory classtoc-h2 toc-link data-titleInventory>Inventory/a> ul classtoc-list-h3> li> a href#list-inventory classtoc-h3 toc-link data-titleList Inventory>List Inventory/a> /li> li> a href#get-inventory-item classtoc-h3 toc-link data-titleGet Inventory Item>Get Inventory Item/a> /li> li> a href#add-inventory classtoc-h3 toc-link data-titleAdd Inventory>Add Inventory/a> /li> li> a href#update-inventory-item classtoc-h3 toc-link data-titleUpdate Inventory Item>Update Inventory Item/a> /li> li> a href#delete-inventory classtoc-h3 toc-link data-titleDelete Inventory>Delete Inventory/a> /li> li> a href#list-inventory-item-activity classtoc-h3 toc-link data-titleList Inventory Item Activity>List Inventory Item Activity/a> /li> li> a href#update-inventory-item-usage classtoc-h3 toc-link data-titleUpdate Inventory Item Usage>Update Inventory Item Usage/a> /li> /ul> /li> li> a href#purchase-orders classtoc-h2 toc-link data-titlePurchase Orders>Purchase Orders/a> ul classtoc-list-h3> li> a href#list-purchase-orders classtoc-h3 toc-link data-titleList Purchase Orders>List Purchase Orders/a> /li> /ul> /li> li> a href#vendors classtoc-h2 toc-link data-titleVendors>Vendors/a> ul classtoc-list-h3> li> a href#list-vendors classtoc-h3 toc-link data-titleList Vendors>List Vendors/a> /li> /ul> /li> li> a href#locations classtoc-h2 toc-link data-titleLocations>Locations/a> ul classtoc-list-h3> li> a href#list-locations classtoc-h3 toc-link data-titleList Locations>List Locations/a> /li> /ul> /li> /ul> /li> li> a href#commanding-api classtoc-h1 toc-link data-titleCommanding API>Commanding API/a> ul classtoc-list-h2> li> a href#create-or-update-a-command classtoc-h2 toc-link data-titleCreate or update a command>Create or update a command/a> /li> li> a href#list-all-available-commands classtoc-h2 toc-link data-titleList all available commands>List all available commands/a> /li> li> a href#retrieve-a-command-by-name classtoc-h2 toc-link data-titleRetrieve a command by name>Retrieve a command by name/a> /li> li> a href#delete-commands classtoc-h2 toc-link data-titleDelete commands>Delete commands/a> /li> /ul> /li> li> a href#custom-fields-api classtoc-h1 toc-link data-titleCustom Fields API>Custom Fields API/a> ul classtoc-list-h2> li> a href#list-custom-fields classtoc-h2 toc-link data-titleList Custom Fields>List Custom Fields/a> /li> li> a href#create-custom-fields classtoc-h2 toc-link data-titleCreate Custom Fields>Create Custom Fields/a> /li> li> a href#update-custom-field classtoc-h2 toc-link data-titleUpdate Custom Field>Update Custom Field/a> /li> li> a href#list-forms classtoc-h2 toc-link data-titleList Forms>List Forms/a> /li> /ul> /li> li> a href#dictionary-api classtoc-h1 toc-link data-titleDictionary API>Dictionary API/a> ul classtoc-list-h2> li> a href#create-a-dictionary classtoc-h2 toc-link data-titleCreate a dictionary>Create a dictionary/a> /li> li> a href#list-all-available-dictionaries classtoc-h2 toc-link data-titleList all available dictionaries>List all available dictionaries/a> /li> li> a href#update-a-dictionary classtoc-h2 toc-link data-titleUpdate a dictionary>Update a dictionary/a> /li> li> a href#delete-dictionaries classtoc-h2 toc-link data-titleDelete dictionaries>Delete dictionaries/a> /li> /ul> /li> li> a href#dictionary-group-api classtoc-h1 toc-link data-titleDictionary Group API>Dictionary Group API/a> ul classtoc-list-h2> li> a href#create-a-dictionary-group classtoc-h2 toc-link data-titleCreate a dictionary group>Create a dictionary group/a> /li> li> a href#list-all-available-dictionary-groups classtoc-h2 toc-link data-titleList all available dictionary groups>List all available dictionary groups/a> /li> li> a href#delete-dictionary-groups classtoc-h2 toc-link data-titleDelete dictionary groups>Delete dictionary groups/a> /li> /ul> /li> li> a href#events-api classtoc-h1 toc-link data-titleEvents API>Events API/a> ul classtoc-list-h2> li> a href#get-events classtoc-h2 toc-link data-titleGet Events>Get Events/a> /li> li> a href#get-event classtoc-h2 toc-link data-titleGet Event>Get Event/a> /li> li> a href#update-event classtoc-h2 toc-link data-titleUpdate Event>Update Event/a> /li> li> a href#create-event classtoc-h2 toc-link data-titleCreate Event>Create Event/a> /li> li> a href#delete-event classtoc-h2 toc-link data-titleDelete Event>Delete Event/a> /li> /ul> /li> li> a href#external-data-api classtoc-h1 toc-link data-titleExternal Data API>External Data API/a> ul classtoc-list-h2> li> a href#create-or-update-an-external-data-item-type classtoc-h2 toc-link data-titleCreate or update an external data item type>Create or update an external data item type/a> /li> li> a href#list-all-external-data-items classtoc-h2 toc-link data-titleList all external data items>List all external data items/a> /li> li> a href#delete-external-data classtoc-h2 toc-link data-titleDelete external data>Delete external data/a> /li> /ul> /li> li> a href#files-api classtoc-h1 toc-link data-titleFiles API>Files API/a> ul classtoc-list-h2> li> a href#retrieve-a-file classtoc-h2 toc-link data-titleRetrieve a file>Retrieve a file/a> /li> /ul> /li> li> a href#issues-api classtoc-h1 toc-link data-titleIssues API>Issues API/a> ul classtoc-list-h2> li> a href#create-an-issue classtoc-h2 toc-link data-titleCreate an issue>Create an issue/a> /li> li> a href#update-an-issue classtoc-h2 toc-link data-titleUpdate an issue>Update an issue/a> /li> li> a href#retrieve-single-issue classtoc-h2 toc-link data-titleRetrieve single issue>Retrieve single issue/a> /li> li> a href#retrieve-list-of-issues classtoc-h2 toc-link data-titleRetrieve list of issues>Retrieve list of issues/a> /li> li> a href#retrieve-issues-metadata-options classtoc-h2 toc-link data-titleRetrieve issues metadata options>Retrieve issues metadata options/a> /li> li> a href#sign-off-step-in-an-issue classtoc-h2 toc-link data-titleSign off step in an issue>Sign off step in an issue/a> /li> /ul> /li> li> a href#procedures-api classtoc-h1 toc-link data-titleProcedures API>Procedures API/a> ul classtoc-list-h2> li> a href#audit-procedures-with-invalid-data classtoc-h2 toc-link data-titleAudit procedures with invalid data>Audit procedures with invalid data/a> /li> li> a href#list-procedure-summaries classtoc-h2 toc-link data-titleList procedure summaries>List procedure summaries/a> /li> li> a href#retrieve-a-procedure classtoc-h2 toc-link data-titleRetrieve a procedure>Retrieve a procedure/a> /li> /ul> /li> li> a href#runs-v2-api classtoc-h1 toc-link data-titleRuns V2 API>Runs V2 API/a> ul classtoc-list-h2> li> a href#get-run classtoc-h2 toc-link data-titleGet Run>Get Run/a> /li> /ul> /li> li> a href#runs-api classtoc-h1 toc-link data-titleRuns API>Runs API/a> ul classtoc-list-h2> li> a href#start-a-running-procedure classtoc-h2 toc-link data-titleStart a running procedure>Start a running procedure/a> /li> li> a href#pause-or-resume-a-running-procedure classtoc-h2 toc-link data-titlePause or resume a running procedure>Pause or resume a running procedure/a> /li> li> a href#retrieve-list-of-running-procedure-summaries classtoc-h2 toc-link data-titleRetrieve list of running procedure summaries>Retrieve list of running procedure summaries/a> /li> li> a href#end-a-running-procedure classtoc-h2 toc-link data-titleEnd a running procedure>End a running procedure/a> /li> li> a href#retrieve-available-run-tags classtoc-h2 toc-link data-titleRetrieve available run tags>Retrieve available run tags/a> /li> li> a href#create-run-tags classtoc-h2 toc-link data-titleCreate run tags>Create run tags/a> /li> li> a href#retrieve-run-metadata classtoc-h2 toc-link data-titleRetrieve run metadata>Retrieve run metadata/a> /li> li> a href#set-run-metadata classtoc-h2 toc-link data-titleSet run metadata>Set run metadata/a> /li> li> a href#start-automation classtoc-h2 toc-link data-titleStart automation>Start automation/a> ul classtoc-list-h3> li> a href#parameters classtoc-h3 toc-link data-titleParameters>Parameters/a> /li> /ul> /li> li> a href#stop-automation classtoc-h2 toc-link data-titleStop automation>Stop automation/a> /li> /ul> /li> li> a href#swimlanes-api classtoc-h1 toc-link data-titleSwimlanes API>Swimlanes API/a> ul classtoc-list-h2> li> a href#get-swimlanes classtoc-h2 toc-link data-titleGet Swimlanes>Get Swimlanes/a> /li> li> a href#update-swimlane classtoc-h2 toc-link data-titleUpdate Swimlane>Update Swimlane/a> /li> li> a href#create-swimlane classtoc-h2 toc-link data-titleCreate Swimlane>Create Swimlane/a> /li> li> a href#delete-swimlane classtoc-h2 toc-link data-titleDelete Swimlane>Delete Swimlane/a> /li> /ul> /li> li> a href#telemetry-api classtoc-h1 toc-link data-titleTelemetry API>Telemetry API/a> ul classtoc-list-h2> li> a href#create-or-update-a-telemetry-parameter classtoc-h2 toc-link data-titleCreate or update a telemetry parameter>Create or update a telemetry parameter/a> /li> li> a href#list-all-available-telemetry-parameters classtoc-h2 toc-link data-titleList all available telemetry parameters>List all available telemetry parameters/a> /li> li> a href#retrieve-a-telemetry-parameter-by-name classtoc-h2 toc-link data-titleRetrieve a telemetry parameter by name>Retrieve a telemetry parameter by name/a> /li> li> a href#delete-parameters classtoc-h2 toc-link data-titleDelete parameters>Delete parameters/a> /li> /ul> /li> li> a href#test-management-api classtoc-h1 toc-link data-titleTest Management API>Test Management API/a> ul classtoc-list-h2> li> a href#conditions classtoc-h2 toc-link data-titleConditions>Conditions/a> ul classtoc-list-h3> li> a href#list-conditions classtoc-h3 toc-link data-titleList Conditions>List Conditions/a> /li> li> a href#get-condition classtoc-h3 toc-link data-titleGet Condition>Get Condition/a> /li> /ul> /li> li> a href#hazards classtoc-h2 toc-link data-titleHazards>Hazards/a> ul classtoc-list-h3> li> a href#list-hazards classtoc-h3 toc-link data-titleList Hazards>List Hazards/a> /li> li> a href#get-hazard classtoc-h3 toc-link data-titleGet Hazard>Get Hazard/a> /li> li> a href#list-hazard-versions classtoc-h3 toc-link data-titleList Hazard Versions>List Hazard Versions/a> /li> li> a href#get-hazard-version classtoc-h3 toc-link data-titleGet Hazard Version>Get Hazard Version/a> /li> /ul> /li> li> a href#test-points classtoc-h2 toc-link data-titleTest Points>Test Points/a> ul classtoc-list-h3> li> a href#list-test-points classtoc-h3 toc-link data-titleList Test Points>List Test Points/a> /li> li> a href#get-test-point classtoc-h3 toc-link data-titleGet Test Point>Get Test Point/a> /li> li> a href#list-test-point-versions classtoc-h3 toc-link data-titleList Test Point Versions>List Test Point Versions/a> /li> li> a href#get-test-point-version classtoc-h3 toc-link data-titleGet Test Point Version>Get Test Point Version/a> /li> /ul> /li> li> a href#requirements classtoc-h2 toc-link data-titleRequirements>Requirements/a> ul classtoc-list-h3> li> a href#list-requirements classtoc-h3 toc-link data-titleList Requirements>List Requirements/a> /li> li> a href#get-requirement classtoc-h3 toc-link data-titleGet Requirement>Get Requirement/a> /li> li> a href#list-requirement-versions classtoc-h3 toc-link data-titleList Requirement Versions>List Requirement Versions/a> /li> li> a href#get-requirement-version classtoc-h3 toc-link data-titleGet Requirement Version>Get Requirement Version/a> /li> /ul> /li> /ul> /li> /ul> /div> hr> div classtoc-container> toc-list-title>Realtime Reference/toc-list-title> ul idtoc2 classtoc-list-h1> li> a href#realtime-introduction classtoc-h1 toc-link data-titleRealtime Introduction>Realtime Introduction/a> ul classtoc-list-h2> li> a href#getting-started classtoc-h2 toc-link data-titleGetting Started>Getting Started/a> ul classtoc-list-h3> li> a href#download-sample-client classtoc-h3 toc-link data-titleDownload Sample Client>Download Sample Client/a> /li> li> a href#set-environment-variables classtoc-h3 toc-link data-titleSet Environment Variables>Set Environment Variables/a> /li> li> a href#webhook-signature-verification classtoc-h3 toc-link data-titleWebhook signature verification>Webhook signature verification/a> /li> li> a href#run-the-application classtoc-h3 toc-link data-titleRun the Application>Run the Application/a> /li> /ul> /li> /ul> /li> li> a href#commanding classtoc-h1 toc-link data-titleCommanding>Commanding/a> ul classtoc-list-h2> li> a href#listen-for-a-command-in-real-time classtoc-h2 toc-link data-titleListen for a command in real-time>Listen for a command in real-time/a> ul classtoc-list-h3> li> a href#client-request classtoc-h3 toc-link data-titleClient Request>Client Request/a> /li> li> a href#client-response classtoc-h3 toc-link data-titleClient Response>Client Response/a> /li> li> a href#command-timeout classtoc-h3 toc-link data-titleCommand Timeout>Command Timeout/a> /li> li> a href#limitations classtoc-h3 toc-link data-titleLimitations>Limitations/a> /li> /ul> /li> /ul> /li> li> a href#external-data classtoc-h1 toc-link data-titleExternal Data>External Data/a> ul classtoc-list-h2> li> a href#listen-for-real-time-requests-for-external-data classtoc-h2 toc-link data-titleListen for real-time requests for external data>Listen for real-time requests for external data/a> ul classtoc-list-h3> li> a href#client-request classtoc-h3 toc-link data-titleClient Request>Client Request/a> /li> li> a href#client-response classtoc-h3 toc-link data-titleClient Response>Client Response/a> /li> /ul> /li> /ul> /li> li> a href#notifications classtoc-h1 toc-link data-titleNotifications>Notifications/a> ul classtoc-list-h2> li> a href#sending-notifications classtoc-h2 toc-link data-titleSending notifications>Sending notifications/a> ul classtoc-list-h3> li> a href#success-indicator classtoc-h3 toc-link data-titleSuccess Indicator>Success Indicator/a> /li> li> a href#failure-indicator classtoc-h3 toc-link data-titleFailure Indicator>Failure Indicator/a> /li> /ul> /li> li> a href#notification-objects classtoc-h2 toc-link data-titleNotification Objects>Notification Objects/a> /li> /ul> /li> li> a href#telemetry classtoc-h1 toc-link data-titleTelemetry>Telemetry/a> ul classtoc-list-h2> li> a href#real-time-telemetry-namespace classtoc-h2 toc-link data-titleReal-time Telemetry Namespace>Real-time Telemetry Namespace/a> ul classtoc-list-h3> li> a href#start-stream-event classtoc-h3 toc-link data-titleStart Stream Event>Start Stream Event/a> /li> li> a href#data-update-event classtoc-h3 toc-link data-titleData Update Event>Data Update Event/a> /li> li> a href#end-streams-event classtoc-h3 toc-link data-titleEnd Streams Event>End Streams Event/a> /li> li> a href#disconnect-event classtoc-h3 toc-link data-titleDisconnect Event>Disconnect Event/a> /li> /ul> /li> li> a href#error-and-status-events classtoc-h2 toc-link data-titleError and Status Events>Error and Status Events/a> ul classtoc-list-h3> li> a href#error-event classtoc-h3 toc-link data-titleError Event>Error Event/a> /li> li> a href#connection-status-event classtoc-h3 toc-link data-titleConnection Status Event>Connection Status Event/a> /li> /ul> /li> /ul> /li> /ul> /div> ul classtoc-footer> li>a hrefhttps://www.epsilon3.io/behind-the-console/category/Changelog>View the Changelogs/a>/li> li>a hrefhttps://status.epsilon3.io/>System Status/a>/li> li>a hrefhttps://www.epsilon3.io/support>Support/a>/li> /ul> /div> div classpage-wrapper> div classdark-box>/div> div classcontent> h1 idintroduction>Introduction/h1>p>The Epsilon3 API is centered around REST principles, using standard HTTP response codes, verbs, and authentication. All API endpoints use resource-oriented URLs and JSON-encoded request and response bodies./p>h2 idon-prem-deployments>On-Prem Deployments/h2>p>The URL to use for requests will vary depending on your setup, it will be the same as your web URL with the addition of the code>/api/code> postfix, e.g. code>https://YOUR_WEB_URL/api/code>./p>h1 idauthentication>Authentication/h1>blockquote>p>The API key is expected as the username component of a basic auth header/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>span classnb>export /span>span classnv>EPSILON3_API_KEY/span>span classo>/span>YOUR_API_KEYcurl span classnt>-u/span> span classk>${/span>span classnv>EPSILON3_API_KEY/span>span classk>}/span>: .../code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw> /span>span classo>/span>span classw> /span>span classs2>YOUR_API_KEY/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classp>@{/span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw> /span>span classerr>.../span>span classw>/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classc1># Export API key in shell outside of code with export EPSILON3_API_KEYYOUR_API_KEY/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span> span classn>url/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classp>.../span>span classp>)/span>/code>/pre>/div>p>Authentication is performed using a per-workspace API key. a hrefhttps://support.epsilon3.io/en/articles/8779712-generate-api-key>See our guide/a> on how to generate one./p>h1 idbuilds-api>Builds API/h1>p>The Builds API can be used to manage your part templates (or bills of materials) and list your entire inventory./p>h2 idwork-orders>Work Orders/h2>h3 idget-work-orders>Get Work Orders/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/builds/work-orders/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/builds/work-orders span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/builds/work-orders/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/builds/work-orders/code>/p>p>Retrieve all work orders defined in your workspace./p>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>work_orders/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>85/span>span classp>,/span>span classw> /span>span classnl>work_order_number/span>span classp>:/span>span classw> /span>span classmi>69/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Project 1 WO 1/span>span classp>,/span>span classw> /span>span classnl>priority/span>span classp>:/span>span classw> /span>span classs2>High/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>Complete/span>span classp>,/span>span classw> /span>span classnl>owner/span>span classp>:/span>span classw> /span>span classs2>YfsK2SFZ8afndGo2u79ruB/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classnl>project_id/span>span classp>:/span>span classw> /span>span classs2>9NKegRHwzK/span>span classp>,/span>span classw> /span>span classnl>parts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>part_id/span>span classp>:/span>span classw> /span>span classs2>mo58Dbqw4UTxejDt5ZQz71/span>span classp>,/span>span classw> /span>span classnl>revision_id/span>span classp>:/span>span classw> /span>span classs2>NL1IeyfLXdvVaeWrbqqDg5/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>part_number/span>span classp>:/span>span classw> /span>span classs2>ANODE/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Anode/span>span classp>,/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>assignees/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>details/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>f2cf0c3a-8a96-409b-95b4-94009b26efc5/span>span classp>,/span>span classw> /span>span classnl>field_id/span>span classp>:/span>span classw> /span>span classs2>email_id/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Email/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>Text/span>span classp>,/span>span classw> /span>span classnl>metadata/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>required/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>default_value/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>expression_tokens/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>work_order_id/span>span classp>:/span>span classw> /span>span classs2>85/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classs2>adam@example.com/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>a4ee7953-cf8e-4bbf-9313-72bfd733ef4c/span>span classp>,/span>span classw> /span>span classnl>field_id/span>span classp>:/span>span classw> /span>span classs2>avg_cost/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Average Cost/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>Number/span>span classp>,/span>span classw> /span>span classnl>metadata/span>span classp>:/span>span classw> /span>span classp>{},/span>span classw> /span>span classnl>required/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>default_value/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>expression_tokens/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>work_order_id/span>span classp>:/span>span classw> /span>span classs2>85/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classs2>312/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>planned_start_date/span>span classp>:/span>span classw> /span>span classs2>2025-07-21T00:00:00.000Z/span>span classp>,/span>span classw> /span>span classnl>planned_end_date/span>span classp>:/span>span classw> /span>span classs2>2046-07-21T00:00:00.000Z/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>.../span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idget-work-order>Get Work Order/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/builds/work-orders/85/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/builds/work-orders/85 span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/builds/work-orders/85/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/builds/work-orders/:workOrderId/code>/p>p>Retrieve a single work order using its ID./p>p>strong>Parameters/strong>/p>ul>li>code>workOrderId/code> (path parameter): ID of the work order being retrieved./li>/ul>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>85/span>span classp>,/span>span classw> /span>span classnl>work_order_number/span>span classp>:/span>span classw> /span>span classmi>69/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Project 1 WO 1/span>span classp>,/span>span classw> /span>span classnl>priority/span>span classp>:/span>span classw> /span>span classs2>High/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>Complete/span>span classp>,/span>span classw> /span>span classnl>owner/span>span classp>:/span>span classw> /span>span classs2>YfsK2SFZ8afndGo2u79ruB/span>span classp>,/span>span classw> /span>span classnl>project_id/span>span classp>:/span>span classw> /span>span classs2>9NKegRHwzK/span>span classp>,/span>span classw> /span>span classnl>parts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>part_id/span>span classp>:/span>span classw> /span>span classs2>mo58Dbqw4UTxejDt5ZQz71/span>span classp>,/span>span classw> /span>span classnl>revision_id/span>span classp>:/span>span classw> /span>span classs2>NL1IeyfLXdvVaeWrbqqDg5/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>part_number/span>span classp>:/span>span classw> /span>span classs2>ANODE/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Anode/span>span classp>,/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>assignees/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>details/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>f2cf0c3a-8a96-409b-95b4-94009b26efc5/span>span classp>,/span>span classw> /span>span classnl>field_id/span>span classp>:/span>span classw> /span>span classs2>email_id/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Email/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>Text/span>span classp>,/span>span classw> /span>span classnl>metadata/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>required/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>default_value/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>expression_tokens/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>work_order_id/span>span classp>:/span>span classw> /span>span classs2>85/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classs2>adam@example.com/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>a4ee7953-cf8e-4bbf-9313-72bfd733ef4c/span>span classp>,/span>span classw> /span>span classnl>field_id/span>span classp>:/span>span classw> /span>span classs2>avg_cost/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Average Cost/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>Number/span>span classp>,/span>span classw> /span>span classnl>metadata/span>span classp>:/span>span classw> /span>span classp>{},/span>span classw> /span>span classnl>required/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>default_value/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>expression_tokens/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>work_order_id/span>span classp>:/span>span classw> /span>span classs2>85/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classs2>312/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>planned_start_date/span>span classp>:/span>span classw> /span>span classs2>2025-07-21T00:00:00.000Z/span>span classp>,/span>span classw> /span>span classnl>planned_end_date/span>span classp>:/span>span classw> /span>span classs2>2046-07-21T00:00:00.000Z/span>span classp>,/span>span classw> /span>span classnl>ebom_configs/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>components_needed/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>part_id/span>span classp>:/span>span classw> /span>span classs2>xi4kPknhkM79WlWdaEXHth/span>span classp>,/span>span classw> /span>span classnl>revision_id/span>span classp>:/span>span classw> /span>span classs2>3KV7aieAp7jkkE1wZl8WAp/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>50/span>span classp>,/span>span classw> /span>span classnl>part_number/span>span classp>:/span>span classw> /span>span classs2>P-101/span>span classp>,/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>B/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Combustion Chamber/span>span classp>,/span>span classw> /span>span classnl>available_quantity/span>span classp>:/span>span classw> /span>span classmi>45/span>span classp>,/span>span classw> /span>span classnl>inventory_assignments/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>item_id/span>span classp>:/span>span classw> /span>span classs2>item_abc/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>30/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>item_id/span>span classp>:/span>span classw> /span>span classs2>item_def/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>15/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>work_instructions/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>linked_runs/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>aboms/span>span classp>:/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idcreate-work-orders>Create Work Orders/h3>blockquote>p>Sample Request (Single Work Order)/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>data/span> span classo>/span> span classp>{/span> span classs>work_orders/span>span classp>:/span> span classp>/span> span classp>{/span> span classs>name/span>span classp>:/span> span classs>Build 10x Rocket Engines/span>span classp>,/span> span classs>owner/span>span classp>:/span> span classs>jane.doe@example.com/span>span classp>,/span> span classs>parts/span>span classp>:/span> span classp>/span> span classp>{/span> span classs>part_id/span>span classp>:/span> span classs>66qVqW9X5NKz7qPJhrlFtG/span>span classp>,/span> span classs>revision_id/span>span classp>:/span> span classs>W4e4WfDe6ZU8OZdvIaJIUw/span>span classp>,/span> span classs>quantity/span>span classp>:/span> span classmi>10/span> span classp>}/span> span classp>/span> span classp>}/span> span classp>/span>span classp>}/span>span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/builds/work-orders/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classn>data/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST span classse>\/span> https://api.epsilon3.io/v1/builds/work-orders span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-H/span> span classs2>Content-Type: application/json/span> span classse>\/span> span classnt>-d/span> span classs1>{ work_orders: { name: Build 10x Rocket Engines, owner: jane.doe@example.com, parts: { part_id: 66qVqW9X5NKz7qPJhrlFtG, revision_id: W4e4WfDe6ZU8OZdvIaJIUw, quantity: 10 } } }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/builds/work-orders/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classnx>work_orders/span>span classw> /span>span classo>/span>span classw> /span>span classp>@(/span>span classw> /span>span classp>@{/span>span classw> /span>span classnx>name/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Build 10x Rocket Engines/span>span classw> /span>span classnx>owner/span>span classw> /span>span classo>/span>span classw> /span>span classs2>jane.doe@example.com/span>span classw> /span>span classnx>parts/span>span classw> /span>span classo>/span>span classw> /span>span classp>@(/span>span classw> /span>span classp>@{/span>span classw> /span>span classnx>part_id/span>span classw> /span>span classo>/span>span classw> /span>span classs2>66qVqW9X5NKz7qPJhrlFtG/span>span classw> /span>span classnx>revision_id/span>span classw> /span>span classo>/span>span classw> /span>span classs2>W4e4WfDe6ZU8OZdvIaJIUw/span>span classw> /span>span classnx>quantity/span>span classw> /span>span classo>/span>span classw> /span>span classmi>10/span>span classw> /span>span classp>}/span>span classw> /span>span classp>)/span>span classw> /span>span classp>}/span>span classw> /span>span classp>)/span>span classw>/span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw> /span>span classnt>-Depth/span>span classw> /span>span classnx>10/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Post/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw>/span>span classp>}/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body (Single Work Order)/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>work_orders/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Build 10x Rocket Engines/span>span classp>,/span>span classw> /span>span classnl>owner/span>span classp>:/span>span classw> /span>span classs2>jane.doe@example.com/span>span classp>,/span>span classw> /span>span classnl>parts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>part_id/span>span classp>:/span>span classw> /span>span classs2>66qVqW9X5NKz7qPJhrlFtG/span>span classp>,/span>span classw> /span>span classnl>revision_id/span>span classp>:/span>span classw> /span>span classs2>W4e4WfDe6ZU8OZdvIaJIUw/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>10/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body (Multiple Work Orders)/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>work_orders/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Build 10x Rocket Engines/span>span classp>,/span>span classw> /span>span classnl>owner/span>span classp>:/span>span classw> /span>span classs2>jane.doe@example.com/span>span classp>,/span>span classw> /span>span classnl>parts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>part_id/span>span classp>:/span>span classw> /span>span classs2>66qVqW9X5NKz7qPJhrlFtG/span>span classp>,/span>span classw> /span>span classnl>revision_id/span>span classp>:/span>span classw> /span>span classs2>W4e4WfDe6ZU8OZdvIaJIUw/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>10/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Build 5x Fuel Tanks/span>span classp>,/span>span classw> /span>span classnl>owner/span>span classp>:/span>span classw> /span>span classs2>john.smith@example.com/span>span classp>,/span>span classw> /span>span classnl>priority/span>span classp>:/span>span classw> /span>span classs2>High/span>span classp>,/span>span classw> /span>span classnl>parts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>part_id/span>span classp>:/span>span classw> /span>span classs2>77qVqW9X5NKz7qPJhrlFtH/span>span classp>,/span>span classw> /span>span classnl>revision_id/span>span classp>:/span>span classw> /span>span classs2>X5e4WfDe6ZU8OZdvIaJIVx/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>5/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Response Body (Single Work Order)/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ids/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>105/span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Response Body (Multiple Work Orders)/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ids/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>105/span>span classp>,/span>span classw> /span>span classs2>106/span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>POST code>https://api.epsilon3.io/v1/builds/work-orders/code>/p>p>Create one or more work orders in your workspace. This endpoint supports bulk creation of work orders./p>p>strong>Request Body/strong>/p>ul>li>code>work_orders/code>: (required) Array of work order objects to create (1 to 1000 work orders). Each work order object contains:ul>li>code>name/code>: (required) Work order name. Must be a string of up to 255 characters./li>li>code>owner/code>: (required) Work order owner identifier. Can be either a user's email address or user ID./li>li>code>parts/code>: (required) Array of parts to build. Must contain exactly 1 part object with:/li>li>code>part_id/code>: (required) System generated ID of the part to build/li>li>code>revision_id/code>: (required) System generated ID of the specific part revision/li>li>code>quantity/code>: (required) Number of parts to build. Must be a positive integer (max 2147483647)/li>li>code>priority/code>: (optional) Priority level for the work order. Must be one of: code>Critical/code>, code>High/code>, code>Medium/code>, code>Low/code>/li>li>code>customer_id/code>: (optional) System generated ID of the customer/li>li>code>project_id/code>: (optional) System generated ID of the project/li>li>code>notes/code>: (optional) Work order notes. Must be a string of up to 4096 characters/li>li>code>assignees/code>: (optional) Array of user identifiers for users assigned to the work order (0 to 50 users). Each identifier can be either a user's email address or user ID/li>li>code>planned_start_date/code>: (optional) Planned start date in ISO 8601 format/li>li>code>planned_end_date/code>: (optional) Planned end date in ISO 8601 format/li>li>code>details/code>: (optional) Custom work order detail fields. Must be an array of 0 to 100 objects with:/li>li>code>id/code>: (required) ID of the custom field/li>li>code>value/code>: (required) Object containing:ul>li>code>recorded/code>: (required) The value to set for the custom field/li>/ul>/li>/ul>/li>/ul>p>strong>Response/strong>/p>p>The response status code will be 200 and return an array of IDs for the created work orders./p>h3 idupdate-work-order>Update Work Order/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>data/span> span classo>/span> span classp>{/span> span classs>status/span>span classp>:/span> span classs>Running/span>span classp>}/span>span classn>requests/span>span classp>./span>span classn>patch/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/builds/work-orders/105/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classn>data/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> PATCH span classse>\/span> https://api.epsilon3.io/v1/builds/work-orders/105 span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-H/span> span classs2>Content-Type: application/json/span> span classse>\/span> span classnt>-d/span> span classs1>{ status: Running }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/builds/work-orders/105/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classnx>status/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Running/span>span classw>/span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Patch/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw>/span>span classp>}/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>Running/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>PATCH code>https://api.epsilon3.io/v1/builds/work-orders/:workOrderId/code>/p>p>Updates values of one or more fields for a specific work order./p>p>strong>Request Body/strong>/p>p>The request body should be a JSON object that contains the specific fields of the work order to be updated. The request body must contain at least one field. Following fields are supported:/p>ul>li>code>status/code>: (optional) Work order status. Must be one of: code>Planned/code>, code>Running/code>, code>Complete/code>, code>Canceled/code>/li>li>code>priority/code>: (optional) Priority level. Must be one of: code>Critical/code>, code>High/code>, code>Medium/code>, code>Low/code>, or code>null/code> to clear/li>li>code>customer_id/code>: (optional) System generated ID of the customer, or code>null/code> to clear/li>li>code>assignees/code>: (optional) Object to manage assignees:ul>li>code>added/code>: (optional) Array of user identifiers to add as assignees (0 to 50 users). Each identifier can be either a user's email address or user ID/li>li>code>removed/code>: (optional) Array of user identifiers to remove from assignees (0 to 50 users). Each identifier can be either a user's email address or user ID/li>/ul>/li>li>code>details/code>: (optional) Custom work order detail fields to update. Must be an array of 0 to 100 objects with:ul>li>code>id/code>: (required) ID of the custom field/li>li>code>value/code>: (required) Object containing:ul>li>code>recorded/code>: (required) The value to set for the custom field/li>/ul>/li>/ul>/li>li>code>ebom_config/code>: (optional) Array of EBOM (Engineering Bill of Materials) configuration updates for work orders with variable components. Must contain exactly 1 configuration object with:ul>li>code>id/code>: (required) The EBOM configuration ID to update/li>li>code>selections/code>: (required) Array of component selections (0 to 100 items). Each selection must contain:/li>li>code>part_component_group_id/code>: (required) ID of the variable component being configured/li>li>code>part_component_group_option_id/code>: (required) ID of the selected option for this component group, or code>null/code> to indicate no selection if the component is optional/li>/ul>/li>li>code>planned_start_date/code>: (optional) Planned start date in ISO 8601 format, or code>null/code> to clear/li>li>code>planned_end_date/code>: (optional) Planned end date in ISO 8601 format, or code>null/code> to clear/li>/ul>p>strong>Response/strong>/p>ul>li>Status: code>200 OK/code>/li>li>Body: em>(empty)/em>/li>/ul>h3 iddelete-work-order>Delete Work Order/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>delete/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/builds/work-orders/105/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> DELETE span classse>\/span> https://api.epsilon3.io/v1/builds/work-orders/105 span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/builds/work-orders/105/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Delete/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>DELETE code>https://api.epsilon3.io/v1/builds/work-orders/:workOrderId/code>/p>p>Delete a work order./p>p>strong>Parameters/strong>/p>ul>li>code>workOrderId/code> (path parameter): ID of the work order to delete/li>/ul>p>strong>Response/strong>/p>ul>li>Status: code>200 OK/code>/li>li>Body: em>(empty)/em>/li>/ul>h3 idupdate-inventory-assignments>Update Inventory Assignments/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>data/span> span classo>/span> span classp>{/span> span classs>added/span>span classp>:/span> span classp>/span> span classp>{/span> span classs>item_id/span>span classp>:/span> span classs>Uqo1eK43QThNE78Rl3HTco/span>span classp>,/span> span classs>quantity/span>span classp>:/span> span classmi>5/span> span classp>}/span> span classp>/span>span classp>}/span>span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/builds/work-orders/105/inventory-assignments/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classn>data/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST span classse>\/span> https://api.epsilon3.io/v1/builds/work-orders/105/inventory-assignments span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-H/span> span classs2>Content-Type: application/json/span> span classse>\/span> span classnt>-d/span> span classs1>{ added: { item_id: Uqo1eK43QThNE78Rl3HTco, quantity: 5 } }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/builds/work-orders/105/inventory-assignments/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classnx>added/span>span classw> /span>span classo>/span>span classw> /span>span classp>@(/span>span classw> /span>span classp>@{/span>span classw> /span>span classnx>item_id/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Uqo1eK43QThNE78Rl3HTco/span>span classw> /span>span classnx>quantity/span>span classw> /span>span classo>/span>span classw> /span>span classmi>5/span>span classw> /span>span classp>}/span>span classw> /span>span classp>)/span>span classw>/span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw> /span>span classnt>-Depth/span>span classw> /span>span classnx>10/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Post/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw>/span>span classp>}/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>added/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>item_id/span>span classp>:/span>span classw> /span>span classs2>Uqo1eK43QThNE78Rl3HTco/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>5/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>POST code>https://api.epsilon3.io/v1/builds/work-orders/:workOrderId/inventory-assignments/code>/p>p>Update inventory assignments for a work order. This endpoint allows you to assign or unassign inventory items to/from a work order./p>p>strong>Request Body/strong>/p>ul>li>code>added/code>: (optional) Array of inventory items to assign to the work order (0 to 1000 items). Each object must contain:ul>li>code>item_id/code>: (required) System generated ID of the inventory item/li>li>code>quantity/code>: (required) Quantity to assign. Must be a positive number/li>/ul>/li>li>code>removed/code>: (optional) Array of inventory items to unassign from the work order (0 to 1000 items). Each object must contain:ul>li>code>item_id/code>: (required) System generated ID of the inventory item to remove/li>/ul>/li>/ul>p>strong>Response/strong>/p>ul>li>Status: code>200 OK/code>/li>li>Body: em>(empty)/em>/li>/ul>h3 idlink-runs-to-work-order>Link Runs to Work Order/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>data/span> span classo>/span> span classp>{/span> span classs>run_ids/span>span classp>:/span> span classp>/span>span classs>run_123/span>span classp>/span>span classp>}/span>span classn>requests/span>span classp>./span>span classn>put/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/builds/work-orders/105/runs/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classn>data/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> PUT span classse>\/span> https://api.epsilon3.io/v1/builds/work-orders/105/runs span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-H/span> span classs2>Content-Type: application/json/span> span classse>\/span> span classnt>-d/span> span classs1>{ run_ids: run_123 }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/builds/work-orders/105/runs/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classnx>run_ids/span>span classw> /span>span classo>/span>span classw> /span>span classp>@(/span>span classs2>run_123/span>span classp>)/span>span classw>/span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Put/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw>/span>span classp>}/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>run_ids/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>run_123/span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>PUT code>https://api.epsilon3.io/v1/builds/work-orders/:workOrderId/runs/code>/p>p>Link procedure runs to a work order. This associates completed or in-progress runs with the work order for tracking purposes./p>p>strong>Request Body/strong>/p>ul>li>code>run_ids/code>: (required) Array of run IDs to link to the work order. Must contain at least 1 and at most 50 run IDs./li>/ul>p>strong>Response/strong>/p>ul>li>Status: code>200 OK/code>/li>li>Body: em>(empty)/em>/li>/ul>h3 idlist-work-order-activity>List Work Order Activity/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/builds/work-orders/109/activity/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/builds/work-orders/109/activity span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/builds/work-orders/109/activity/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>has_older/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>activities/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>98/span>span classp>,/span>span classw> /span>span classnl>work_order_id/span>span classp>:/span>span classw> /span>span classs2>109/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classw> /span>span classs2>2024-10-18T20:02:38.901Z/span>span classp>,/span>span classw> /span>span classnl>action/span>span classp>:/span>span classw> /span>span classs2>Status Updated/span>span classp>,/span>span classw> /span>span classnl>actor_type/span>span classp>:/span>span classw> /span>span classs2>user/span>span classp>,/span>span classw> /span>span classnl>actor_id/span>span classp>:/span>span classw> /span>span classs2>user@epsilon3.io/span>span classp>,/span>span classw> /span>span classnl>old_value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>Planned/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>new_value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>Running/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>97/span>span classp>,/span>span classw> /span>span classnl>work_order_id/span>span classp>:/span>span classw> /span>span classs2>109/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classw> /span>span classs2>2024-10-18T19:45:12.123Z/span>span classp>,/span>span classw> /span>span classnl>action/span>span classp>:/span>span classw> /span>span classs2>Assignees Updated/span>span classp>,/span>span classw> /span>span classnl>actor_type/span>span classp>:/span>span classw> /span>span classs2>user/span>span classp>,/span>span classw> /span>span classnl>actor_id/span>span classp>:/span>span classw> /span>span classs2>admin@epsilon3.io/span>span classp>,/span>span classw> /span>span classnl>old_value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>assignee_ids/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>user1@epsilon3.io/span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>new_value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>assignee_ids/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>user1@epsilon3.io/span>span classp>,/span>span classw> /span>span classs2>user2@epsilon3.io/span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/builds/work-orders/:workOrderId/activity?startBeforeId{startBeforeId}/code>/p>p>List up to twenty five most recent actions related to the specified work order. Use the optional code>startBeforeId/code> query parameter to list older actions./p>p>strong>Parameters/strong>/p>ul>li>code>workOrderId/code> (path parameter): ID of the work order for which to list activity/li>li>code>startBeforeId/code> (query parameter): optional integer that can be used to list older activity. When this is set, up to twenty five most recent actions that are older than the activity mapped to this ID are listed./li>/ul>h2 idparts>Parts/h2>h3 idget-parts>Get Parts/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/builds/parts/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/builds/parts span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/builds/parts/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/builds/parts/code>/p>p>Retrieve all parts defined in your workspace./p>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>parts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>vnWtKWleNWiuSQbBPNdE5F/span>span classp>,/span>span classw> /span>span classnl>part_number/span>span classp>:/span>span classw> /span>span classs2>P-1/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Sample Part/span>span classp>,/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>C/span>span classp>,/span>span classw> /span>span classnl>tracking/span>span classp>:/span>span classw> /span>span classs2>serial/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>This is a sample part assembled in house./span>span classp>,/span>span classw> /span>span classnl>assembly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>procurement_type/span>span classp>:/span>span classw> /span>span classs2>buy/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>.../span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idget-part>Get Part/h3>p>GET code>https://api.epsilon3.io/v1/builds/parts/:partId?revisionId{revisionId}/code>/p>p>Retrieve a single part using its ID./p>p>strong>Parameters/strong>/p>ul>li>code>partId/code> (path parameter): ID of the part being retrieved./li>li>code>revisionId/code> (query parameter): optional ID used to retrieve a specific part revision/li>/ul>blockquote>p>Example Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>GET https://api.epsilon3.io/v1/builds/parts/vnWtKWleNWiuSQbBPNdE5F/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>vnWtKWleNWiuSQbBPNdE5F/span>span classp>,/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>C/span>span classp>,/span>span classw> /span>span classnl>part_number/span>span classp>:/span>span classw> /span>span classs2>P-1/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Sample Part/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>This is a sample part assembled in house./span>span classp>,/span>span classw> /span>span classnl>tracking/span>span classp>:/span>span classw> /span>span classs2>serial/span>span classp>,/span>span classw> /span>span classnl>allow_decimal_quantities/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>units/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>assembly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>procurement_type/span>span classp>:/span>span classw> /span>span classs2>make/span>span classp>,/span>span classw> /span>span classnl>details/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>xagtLhLxMEPLTgEHDNiEBa/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>External Id/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classs2>123/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>revisions/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>C/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>W4e4WfDe6ZU8OZdvIaJIUw/span>span classp>,/span>span classw> /span>span classnl>release_state/span>span classp>:/span>span classw> /span>span classs2>released/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>B/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>W4e4WfDe6ZU8OZdvIaJIUw/span>span classp>,/span>span classw> /span>span classnl>release_state/span>span classp>:/span>span classw> /span>span classs2>released/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>A/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>aIv8S4kVCWuHui7Dax7Smy/span>span classp>,/span>span classw> /span>span classnl>release_state/span>span classp>:/span>span classw> /span>span classs2>released/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>components/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>part_id/span>span classp>:/span>span classw> /span>span classs2>xi4kPknhkM79WlWdaEXHth/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>B/span>span classp>,/span>span classw> /span>span classnl>revision_id/span>span classp>:/span>span classw> /span>span classs2>3KV7aieAp7jkkE1wZl8WAp/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idcreate-parts>Create Parts/h3>blockquote>p>Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>POST https://api.epsilon3.io/v1/builds/parts/code>/pre>/div>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>parts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>part_number/span>span classp>:/span>span classw> /span>span classs2>P-1/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Sample Part/span>span classp>,/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>C/span>span classp>,/span>span classw> /span>span classnl>tracking/span>span classp>:/span>span classw> /span>span classs2>serial/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>This is a sample part assembled in house./span>span classp>,/span>span classw> /span>span classnl>assembly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>details/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>xagtLhLxMEPLTgEHDNiEBa/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classs2>123/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>.../span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>parts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>vnWtKWleNWiuSQbBPNdE5F/span>span classp>,/span>span classw> /span>span classnl>part_number/span>span classp>:/span>span classw> /span>span classs2>P-1/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Sample Part/span>span classp>,/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>C/span>span classp>,/span>span classw> /span>span classnl>tracking/span>span classp>:/span>span classw> /span>span classs2>serial/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>This is a sample part assembled in house./span>span classp>,/span>span classw> /span>span classnl>allow_decimal_quantities/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>units/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>assembly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>procurement_type/span>span classp>:/span>span classw> /span>span classs2>buy/span>span classp>,/span>span classw> /span>span classnl>details/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>xagtLhLxMEPLTgEHDNiEBa/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>External Id/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classs2>123/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>revisions/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>C/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>MkeDh0hepepkhKbczKGP0H/span>span classp>,/span>span classw> /span>span classnl>release_state/span>span classp>:/span>span classw> /span>span classs2>released/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>components/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>.../span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example request body with a component part/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>parts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>part_number/span>span classp>:/span>span classw> /span>span classs2>P-2/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Sample Part with components/span>span classp>,/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>A/span>span classp>,/span>span classw> /span>span classnl>tracking/span>span classp>:/span>span classw> /span>span classs2>serial/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>This is a sample part assembled in house./span>span classp>,/span>span classw> /span>span classnl>assembly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>procurement_type/span>span classp>:/span>span classw> /span>span classs2>make/span>span classp>,/span>span classw> /span>span classnl>components/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>part_number/span>span classp>:/span>span classw> /span>span classs2>P-1/span>span classp>,/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>C/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>.../span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body with different custom field value types/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>details/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1N0QAyYTU5nY7PWVXvaF84/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Text/span>span classw> /span>span classerr>field/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classs2>Example text value/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>02768b6e-29cc-4c26-94a1-32eef6173a0f/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Number/span>span classw> /span>span classerr>field/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classmi>456/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>2bcaa4b6-c062-4955-9ad6-9f128089753f/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Checkbox/span>span classw> /span>span classerr>field/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classkc>true/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>fbf9d2f0-3ba2-430e-a686-d93335edd036/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Date/span>span classw> /span>span classerr>Time/span>span classw> /span>span classerr>field/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classs2>2025-12-25T14:30:00.000Z/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>8761daca-66b5-4179-a21d-eeb12f140461/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Date/span>span classw> /span>span classerr>field/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classs2>2025-12-25/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>42b329ee-4c3a-468b-893b-af635d39f97e/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Custom/span>span classw> /span>span classerr>List/span>span classw> /span>span classerr>field/span>span classw> /span>span classerr>(Damaged/span>span classw> /span>span classerr>is/span>span classw> /span>span classerr>an/span>span classw> /span>span classerr>option/span>span classw> /span>span classerr>in/span>span classw> /span>span classerr>the/span>span classw> /span>span classerr>Custom/span>span classw> /span>span classerr>List)/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classs2>Damaged/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>f5c7d3d2-ca1d-4851-b9e8-6e63e8bc5ea0/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Time/span>span classw> /span>span classerr>field/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classp>{/span>span classnl>time/span>span classp>:/span>span classw> /span>span classs2>11:12:11/span>span classp>,/span>span classw> /span>span classnl>zone/span>span classp>:/span>span classw> /span>span classs2>US/Pacific/span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>a1b2c3d4-e5f6-7890-abcd-ef1234567890/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Unset/span>span classw> /span>span classerr>field/span>span classw> /span>span classerr>with/span>span classw> /span>span classkc>null/span>span classw> /span>span classerr>value/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>parts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>FMtBcwA5fYZwV4xOJwlRdZ/span>span classp>,/span>span classw> /span>span classnl>part_number/span>span classp>:/span>span classw> /span>span classs2>P-2/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Sample Part with components/span>span classp>,/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>A/span>span classp>,/span>span classw> /span>span classnl>tracking/span>span classp>:/span>span classw> /span>span classs2>serial/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>This is a sample part assembled in house./span>span classp>,/span>span classw> /span>span classnl>allow_decimal_quantities/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>units/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>assembly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>procurement_type/span>span classp>:/span>span classw> /span>span classs2>make/span>span classp>,/span>span classw> /span>span classnl>components/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>part_id/span>span classp>:/span>span classw> /span>span classs2>vnWtKWleNWiuSQbBPNdE5F/span>span classp>,/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>C/span>span classp>,/span>span classw> /span>span classnl>revision_id/span>span classp>:/span>span classw> /span>span classs2>MkeDh0hepepkhKbczKGP0H/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>revisions/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>A/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>k7jaxluqyThfl7PLBIkCbI/span>span classp>,/span>span classw> /span>span classnl>release_state/span>span classp>:/span>span classw> /span>span classs2>released/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>details/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>.../span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>POST code>https://api.epsilon3.io/v1/builds/parts/code>/p>p>Add one or more parts to your workspace./p>p>strong>Request Body/strong>/p>p>code>parts/code>: an array of objects, each containing the following set of fields/p>ul>li>code>part_number/code>: (required) Part Number or Identifier, unique across all parts in the workspace. Must be a string of up to 64 characters./li>li>code>revision/code>: (required) Revision Identifier. Must be a string of up to 64 characters./li>li>code>name/code>: (required) Part Name. Must be a string of up to 128 characters./li>li>code>tracking/code>: (required) Tracking type used for part. Must be one of code>serial/code>, code>lot/code>, or code>none/code>./li>li>code>description/code>: (optional) Part description. Must be a string of up to 512 characters./li>li>code>assembly/code>: (optional) Mark part as assembly. Must be a boolean value./li>li>code>procurement_type/code>: (optional) Mark part as 'buy', 'make', or 'make or buy'. Defaults to 'buy'./li>li>code>allow_decimal_quantities/code>: (optional) Set to code>true/code> to allow inventory items for this part to have decimal quantities (up to four significant digits).ul>li>Ignored for code>serial/code> tracked parts/li>/ul>/li>li>code>units/code>: (optional) Units to use for this part. Must be a string of up to 255 characters.ul>li>To set to a unit already defined in application settings, use the code>name/code> value for the unit/li>/ul>/li>li>code>components/code>: (optional) Part components. Must be an array of objects with the following format:ul>li>code>part_number/code>: (required) Part Number of the component part/li>li>code>revision/code>: (required) Revision identifier of the component part/li>li>code>quantity/code>: (required) Number of component parts. Must be a positive integer/li>/ul>/li>li>code>details/code>: (optional) Custom part detail fields to set on the part. Must be an array of objects with the following format:ul>li>code>id/code>: (required) ID of the part detail being set/li>li>code>value/code>: (required) Object containing:/li>li>code>recorded/code>: (required) The value to set for the part detail (supports strings, numbers, booleans, objects, or null). Set to null to unset/li>/ul>/li>/ul>p>strong>Response/strong>/p>p>The response status code will be 200 and return a list of the created parts./p>h3 idupdate-part>Update Part/h3>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Sample Part with components/span>span classp>,/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>B/span>span classp>,/span>span classw> /span>span classnl>tracking/span>span classp>:/span>span classw> /span>span classs2>serial/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>This is a sample part assembled in house./span>span classp>,/span>span classw> /span>span classnl>assembly/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>procurement_type/span>span classp>:/span>span classw> /span>span classs2>make/span>span classp>,/span>span classw> /span>span classnl>components/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>part_number/span>span classp>:/span>span classw> /span>span classs2>P-1/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>C/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>details/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>xagtLhLxMEPLTgEHDNiEBa/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classs2>123/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body with different custom field value types/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>details/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1N0QAyYTU5nY7PWVXvaF84/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Text/span>span classw> /span>span classerr>field/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classs2>Example text value/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>02768b6e-29cc-4c26-94a1-32eef6173a0f/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Number/span>span classw> /span>span classerr>field/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classmi>456/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>2bcaa4b6-c062-4955-9ad6-9f128089753f/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Checkbox/span>span classw> /span>span classerr>field/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classkc>true/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>fbf9d2f0-3ba2-430e-a686-d93335edd036/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Date/span>span classw> /span>span classerr>Time/span>span classw> /span>span classerr>field/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classs2>2025-12-25T14:30:00.000Z/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>8761daca-66b5-4179-a21d-eeb12f140461/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Date/span>span classw> /span>span classerr>field/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classs2>2025-12-25/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>42b329ee-4c3a-468b-893b-af635d39f97e/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Custom/span>span classw> /span>span classerr>List/span>span classw> /span>span classerr>field/span>span classw> /span>span classerr>(Damaged/span>span classw> /span>span classerr>is/span>span classw> /span>span classerr>an/span>span classw> /span>span classerr>option/span>span classw> /span>span classerr>in/span>span classw> /span>span classerr>the/span>span classw> /span>span classerr>Custom/span>span classw> /span>span classerr>List)/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classs2>Damaged/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>f5c7d3d2-ca1d-4851-b9e8-6e63e8bc5ea0/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Time/span>span classw> /span>span classerr>field/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classp>{/span>span classnl>time/span>span classp>:/span>span classw> /span>span classs2>11:12:11/span>span classp>,/span>span classw> /span>span classnl>zone/span>span classp>:/span>span classw> /span>span classs2>US/Pacific/span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>a1b2c3d4-e5f6-7890-abcd-ef1234567890/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Unset/span>span classw> /span>span classerr>field/span>span classw> /span>span classerr>with/span>span classw> /span>span classkc>null/span>span classw> /span>span classerr>value/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>FMtBcwA5fYZwV4xOJwlRdZ/span>span classp>,/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>B/span>span classp>,/span>span classw> /span>span classnl>part_number/span>span classp>:/span>span classw> /span>span classs2>P-2/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Sample Part with components/span>span classp>,/span>span classw> /span>span classnl>tracking/span>span classp>:/span>span classw> /span>span classs2>serial/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>This is a sample part assembled in house./span>span classp>,/span>span classw> /span>span classnl>allow_decimal_quantities/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>units/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>assembly/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>procurement_type/span>span classp>:/span>span classw> /span>span classs2>make/span>span classp>,/span>span classw> /span>span classnl>components/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>part_id/span>span classp>:/span>span classw> /span>span classs2>vnWtKWleNWiuSQbBPNdE5F/span>span classp>,/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>C/span>span classp>,/span>span classw> /span>span classnl>revision_id/span>span classp>:/span>span classw> /span>span classs2>MkeDh0hepepkhKbczKGP0H/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classnl>details/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>xagtLhLxMEPLTgEHDNiEBa/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>External Id/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classs2>123/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>revisions/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>B/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>W4e4WfDe6ZU8OZdvIaJIUw/span>span classp>,/span>span classw> /span>span classnl>release_state/span>span classp>:/span>span classw> /span>span classs2>released/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>A/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>k7jaxluqyThfl7PLBIkCbI/span>span classp>,/span>span classw> /span>span classnl>release_state/span>span classp>:/span>span classw> /span>span classs2>released/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>PATCH code>https://api.epsilon3.io/v1/builds/parts/:partId/code>/p>p>Updates values of one or more fields for a specific part./p>p>strong>Request Body/strong>/p>p>The request body should be a JSON object that contains the specific fields of the part to be updated. The request body must contain at least one field. Following fields are supported:/p>ul>li>code>revision/code>: (optional) Revision Identifier. Must be a string of up to 64 characters.ul>li>Updating the value of this field creates a new revision for the part./li>/ul>/li>li>code>name/code>: (optional) Part Name. Must be a string of up to 128 characters./li>li>code>tracking/code>: (optional) Tracking type used for part. Must be one of code>serial/code>, code>lot/code>, or code>none/code>./li>li>code>description/code>: (optional) Part description. Must be a string of up to 512 characters./li>li>code>allow_decimal_quantities/code>: (optional) Set to code>true/code> to allow inventory items for this part to have decimal quantities (up to four significant digits).ul>li>Ignored for code>serial/code> tracked parts/li>/ul>/li>li>code>units/code>: (optional) Units to use for this part. Must be a string of up to 255 characters.ul>li>Set to code>null/code> to clear/li>li>To set to a unit already defined in application settings, use the code>name/code> value for the unit/li>/ul>/li>li>code>assembly/code>: (optional) Mark part as assembly. Must be a boolean value./li>li>code>procurement_type/code>: (optional) Mark part as 'buy', 'make', or 'make or buy'. Defaults to 'buy'./li>li>code>components/code>: (optional) Part components.ul>li>Must be an array of objects with the following fields:/li>li>code>part_number/code>: (required) Part Number of the component part/li>li>code>revision/code>: (required) Revision identifier of the component part/li>li>code>quantity/code>: (required) Number of component parts. Must be a positive integer/li>li>The array provided in this request will replace the existing array of components. Specify an empty array to remove all components from a part./li>li>Component parts must already exist./li>/ul>/li>li>code>details/code>: (optional) Custom part detail fields to set or unset on the part.ul>li>Must be an array of objects with the following format:/li>li>code>id/code>: (required) ID of the part detail being set/li>li>code>value/code>: ul>li>code>recorded/code>: (required) The value to set for the part detail (supports strings, numbers, booleans, objects, or null). Set to null to unset/li>/ul>/li>li>Details already set on the part, but not provided in this array, will not be affected/li>/ul>/li>/ul>h3 idupdate-part-image>Update Part Image/h3>p>PUT code>https://api.epsilon3.io/v1/builds/parts/:partId/image/code>/p>p>Updates the primary image of the specified part with the provided file. The image is only updated for the latest revision of the part./p>p>strong>Request Body/strong>/p>p>This request should be sent as code>multipart/form-data/code> containing the following fields:/p>ul>li>code>name/code>: (required) Name of the file. Must be a string of up to 255 characters./li>li>code>file/code>: (required) The image file. File size must not exceed code>500 MB/code>./li>/ul>p>strong>Response Body/strong>/p>ul>li>Status: code>200 OK/code>/li>li>Body: em>(empty)/em>/li>/ul>h3 idattach-file-to-part>Attach File to Part/h3>p>POST code>https://api.epsilon3.io/v1/builds/parts/:partId/attachments/code>/p>p>Attaches the provided file to the specified part. The file is only attached to the latest revision of the part./p>p>strong>Request Body/strong>/p>p>This request should be sent as code>multipart/form-data/code> containing the following fields:/p>ul>li>code>name/code>: (required) Name of the file. Must be a string of up to 255 characters./li>li>code>file/code>: (required) The file being attached. File size must not exceed code>500 MB/code>./li>/ul>p>strong>Response Body/strong>/p>ul>li>Status: code>200 OK/code>/li>li>Body: em>(empty)/em>/li>/ul>h3 iddelete-part>Delete Part/h3>blockquote>p>Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ids/span>span classp>:/span>span classw> /span>span classerr>array/span>span classw> /span>span classerr>(string)/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ids/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>SRHRaJV1qBiYZdQ3Tm7P6C/span>span classp>,/span>span classw> /span>span classs2>vnWtKWleNWiuSQbBPNdE5F/span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>deleted_part_ids/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>SRHRaJV1qBiYZdQ3Tm7P6C/span>span classp>,/span>span classw> /span>span classnl>invalid_part_ids/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>vnWtKWleNWiuSQbBPNdE5F/span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>DELETE code>https://api.epsilon3.io/v1/builds/parts/code>/p>p>Bulk deletes parts using provided array of part ids. Deleting a part will also delete its associated revisions and items. strong>NOTE: Deleted parts will be permanently deleted./strong>/p>h2 idpart-details>Part Details/h2>h3 idlist-part-details>List Part Details/h3>p>GET code>https://api.epsilon3.io/v1/builds/part-details/code>/p>p>Retrieve all custom fields that can be set on a part/p>blockquote>p>Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>GET https://api.epsilon3.io/v1/builds/part-details/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>part_details/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>xagtLhLxMEPLTgEHDNiEBa/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>External Id/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idinventory>Inventory/h2>h3 idlist-inventory>List Inventory/h3>blockquote>p>Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>GET https://api.epsilon3.io/v1/builds/inventory/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>items/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>Uqo1eK43QThNE78Rl3HTco/span>span classp>,/span>span classw> /span>span classnl>part_id/span>span classp>:/span>span classw> /span>span classs2>vnWtKWleNWiuSQbBPNdE5F/span>span classp>,/span>span classw> /span>span classnl>part_revision_id/span>span classp>:/span>span classw> /span>span classs2>MkeDh0hepepkhKbczKGP0H/span>span classp>,/span>span classw> /span>span classnl>tracking_id/span>span classp>:/span>span classw> /span>span classs2>P1-004/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>location_id/span>span classp>:/span>span classw> /span>span classmi>23/span>span classp>,/span>span classw> /span>span classnl>unit_cost_cents/span>span classp>:/span>span classw> /span>span classmi>20000/span>span classp>,/span>span classw> /span>span classnl>weight_grams/span>span classp>:/span>span classw> /span>span classmf>250.5/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>Passed all quality checks!/span>span classp>,/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classs2>2023-07-18T14:49:08.713Z/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>.../span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/builds/inventory/code>/p>p>Retrieve all inventory items defined in your workspace./p>p>strong>Parameters/strong>/p>ul>li>code>partId/code> (query parameter): optional ID used to retrieve items only for a specific part. Specify the parameter multiple times, once for each specific part ID, to retrieve items for multiple specific parts./li>li>code>trackingId/code> (query parameter): optional ID used to filter retrieved items to match specified tracking ID. Specify the parameter multiple times, once for each specific tracking ID, to match against multiple tracking IDs./li>li>code>includeConsumed/code> (query parameter): optional parameter that can be set to indicate whether to include items with quantity value of 0. Must be either code>true/code> or code>false/code>. Defaults to code>true/code>./li>/ul>h3 idget-inventory-item>Get Inventory Item/h3>p>GET code>https://api.epsilon3.io/v1/builds/inventory/:itemId/code>/p>p>Retrieve a specific inventory item using its ID./p>blockquote>p>Example Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>GET https://api.epsilon3.io/v1/builds/inventory/Uqo1eK43QThNE78Rl3HTco/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>Uqo1eK43QThNE78Rl3HTco/span>span classp>,/span>span classw> /span>span classnl>part_id/span>span classp>:/span>span classw> /span>span classs2>vnWtKWleNWiuSQbBPNdE5F/span>span classp>,/span>span classw> /span>span classnl>part_revision_id/span>span classp>:/span>span classw> /span>span classs2>MkeDh0hepepkhKbczKGP0H/span>span classp>,/span>span classw> /span>span classnl>tracking_id/span>span classp>:/span>span classw> /span>span classs2>P1-004/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>location_id/span>span classp>:/span>span classw> /span>span classmi>23/span>span classp>,/span>span classw> /span>span classnl>unit_cost_cents/span>span classp>:/span>span classw> /span>span classmi>20000/span>span classp>,/span>span classw> /span>span classnl>weight_grams/span>span classp>:/span>span classw> /span>span classmf>250.5/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>Passed all quality checks!/span>span classp>,/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classs2>2023-07-18T14:49:08.713Z/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idadd-inventory>Add Inventory/h3>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>items/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>part_id/span>span classp>:/span>span classw> /span>span classs2>T7bpWix6bs86tEoCqIk26n/span>span classp>,/span>span classw> /span>span classnl>part_revision_id/span>span classp>:/span>span classw> /span>span classs2>m4ssiRUzCcN9mJUKjhvHvA/span>span classp>,/span>span classw> /span>span classnl>tracking_id/span>span classp>:/span>span classw> /span>span classs2>TP00001/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>location_id/span>span classp>:/span>span classw> /span>span classmi>23/span>span classp>,/span>span classw> /span>span classnl>unit_cost_cents/span>span classp>:/span>span classw> /span>span classmi>50000/span>span classp>,/span>span classw> /span>span classnl>weight_grams/span>span classp>:/span>span classw> /span>span classmf>125.75/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>All inspections passed!/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>.../span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example curl request to create inventory item with custom fields/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classk>${/span>span classnv>EPSILON3_API_KEY/span>span classk>}/span>: span classse>\/span> span classnt>-d/span> span classs1>{ items: { part_id: SRHRaJV1qBiYZdQ3Tm7P6C, tracking_id: API_TEST_1, quantity: 1, details: { id: fu0shg9uk3eYCeG3ctuAde, value: {recorded: Example text} }, { id: c1b031d9-33b0-40de-9eb1-893708882862, value: {recorded: 99} }, { id: 51d70499-3876-4415-a453-d47b6688046c, value: {recorded: Damaged} }, { id: fbf9d2f0-3ba2-430e-a686-d93335edd036, value: {recorded: 2025-12-25T14:30:00.000Z} }, { id: 2bcaa4b6-c062-4955-9ad6-9f128089753f, value: {recorded: true} } } }/span> span classse>\/span> https://api.epsilon3.io/v1/builds/inventory/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>items/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>f4yEjyK8PQNkdRy6EvncFy/span>span classp>,/span>span classw> /span>span classnl>part_id/span>span classp>:/span>span classw> /span>span classs2>T7bpWix6bs86tEoCqIk26n/span>span classp>,/span>span classw> /span>span classnl>part_revision_id/span>span classp>:/span>span classw> /span>span classs2>m4ssiRUzCcN9mJUKjhvHvA/span>span classp>,/span>span classw> /span>span classnl>tracking_id/span>span classp>:/span>span classw> /span>span classs2>TP00001/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>location_id/span>span classp>:/span>span classw> /span>span classmi>23/span>span classp>,/span>span classw> /span>span classnl>unit_cost_cents/span>span classp>:/span>span classw> /span>span classmi>50000/span>span classp>,/span>span classw> /span>span classnl>weight_grams/span>span classp>:/span>span classw> /span>span classmf>125.75/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>Passed all quality checks!/span>span classp>,/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classs2>2023-12-17T01:33:16.996Z/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>.../span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>POST code>https://api.epsilon3.io/v1/builds/inventory/code>/p>p>Adds new items to inventory./p>p>strong>Request Body/strong>/p>ul>li>code>items/code>: (required) An array of objects with the following fieldsul>li>code>part_id/code>: (required) System generated ID of the part of which this item is an instance. Must be a string./li>li>code>part_revision_id/code>: (optional) System generated ID for a specific revision of the part. If not specified, the latest part revision is used to create the item. Must be a string./li>li>code>tracking_id/code>: (required) Serial or Lot # of the item if it is a tracked item. Blank string if it is an untracked item. Must be a string of up to 64 characters./li>li>code>quantity/code>: (required) Item count. Must be a non negative integer. Count can only be either code>0/code> or code>1/code> for serial tracked items./li>li>code>location_id/code>: (optional) System generated ID of the specific location where this item should be located./li>li>code>unit_cost_cents/code>: (optional) Unit cost of item in US cents. Must be a non negative integer./li>li>code>weight_grams/code>: (optional) Weight of item in grams. Must be a non negative number./li>li>code>notes/code>: (optional) Any notes to attach to the item. Notes are displayed in the Epsilon3 Builds UI with support for Markdown. Must be a string of up to 4096 characters./li>li>code>details/code>: (optional) Custom inventory item detail fields to set on the item. Must be an array of objects with the following format:/li>li>code>id/code>: (required) ID of the inventory item detail being set/li>li>code>value/code>: (required) Value to set for the inventory item detail. For custom fields, use the format code>{"recorded": actualValue}/code> where code>actualValue/code> can be a string, number, boolean, date, or object/li>/ul>/li>/ul>h3 idupdate-inventory-item>Update Inventory Item/h3>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>location_id/span>span classp>:/span>span classw> /span>span classmi>23/span>span classp>,/span>span classw> /span>span classnl>unit_cost_cents/span>span classp>:/span>span classw> /span>span classmi>20000/span>span classp>,/span>span classw> /span>span classnl>weight_grams/span>span classp>:/span>span classw> /span>span classmf>250.5/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>Passed all quality checks!/span>span classp>,/span>span classw> /span>span classnl>details/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>xagtLhLxMEPLTgEHDNiEBa/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classs2>Updated detail value/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body to set different custom field value types/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>details/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>1N0QAyYTU5nY7PWVXvaF84/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Text/span>span classw> /span>span classerr>field/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classs2>Example text value/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>02768b6e-29cc-4c26-94a1-32eef6173a0f/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Number/span>span classw> /span>span classerr>field/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classmi>456/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>2bcaa4b6-c062-4955-9ad6-9f128089753f/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Checkbox/span>span classw> /span>span classerr>field/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classkc>true/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>fbf9d2f0-3ba2-430e-a686-d93335edd036/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Date/span>span classw> /span>span classerr>Time/span>span classw> /span>span classerr>field/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classs2>2025-12-25T14:30:00.000Z/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>8761daca-66b5-4179-a21d-eeb12f140461/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Date/span>span classw> /span>span classerr>field/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classs2>2025-12-25/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>42b329ee-4c3a-468b-893b-af635d39f97e/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Custom/span>span classw> /span>span classerr>List/span>span classw> /span>span classerr>field/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classs2>Damaged/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>f5c7d3d2-ca1d-4851-b9e8-6e63e8bc5ea0/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Time/span>span classw> /span>span classerr>field/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classnl>time/span>span classp>:/span>span classw> /span>span classs2>11:12:11/span>span classp>,/span>span classw> /span>span classnl>zone/span>span classp>:/span>span classw> /span>span classs2>US/Pacific/span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>a1b2c3d4-e5f6-7890-abcd-ef1234567890/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Unset/span>span classw> /span>span classerr>field/span>span classw> /span>span classerr>with/span>span classw> /span>span classkc>null/span>span classw> /span>span classerr>value/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>Uqo1eK43QThNE78Rl3HTco/span>span classp>,/span>span classw> /span>span classnl>part_id/span>span classp>:/span>span classw> /span>span classs2>vnWtKWleNWiuSQbBPNdE5F/span>span classp>,/span>span classw> /span>span classnl>part_revision_id/span>span classp>:/span>span classw> /span>span classs2>MkeDh0hepepkhKbczKGP0H/span>span classp>,/span>span classw> /span>span classnl>tracking_id/span>span classp>:/span>span classw> /span>span classs2>P1-004/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>location_id/span>span classp>:/span>span classw> /span>span classmi>23/span>span classp>,/span>span classw> /span>span classnl>unit_cost_cents/span>span classp>:/span>span classw> /span>span classmi>20000/span>span classp>,/span>span classw> /span>span classnl>weight_grams/span>span classp>:/span>span classw> /span>span classmf>250.5/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>Passed all quality checks!/span>span classp>,/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classs2>2023-07-18T14:49:08.713Z/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example curl request to update inventory item custom fields/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> PATCH span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classk>${/span>span classnv>EPSILON3_API_KEY/span>span classk>}/span>: span classse>\/span> span classnt>-d/span> span classs1>{ details: { id: fu0shg9uk3eYCeG3ctuAde, value: {recorded: Example text} }, { id: c1b031d9-33b0-40de-9eb1-893708882862, value: {recorded: 99} }, { id: 51d70499-3876-4415-a453-d47b6688046c, value: {recorded: Damaged} }, { id: fbf9d2f0-3ba2-430e-a686-d93335edd036, value: {recorded: 2025-12-25T14:30:00.000Z} }, { id: 2bcaa4b6-c062-4955-9ad6-9f128089753f, value: {recorded: true} } }/span> span classse>\/span> https://api.epsilon3.io/v1/builds/inventory/:itemId/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>Uqo1eK43QThNE78Rl3HTco/span>span classp>,/span>span classw> /span>span classnl>part_id/span>span classp>:/span>span classw> /span>span classs2>vnWtKWleNWiuSQbBPNdE5F/span>span classp>,/span>span classw> /span>span classnl>part_revision_id/span>span classp>:/span>span classw> /span>span classs2>MkeDh0hepepkhKbczKGP0H/span>span classp>,/span>span classw> /span>span classnl>tracking_id/span>span classp>:/span>span classw> /span>span classs2>P1-004/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>location_id/span>span classp>:/span>span classw> /span>span classmi>23/span>span classp>,/span>span classw> /span>span classnl>unit_cost_cents/span>span classp>:/span>span classw> /span>span classmi>20000/span>span classp>,/span>span classw> /span>span classnl>weight_grams/span>span classp>:/span>span classw> /span>span classmf>250.5/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>Passed all quality checks!/span>span classp>,/span>span classw> /span>span classnl>details/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>fu0shg9uk3eYCeG3ctuAde/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Text Field/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classs2>Example text/span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>c1b031d9-33b0-40de-9eb1-893708882862/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Number Field/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classmi>99/span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>51d70499-3876-4415-a453-d47b6688046c/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Status Field/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classs2>Damaged/span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classs2>2023-07-18T14:49:08.713Z/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>PATCH code>https://api.epsilon3.io/v1/builds/inventory/:itemId/code>/p>p>Updates values of one or more fields for a specific item./p>p>strong>Request Body/strong>/p>p>The request body should be a JSON object that contains the specific fields of the item to be updated. The request body must contain at least one field. Following fields are supported:/p>ul>li>code>quantity/code>: (optional) Must be a non-negative integer. For serial tracked items, must be either code>0/code> or code>1/code>./li>li>code>location_id/code>: (optional) Location ID mapped to the location. Set to code>null/code> to remove./li>li>code>unit_cost_cents/code>: (optional) Unit Cost of item in U.S. cents. Set to code>null/code> to remove./li>li>code>weight_grams/code>: (optional) Weight of item in grams. Must be a non negative number. Set to code>null/code> to remove./li>li>code>notes/code>: (optional) Free text notes to attach to item. Must be a string of up to 4096 characters./li>li>code>details/code>: (optional) Custom inventory item detail fields to update. Must be an array of 0 to 500 objects with:ul>li>code>id/code>: (required) ID of the custom field/li>li>code>value/code>: (required) The value to set for the custom field. For custom fields, use the format code>{"recorded": actualValue}/code> where code>actualValue/code> can be a string, number, boolean, date, or object. Set to code>null/code> to unset the field/li>/ul>/li>/ul>h3 iddelete-inventory>Delete Inventory/h3>p>DELETE code>https://api.epsilon3.io/v1/builds/inventory/code>/p>p>Bulk deletes inventory items using provided array of item ids./p>blockquote>p>Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ids/span>span classp>:/span>span classw> /span>span classerr>array/span>span classw> /span>span classerr>(string)/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ids/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>SRHRaJV1qBiYZdQ3Tm7P6C/span>span classp>,/span>span classw> /span>span classs2>vnWtKWleNWiuSQbBPNdE5F/span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>deleted_item_ids/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>SRHRaJV1qBiYZdQ3Tm7P6C/span>span classp>,/span>span classw> /span>span classnl>invalid_item_ids/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>vnWtKWleNWiuSQbBPNdE5F/span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idlist-inventory-item-activity>List Inventory Item Activity/h3>blockquote>p>Example Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>GET https://api.epsilon3.io/v1/builds/inventory/6nNJuH7hga4HYCNOL7htbb/activity?startBeforeId99/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>has_older/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>activities/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>98/span>span classp>,/span>span classw> /span>span classnl>item_id/span>span classp>:/span>span classw> /span>span classs2>6nNJuH7hga4HYCNOL7htbb/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classw> /span>span classs2>2024-10-18T20:02:38.901Z/span>span classp>,/span>span classw> /span>span classnl>action/span>span classp>:/span>span classw> /span>span classs2>Created/span>span classp>,/span>span classw> /span>span classnl>actor_type/span>span classp>:/span>span classw> /span>span classs2>user/span>span classp>,/span>span classw> /span>span classnl>actor_id/span>span classp>:/span>span classw> /span>span classs2>user@epsilon3.io/span>span classp>,/span>span classw> /span>span classnl>old_value/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>new_value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>amount/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>In Inventory/span>span classp>,/span>span classw> /span>span classnl>location_id/span>span classp>:/span>span classw> /span>span classmi>23/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/builds/inventory/:itemId/activity?startBeforeId{startBeforeId}/code>/p>p>List up to twenty five most recent actions related to the specified inventory item. Use the optional code>startBeforeId/code> query parameter to list older actions./p>p>strong>Parameters/strong>/p>ul>li>code>itemId/code> (path parameter): ID of the item for which to list activity/li>li>code>startBeforeId/code> (query parameter): optional integer that can be used to list older activity. When this is set, up to twenty five most recent actions that are older than the activity mapped to this ID are listed./li>/ul>h3 idupdate-inventory-item-usage>Update Inventory Item Usage/h3>p>POST code>https://api.epsilon3.io/v1/builds/inventory/:itemId/usage/code>/p>p>Updates usage for an inventory item. (Note: currently only reset is supported.)/p>blockquote>p>Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>action/span>span classp>:/span>span classw> /span>span classs2>reset/span>span classp>,/span>span classw> /span>span classnl>usage_type/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>action/span>span classp>:/span>span classw> /span>span classs2>reset/span>span classp>,/span>span classw> /span>span classnl>usage_type/span>span classp>:/span>span classw> /span>span classs2>cycles/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/builds/inventory/:itemId/usage/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>action/span>span classp>:/span> span classs>reset/span>span classp>,/span> span classs>usage_type/span>span classp>:/span> span classs>cycles/span>span classp>,/span> span classp>}/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST span classse>\/span> https://api.epsilon3.io/v1/builds/inventory/:itemId/usage span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ action: reset, usage_type: cycles, }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/builds/inventory/:itemId/usage/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>action/span>span classerr>:/span>span classw> /span>span classs2>reset/span>span classp>,/span>span classw> /span>span classs2>usage_type/span>span classerr>:/span>span classw> /span>span classs2>cycles/span>span classp>,/span>span classw>/span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Post/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>strong>Response/strong>/p>p>The response status code will be 200 on successful reset./p>h2 idpurchase-orders>Purchase Orders/h2>h3 idlist-purchase-orders>List Purchase Orders/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/builds/orders/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/builds/orders span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/builds/orders/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/builds/orders/code>/p>p>Retrieve all purchase orders in your workspace./p>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>orders/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>hCga2bVz70tAXnjhHbvczA/span>span classp>,/span>span classw> /span>span classnl>code/span>span classp>:/span>span classw> /span>span classs2>PO-1/span>span classp>,/span>span classw> /span>span classnl>state/span>span classp>:/span>span classw> /span>span classs2>submitted/span>span classp>,/span>span classw> /span>span classnl>delivery_date/span>span classp>:/span>span classw> /span>span classs2>07/01/2024/span>span classp>,/span>span classw> /span>span classnl>items/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>part_id/span>span classp>:/span>span classw> /span>span classs2>66qVqW9X5NKz7qPJhrlFtG/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Rocket Engine/span>span classp>,/span>span classw> /span>span classnl>revision/span>span classp>:/span>span classw> /span>span classs2>1.00/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>unit_cost/span>span classp>:/span>span classw> /span>span classmi>8000/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>ship_to_name/span>span classp>:/span>span classw> /span>span classs2>Headquarters/span>span classp>,/span>span classw> /span>span classnl>ship_to_address/span>span classp>:/span>span classw> /span>span classs2>123 Alpha Way/span>span classse>\n/span>span classs2>Anytown USA/span>span classse>\n/span>span classs2>10101/span>span classp>,/span>span classw> /span>span classnl>vendor/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>4kGbI42h7cIo0Ai3dsC9m3/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Acme Engines Ltd/span>span classp>,/span>span classw> /span>span classnl>address/span>span classp>:/span>span classw> /span>span classs2>1428 Satellite Loop/span>span classse>\n/span>span classs2>Anytown USA/span>span classse>\n/span>span classs2>10101/span>span classp>,/span>span classw> /span>span classnl>contact/span>span classp>:/span>span classw> /span>span classs2>elmer@acme.test/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>Brick & Mortar are our specialties/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classs2>2024-06-19T02:06:14.204Z/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idvendors>Vendors/h2>h3 idlist-vendors>List Vendors/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/builds/vendors/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/builds/vendors span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/builds/vendors/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/builds/vendors/code>/p>p>Retrieve all vendors defined in your workspace./p>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>vendors/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>4kGbI42h7cIo0Ai3dsC9m3/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Acme Engines Ltd/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>Brick & Mortar are our specialties/span>span classp>,/span>span classw> /span>span classnl>address/span>span classp>:/span>span classw> /span>span classs2>1428 Satellite Loop/span>span classse>\n/span>span classs2>Anytown USA/span>span classse>\n/span>span classs2>10101/span>span classp>,/span>span classw> /span>span classnl>contact/span>span classp>:/span>span classw> /span>span classs2>310-111-1111/span>span classp>,/span>span classw> /span>span classnl>team_id/span>span classp>:/span>span classw> /span>span classs2>teamolympus/span>span classp>,/span>span classw> /span>span classnl>emails/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classs2>brian@acme.test/span>span classp>,/span>span classw> /span>span classs2>tom@acme.test/span>span classw> /span>span classp>/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classs2>2024-07-17T20:21:38.417Z/span>span classp>,/span>span classw> /span>span classnl>updated_at/span>span classp>:/span>span classw> /span>span classs2>2024-07-17T20:21:38.417Z/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idlocations>Locations/h2>h3 idlist-locations>List Locations/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/builds/locations/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/builds/locations span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/builds/locations/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/builds/locations/code>/p>p>Retrieve all inventory locations defined in your workspace./p>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>locations/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>22/span>span classp>,/span>span classw> /span>span classnl>uid/span>span classp>:/span>span classw> /span>span classs2>Yi8xjnVtFLh9Avf9hqdw5q/span>span classp>,/span>span classw> /span>span classnl>parent_location_id/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Building 1/span>span classp>,/span>span classw> /span>span classnl>code/span>span classp>:/span>span classw> /span>span classs2>B1/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>23/span>span classp>,/span>span classw> /span>span classnl>uid/span>span classp>:/span>span classw> /span>span classs2>zBT85pmgbrXf5OIIb2K3Kg/span>span classp>,/span>span classw> /span>span classnl>parent_location_id/span>span classp>:/span>span classw> /span>span classmi>22/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Workstation A/span>span classp>,/span>span classw> /span>span classnl>code/span>span classp>:/span>span classw> /span>span classs2>WS1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h1 idcommanding-api>Commanding API/h1>p>Epsilon3’s commanding API supports creating, updating, retrieving, or deleting commands. Uploading commands to the commanding API allows the user to do the following in Epsilon3:/p>ul>li>Search for and insert commands when creating a procedure/li>li>Send commands to external systems with optional arguments in a running procedure/li>/ul>h3 idcreate-or-update-a-command>Create or update a command/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/commands/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>name/span>span classp>:/span> span classs>test.command/span>span classp>,/span> span classs>dictionary_id/span>span classp>:/span> span classmi>1/span>span classp>,/span> span classs>arguments/span>span classp>:/span> span classp>/span> span classp>{/span> span classs>name/span>span classp>:/span> span classs>arg1/span>span classp>,/span> span classs>type/span>span classp>:/span> span classs>enum/span>span classp>,/span> span classs>values/span>span classp>:/span> span classp>/span> span classp>{/span> span classs>string/span>span classp>:/span> span classs>OFF/span>span classp>,/span> span classs>value/span>span classp>:/span> span classmi>0/span> span classp>},/span> span classp>{/span> span classs>string/span>span classp>:/span> span classs>ON/span>span classp>,/span> span classs>value/span>span classp>:/span> span classmi>1/span> span classp>}/span> span classp>},/span> span classp>{/span> span classs>name/span>span classp>:/span> span classs>arg2/span>span classp>,/span> span classs>type/span>span classp>:/span> span classs>int/span>span classp>,/span> span classs>optional/span>span classp>:/span> span classn>true/span> span classp>}/span> span classp>}/span> span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST span classse>\/span> https://api.epsilon3.io/v1/commands span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ name: test.command, dictionary_id: 1, arguments: { name: arg1, type: enum, values: { string: OFF, value: 0 }, { string: ON, value: 1 } }, { name: arg2, type: int, optional: true } }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/commands/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>name/span>span classerr>:/span>span classw> /span>span classs2>test.command/span>span classp>,/span>span classw> /span>span classs2>dictionary_id/span>span classerr>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>arguments/span>span classerr>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>arg1/span>span classp>,/span>span classw> /span>span classs2>type/span>span classp>:/span>span classw> /span>span classs2>enum/span>span classp>,/span>span classw> /span>span classs2>values/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>string/span>span classp>:/span>span classw> /span>span classs2>OFF/span>span classp>,/span>span classw> /span>span classs2>value/span>span classp>:/span>span classw> /span>span classmi>0/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>string/span>span classp>:/span>span classw> /span>span classs2>ON/span>span classp>,/span>span classw> /span>span classs2>value/span>span classp>:/span>span classw> /span>span classmi>1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>arg2/span>span classp>,/span>span classw> /span>span classs2>type/span>span classp>:/span>span classw> /span>span classs2>int/span>span classp>,/span>span classw> /span>span classs2>optional/span>span classp>:/span>span classw> /span>span classn>true/span>span classw> /span>span classp>}/span>span classw> /span>span classerr>/span>span classw>/span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo/span>span classnt>-Json/span>span classw>/span>span classn>Invoke/span>span classnt>-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classn>Post/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>blockquote>p>Request Body (Command Object)/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>dictionary-id/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classw> /span>span classerr>(optional)/span>span classp>,/span>span classw> /span>span classnl>arguments/span>span classp>:/span>span classw> /span>span classerr>array/span>span classw> /span>span classerr>(optional)/span>span classp>,/span>span classw> /span>span classnl>expiration_seconds/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classw> /span>span classerr>(optional)/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Argument Object/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>optional/span>span classp>:/span>span classw> /span>span classerr>boolean/span>span classw> /span>span classerr>(optional/span>span classp>,/span>span classw> /span>span classerr>defaults/span>span classw> /span>span classerr>to/span>span classw> /span>span classkc>false/span>span classerr>)/span>span classw> /span>span classnl>values/span>span classp>:/span>span classw> /span>span classerr>array/span>span classw> /span>span classerr>(optional)/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>POST code>https://api.epsilon3.io/v1/commands/code>/p>p>The code>name/code> field should be unique per dictionary. The code>arguments/code> field contains an array of one or more Argument objects. The optional code>dictionary_id/code> field allows the command to be related to a dictionary. If no code>dictionary_id/code> is provided, the command will be related to the default dictionary./p>p>The optional code>expiration_seconds/code> field enables strong>asynchronous command execution/strong>. When set, commands will be executed asynchronously, allowing for long-running operations that can take minutes or hours to complete. The value specifies the maximum execution timeout in seconds (1 to 18000, maximum 5 hours). See the a href#commanding>Realtime Commanding Section/a> for details./p>p>Supported argument types:/p>ul>li>code>float/code>/li>li>code>int/code>/li>li>code>string/code>/li>li>code>enum/code>/li>li>code>file/code>/li>/ul>blockquote>p>Enum Object/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>string/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classerr>number/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classwarning>Supported integer range is -9007199254740991 to 9007199254740991 (53 bit signed)./aside>aside classnotice>For enum types only, populate the code>values/code> field with one or more Enum objects. Each “value” field in the “values” array should be unique./aside>blockquote>p>Example Request Body (No Arguments)/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>test.hatch.1.open/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body (with a dictionary)/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>test.hatch.1.open/span>span classp>,/span>span classw> /span>span classnl>dictionary_id/span>span classp>:/span>span classw> /span>span classmi>5/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body (Float)/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>test.pressure.level/span>span classp>,/span>span classw> /span>span classnl>arguments/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>psi/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>float/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body (Int)/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>test.timer/span>span classp>,/span>span classw> /span>span classnl>arguments/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>seconds/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>int/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body (String)/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>test.alert/span>span classp>,/span>span classw> /span>span classnl>arguments/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>message/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>string/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body (Enum)/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>test.power.switch/span>span classp>,/span>span classw> /span>span classnl>arguments/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>state/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>enum/span>span classp>,/span>span classw> /span>span classnl>values/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>string/span>span classp>:/span>span classw> /span>span classs2>OFF/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classmi>0/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>string/span>span classp>:/span>span classw> /span>span classs2>ON/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classmi>1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body (File)/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>test.config.file/span>span classp>,/span>span classw> /span>span classnl>arguments/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>config.file/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>file/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>dictionary_id/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw> /span>span classerr>(optional)/span>span classp>,/span>span classw> /span>span classnl>arguments/span>span classp>:/span>span classw> /span>span classerr>array/span>span classw> /span>span classerr>(optional)/span>span classp>,/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>timestamp/span>span classw> /span>span classerr>in/span>span classw> /span>span classerr>ISO/span>span classmi>-8601/span>span classw> /span>span classerr>format/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classsuccess>If successful, the response contains the created or updated Command object with an additional `created_at` field. If the command already exists, the request will update the existing command. The command name can be used to retrieve or update the command./aside>h3 idlist-all-available-commands>List all available commands/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/commands/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/commands span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/commands/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/commands/code>/p>blockquote>p>Sample Request with Query Parameters/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/commands/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>params/span>span classo>/span>span classp>{/span> span classs>dictionary-group-ids/span>span classp>:/span> span classs>1,5,28/span> span classp>}/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> span classs2>https://api.epsilon3.io/v1/commands?dictionary-group-ids1,5,28/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/commands?dictionary-group-ids1,5,28/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/commands?dictionary-group-ids{dictionary-group-ids}/code>/p>p>The optional URL parameter code>dictionary-group-ids/code> may be provided to filter commands by dictionary groups. The value should be a comma-separated list of dictionary group IDs. The response will only contain commands that belong to at least one of the specified dictionary groups./p>blockquote>p>Response Body (List of Command Objects)/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>dictionary_id/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classnl>arguments/span>span classp>:/span>span classw> /span>span classerr>array/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>timestamp/span>span classw> /span>span classerr>in/span>span classw> /span>span classerr>ISO/span>span classmi>-8601/span>span classw> /span>span classerr>format/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classsuccess>If successful, the response contains a list of Command objects with a code>created_at/code> field./aside>h3 idretrieve-a-command-by-name>Retrieve a command by name/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/commands/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>params/span>span classo>/span>span classp>{/span> span classs>name/span>span classp>:/span> span classs>test.command/span>span classp>,/span> span classs>dictionary-id/span>span classp>:/span> span classmi>1/span> span classp>}/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> span classs2>https://api.epsilon3.io/v1/commands/query?nametest.command&dictionary-id1/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/commands/query?nametest.command&dictionary-id1/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/commands/query?name{name}&dictionary-id{dictionary-id}/code>/p>p>The URL parameter code>name/code> is required and must be URL encoded. An optional code>dictionary-id/code> may be provided to choose a specific dictionary. If code>dictionary-id/code> is not included, the default dictionary will be used./p>aside classwarning>The request body must be empty./aside>aside classsuccess>If successful, the response contains a Command object with a code>created_at/code> field./aside>h3 iddelete-commands>Delete commands/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>delete/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/commands/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>ids/span>span classp>:/span> span classp>/span>span classmi>1/span>span classp>,/span> span classmi>2/span>span classp>,/span> span classmi>3/span>span classp>/span> span classp>}/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> DELETE span classse>\/span> https://api.epsilon3.io/v1/commands span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ ids: 1, 2, 3 }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/commands/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>ids/span>span classerr>:/span>span classw> /span>span classp>@(/span>span classmi>1/span>span classp>,/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw> /span>span classmi>3/span>span classp>)/span>span classw> /span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Delete/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>p>DELETE code>https://api.epsilon3.io/v1/commands//code>/p>blockquote>p>Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ids/span>span classp>:/span>span classw> /span>span classerr>array/span>span classw> /span>span classerr>(integer)/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ids/span>span classp>:/span>span classw> /span>span classp>/span>span classmi>123/span>span classp>,/span>span classw> /span>span classmi>456/span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classsuccess>If successful, the response body is empty./aside>h1 idcustom-fields-api>Custom Fields API/h1>p>Manage custom fields that can be attached to entities such as Issues, Parts, Inventory Items, and more./p>h3 idlist-custom-fields>List Custom Fields/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/fields/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/fields span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/fields/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/fields/code>/p>p>Retrieve all custom field definitions available in your workspace./p>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>fld_1/span>span classp>,/span>span classw> /span>span classnl>team_id/span>span classp>:/span>span classw> /span>span classs2>team123/span>span classp>,/span>span classw> /span>span classnl>field_id/span>span classp>:/span>span classw> /span>span classs2>external_id/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>External Id/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>Text/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>External reference/span>span classp>,/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classs2>2025-08-21T16:46:47.352Z/span>span classp>,/span>span classw> /span>span classnl>updated_at/span>span classp>:/span>span classw> /span>span classs2>2025-08-21T16:46:47.352Z/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>fld_2/span>span classp>,/span>span classw> /span>span classnl>team_id/span>span classp>:/span>span classw> /span>span classs2>team123/span>span classp>,/span>span classw> /span>span classnl>field_id/span>span classp>:/span>span classw> /span>span classs2>priority/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Priority/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>Custom List/span>span classp>,/span>span classw> /span>span classnl>metadata/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>options/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>High/span>span classp>,/span>span classw> /span>span classs2>Medium/span>span classp>,/span>span classw> /span>span classs2>Low/span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classs2>2025-08-21T18:27:52.802Z/span>span classp>,/span>span classw> /span>span classnl>updated_at/span>span classp>:/span>span classw> /span>span classs2>2025-08-21T18:27:52.802Z/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idcreate-custom-fields>Create Custom Fields/h3>blockquote>p>Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>POST https://api.epsilon3.io/v1/fields/code>/pre>/div>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>fields/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>External Id/span>span classp>,/span>span classw> /span>span classnl>field_id/span>span classp>:/span>span classw> /span>span classs2>external_id/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>Text/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>External reference/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Priority/span>span classp>,/span>span classw> /span>span classnl>field_id/span>span classp>:/span>span classw> /span>span classs2>priority/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>Custom List/span>span classp>,/span>span classw> /span>span classnl>metadata/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>options/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>High/span>span classp>,/span>span classw> /span>span classs2>Medium/span>span classp>,/span>span classw> /span>span classs2>Low/span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/fields/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>fields/span>span classp>:/span> span classp>/span> span classp>{/span> span classs>name/span>span classp>:/span> span classs>External Id/span>span classp>,/span> span classs>field_id/span>span classp>:/span> span classs>external_id/span>span classp>,/span> span classs>type/span>span classp>:/span> span classs>Text/span> span classp>},/span> span classp>{/span> span classs>name/span>span classp>:/span> span classs>Priority/span>span classp>,/span> span classs>field_id/span>span classp>:/span> span classs>priority/span>span classp>,/span> span classs>type/span>span classp>:/span> span classs>Custom List/span>span classp>,/span> span classs>metadata/span>span classp>:/span> span classp>{/span> span classs>options/span>span classp>:/span> span classp>/span>span classs>High/span>span classp>,/span> span classs>Medium/span>span classp>,/span> span classs>Low/span>span classp>/span> span classp>}/span> span classp>}/span> span classp>/span> span classp>}/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST span classse>\/span> https://api.epsilon3.io/v1/fields span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ fields: { name: External Id, field_id: external_id, type: Text }, { name: Priority, field_id: priority, type: Custom List, metadata: { options: High, Medium, Low } } }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/fields/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classnx>fields/span>span classw> /span>span classo>/span>span classw> /span>span classp>@(/span>span classw> /span>span classp>@{/span>span classw> /span>span classnx>name/span>span classw> /span>span classo>/span>span classw> /span>span classs2>External Id/span>span classp>;/span>span classw> /span>span classnx>field_id/span>span classw> /span>span classo>/span>span classw> /span>span classs2>external_id/span>span classp>;/span>span classw> /span>span classnx>type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Text/span>span classw> /span>span classp>},/span>span classw> /span>span classp>@{/span>span classw> /span>span classnx>name/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Priority/span>span classp>;/span>span classw> /span>span classnx>field_id/span>span classw> /span>span classo>/span>span classw> /span>span classs2>priority/span>span classp>;/span>span classw> /span>span classnx>type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Custom List/span>span classp>;/span>span classw> /span>span classnx>metadata/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classnx>options/span>span classw> /span>span classo>/span>span classw> /span>span classp>@(/span>span classs2>High/span>span classp>,/span>span classs2>Medium/span>span classp>,/span>span classs2>Low/span>span classp>)/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>)/span>span classw>/span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw> /span>span classnt>-Depth/span>span classw> /span>span classnx>5/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Post/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>fields/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>fld_1/span>span classp>,/span>span classw> /span>span classnl>team_id/span>span classp>:/span>span classw> /span>span classs2>team123/span>span classp>,/span>span classw> /span>span classnl>field_id/span>span classp>:/span>span classw> /span>span classs2>external_id/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>External Id/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>Text/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>External reference/span>span classp>,/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classs2>2025-08-21T16:46:47.352Z/span>span classp>,/span>span classw> /span>span classnl>updated_at/span>span classp>:/span>span classw> /span>span classs2>2025-09-14T16:46:47.352Z/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>fld_2/span>span classp>,/span>span classw> /span>span classnl>team_id/span>span classp>:/span>span classw> /span>span classs2>team123/span>span classp>,/span>span classw> /span>span classnl>field_id/span>span classp>:/span>span classw> /span>span classs2>priority/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Priority/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>Custom List/span>span classp>,/span>span classw> /span>span classnl>metadata/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>options/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>High/span>span classp>,/span>span classw> /span>span classs2>Medium/span>span classp>,/span>span classw> /span>span classs2>Low/span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classs2>2025-08-21T18:27:52.802Z/span>span classp>,/span>span classw> /span>span classnl>updated_at/span>span classp>:/span>span classw> /span>span classs2>2025-09-14T16:46:47.352Z/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>POST code>https://api.epsilon3.io/v1/fields/code>/p>p>Add one or more custom fields to your workspace./p>p>strong>Request Body/strong>/p>p>code>fields/code>: an array (1–1000) of objects, each with the following fields/p>ul>li>code>name/code>: (required) string, 1–255 characters/li>li>code>field_id/code>: (required) string, 1–255 characters (unique across all custom fields in the workspace)/li>li>code>type/code>: (required) one of code>Text/code>, code>Number/code>, code>Date/code>, code>Time/code>, code>Date Time/code>, code>Checkbox/code>, code>List/code>, code>Custom List/code>, code>External Data/code>/li>li>code>description/code>: (optional) string, up to 1000 characters/li>li>code>metadata/code>: (optional unless required by code>type/code>) objectul>li>For code>Number/code>: (optional) code>{ "units": string }/code>/li>li>For code>List/code>: (required) code>{ "list_id": string }/code>/li>li>For code>Custom List/code>: (required) code>{ "options": string }/code>/li>li>For code>External Data/code>: (required) code>{ "external_data_type": string, "dictionary_id": number }/code>/li>/ul>/li>/ul>blockquote>p>Additional Examples/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>fields/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Mass/span>span classp>,/span>span classw> /span>span classnl>field_id/span>span classp>:/span>span classw> /span>span classs2>mass/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>Number/span>span classp>,/span>span classw> /span>span classnl>metadata/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>units/span>span classp>:/span>span classw> /span>span classs2>kg/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Status/span>span classp>,/span>span classw> /span>span classnl>field_id/span>span classp>:/span>span classw> /span>span classs2>status/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>List/span>span classp>,/span>span classw> /span>span classnl>metadata/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>list_id/span>span classp>:/span>span classw> /span>span classs2>issue_status/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Priority/span>span classp>,/span>span classw> /span>span classnl>field_id/span>span classp>:/span>span classw> /span>span classs2>priority/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>Custom List/span>span classp>,/span>span classw> /span>span classnl>metadata/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>options/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>High/span>span classp>,/span>span classs2>Medium/span>span classp>,/span>span classs2>Low/span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Vendor/span>span classp>,/span>span classw> /span>span classnl>field_id/span>span classp>:/span>span classw> /span>span classs2>vendor/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>External Data/span>span classp>,/span>span classw> /span>span classnl>metadata/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>external_data_type/span>span classp>:/span>span classw> /span>span classs2>supplier/span>span classp>,/span>span classw> /span>span classnl>dictionary_id/span>span classp>:/span>span classw> /span>span classmi>42/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>strong>Response/strong>/p>p>The response status code will be 201 and return code>{ "fields": ... }/code>./p>h3 idupdate-custom-field>Update Custom Field/h3>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Priority Level/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>Task priority/span>span classp>,/span>span classw> /span>span classnl>field_id/span>span classp>:/span>span classw> /span>span classs2>priority/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>fld_2/span>span classp>,/span>span classw> /span>span classnl>team_id/span>span classp>:/span>span classw> /span>span classs2>team123/span>span classp>,/span>span classw> /span>span classnl>field_id/span>span classp>:/span>span classw> /span>span classs2>priority/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Priority Level/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>Custom List/span>span classp>,/span>span classw> /span>span classnl>metadata/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>options/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>High/span>span classp>,/span>span classw> /span>span classs2>Medium/span>span classp>,/span>span classw> /span>span classs2>Low/span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>Task priority/span>span classp>,/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classs2>2025-08-21T18:27:52.802Z/span>span classp>,/span>span classw> /span>span classnl>updated_at/span>span classp>:/span>span classw> /span>span classs2>2025-09-14T16:46:47.352Z/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>PATCH code>https://api.epsilon3.io/v1/fields/:id/code>/p>p>Updates values of one or more fields for a specific custom field. The code>type/code> cannot be changed. The request body must contain at least one field./p>p>strong>Request Body/strong>/p>ul>li>code>name/code>: (optional) string, 1–255 characters/li>li>code>description/code>: (optional) string, up to 1000 characters/li>li>code>field_id/code>: (optional) string, 1–255 characters/li>li>code>metadata/code>: (optional) object that must conform to the field's existing code>type/code>ul>li>For code>Number/code>: code>{ "units": string }/code>/li>li>For code>List/code>: code>{ "list_id": string }/code>/li>li>For code>Custom List/code>: code>{ "options": string }/code>/li>li>For code>External Data/code>: code>{ "external_data_type": string, "dictionary_id": number }/code>/li>/ul>/li>/ul>p>strong>Response/strong>/p>p>The response status code will be 200 and return the updated field object./p>h3 idlist-forms>List Forms/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/forms/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>params/span>span classo>/span>span classp>{/span> span classs>entity/span>span classp>:/span> span classs>Issue/span> span classp>}/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> span classs2>https://api.epsilon3.io/v1/forms?entityIssue/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/forms?entityIssue/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/forms/code>/p>p>Retrieve all custom field forms available in your workspace. Optionally filter by entity type./p>blockquote>p>Query Parameters/p>/blockquote>ul>li>code>entity/code> (optional): one of code>Hazard/code>, code>InventoryItem/code>, code>Issue/code>, code>Part/code>, code>PurchaseOrder/code>, code>Risk/code>, code>WorkOrder/code>/li>/ul>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>frm_1/span>span classp>,/span>span classw> /span>span classnl>team_id/span>span classp>:/span>span classw> /span>span classs2>team123/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Issue/span>span classp>,/span>span classw> /span>span classnl>entity_type/span>span classp>:/span>span classw> /span>span classs2>Issue/span>span classp>,/span>span classw> /span>span classnl>fields/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>fld_sys_1/span>span classp>,/span>span classw> /span>span classnl>team_id/span>span classp>:/span>span classw> /span>span classs2>team123/span>span classp>,/span>span classw> /span>span classnl>field_id/span>span classp>:/span>span classw> /span>span classs2>external_id/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>External Id/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>Text/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>External reference/span>span classp>,/span>span classw> /span>span classnl>required/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>default_value/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>fld_sys_2/span>span classp>,/span>span classw> /span>span classnl>team_id/span>span classp>:/span>span classw> /span>span classs2>team123/span>span classp>,/span>span classw> /span>span classnl>field_id/span>span classp>:/span>span classw> /span>span classs2>priority/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Priority/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>Custom List/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>Task priority/span>span classp>,/span>span classw> /span>span classnl>metadata/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>options/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>High/span>span classp>,/span>span classw> /span>span classs2>Medium/span>span classp>,/span>span classw> /span>span classs2>Low/span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>required/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classnl>default_value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classs2>Medium/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>frm_2/span>span classp>,/span>span classw> /span>span classnl>team_id/span>span classp>:/span>span classw> /span>span classs2>team123/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Part Attributes/span>span classp>,/span>span classw> /span>span classnl>entity_type/span>span classp>:/span>span classw> /span>span classs2>Part/span>span classp>,/span>span classw> /span>span classnl>fields/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>fld_sys_3/span>span classp>,/span>span classw> /span>span classnl>team_id/span>span classp>:/span>span classw> /span>span classs2>team123/span>span classp>,/span>span classw> /span>span classnl>field_id/span>span classp>:/span>span classw> /span>span classs2>mass/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Mass/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>Number/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>metadata/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>units/span>span classp>:/span>span classw> /span>span classs2>kg/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h1 iddictionary-api>Dictionary API/h1>p>Dictionaries are used to organize your commands, telemetry parameters, and external data types. Epsilon3’s dictionary API supports creating, updating, retrieving, or deleting dictionary definitions. Creating a dictionary with the API allows the user to link commands, telemetry, and external data to that dictionary which enables the following in Epsilon3:/p>ul>li>Limit telemetry, commanding, and external data fields to specific dictionaries during procedure edit/li>li>Switch dictionaries in procedures and retain commands that have the same name/li>li>Switch dictionaries when starting runs using a href#dictionary-group-api>dictionary groups/a>/li>/ul>h3 idcreate-a-dictionary>Create a dictionary/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/dictionaries/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>name/span>span classp>:/span> span classs>Vehicle-1/span> span classp>}/span> span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST span classse>\/span> https://api.epsilon3.io/v1/dictionaries span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ name: Vehicle-1 }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/dictionaries/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>name/span>span classerr>:/span>span classw> /span>span classs2>Vehicle-1/span>span classw> /span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Post/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>blockquote>p>Request Body (Dictionary Object)/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>dictionary_group_ids/span>span classp>:/span>span classw> /span>span classerr>array/span>span classw> /span>span classerr>(integer)/span>span classw> /span>span classerr>(optional)/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>code>POST https://api.epsilon3.io/v1/dictionaries/code>/p>p>The request body should contain a Dictionary object. The field code>name/code> is required. The code>name/code> field should be unique./p>blockquote>p>Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classsuccess>If successful, the response contains the id of the created dictionary object. If the name already exists, the request will return a 409 conflict response./aside>h3 idlist-all-available-dictionaries>List all available dictionaries/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/dictionaries/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/dictionaries span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/dictionaries/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/dictionaries/code>/p>blockquote>p>Sample Request with Query Parameters/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/dictionaries/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>params/span>span classo>/span>span classp>{/span> span classs>dictionary-group-ids/span>span classp>:/span> span classs>1,5,28/span> span classp>}/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> span classs2>https://api.epsilon3.io/v1/dictionaries?dictionary-group-ids1,5,28/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/dictionaries?dictionary-group-ids1,5,28/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/dictionaries?dictionary-group-ids{dictionary-group-ids}/code>/p>p>The optional URL parameter code>dictionary-group-ids/code> may be provided to filter dictionaries by dictionary groups. The value should be a comma-separated list of dictionary group IDs. The response will only contain dictionaries that are members of at least one of the specified dictionary groups./p>blockquote>p>Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>timestamp/span>span classw> /span>span classerr>in/span>span classw> /span>span classerr>ISO/span>span classmi>-8601/span>span classw> /span>span classerr>format/span>span classp>,/span>span classw> /span>span classs2>groups: { /span>span classerr>id/span>span classs2>: integer, /span>span classerr>name/span>span classs2>: string, /span>span classerr>created_at/span>span classs2>: string, timestamp in ISO-8601 format }}/span>/code>/pre>/div>aside classsuccess>If successful, the response contains a list of dictionary objects with a “created_at” field./aside>h3 idupdate-a-dictionary>Update a dictionary/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>patch/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/dictionaries/2/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>dictionary_group_ids/span>span classp>:/span> span classp>/span>span classmi>1/span>span classp>,/span> span classmi>2/span>span classp>,/span> span classmi>3/span>span classp>/span> span classp>}/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> PATCH span classse>\/span> https://api.epsilon3.io/v1/dictionaries/2 span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ dictionary_group_ids: 1, 2, 3 }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/dictionaries/2/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>dictionary_group_ids/span>span classerr>:/span>span classw> /span>span classp>@(/span>span classmi>1/span>span classp>,/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw> /span>span classmi>3/span>span classp>)/span>span classw> /span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Patch/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>blockquote>p>Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>dictionary_group_ids/span>span classp>:/span>span classw> /span>span classerr>array/span>span classw> /span>span classerr>(integer)/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>code>PATCH https://api.epsilon3.io/v1/dictionaries/:dictionaryId/code>/p>p>The request body should contain a list of dictionary group ids./p>aside classsuccess>If successful, the response contains the updated dictionary object./aside>h3 iddelete-dictionaries>Delete dictionaries/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>delete/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/dictionaries/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>ids/span>span classp>:/span> span classp>/span>span classmi>1/span>span classp>,/span> span classmi>2/span>span classp>,/span> span classmi>3/span>span classp>/span> span classp>}/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> DELETE span classse>\/span> https://api.epsilon3.io/v1/dictionaries span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ ids: 1, 2, 3 }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/dictionaries/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>ids/span>span classerr>:/span>span classw> /span>span classp>@(/span>span classmi>1/span>span classp>,/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw> /span>span classmi>3/span>span classp>)/span>span classw> /span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Delete/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>p>DELETE code>https://api.epsilon3.io/v1/dictionaries/code>/p>aside classwarning>Attempting to delete a dictionary that is used by existing telemetry, commands or external data will return a 409 conflict response./aside>blockquote>p>Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ids/span>span classp>:/span>span classw> /span>span classerr>array/span>span classw> /span>span classerr>(integer)/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ids/span>span classp>:/span>span classw> /span>span classp>/span>span classmi>2/span>span classp>,/span>span classw> /span>span classmi>3/span>span classp>,/span>span classw> /span>span classmi>10/span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classnotice>All workspaces come with a default dictionary. This cannot be edited or deleted./aside>p>aside classsuccess>If successful, the response body is empty./aside>`/p>h1 iddictionary-group-api>Dictionary Group API/h1>p>Dictionary groups are used to group dictionaries and their associated commands and telemetry parameters. Epsilon3’s dictionary groups API supports creating, retrieving, or deleting dictionary groups. Creating a dictionary group with the API allows the user to link dictionaries to that group which enables the following in Epsilon3:/p>ul>li>Limit telemetry and commanding to specific dictionary groups during procedure edit/li>li>Set the dictionary of commands and telemetry parameters when starting runs/li>/ul>p>Dictionary groups are useful for cases where multiple dictionaries have telemetry parameters or commands with the same name. The dictionary group will contain the telemetry parameters and commands whose names are present in all dictionaries in the group./p>aside classnotice>Dictionary groups do not apply to external data, only telemetry and commands./aside>h3 idcreate-a-dictionary-group>Create a dictionary group/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/dictionary-groups/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>name/span>span classp>:/span> span classs>Vehicles/span> span classp>}/span> span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST span classse>\/span> https://api.epsilon3.io/v1/dictionary-groups span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ name: Vehicles }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/dictionary-groups/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>name/span>span classerr>:/span>span classw> /span>span classs2>Vehicles/span>span classw> /span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Post/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>blockquote>p>Request Body (Dictionary Group Object)/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>code>POST https://api.epsilon3.io/v1/dictionary-groups/code>/p>p>The request body should contain a Dictionary Group object. The field code>name/code> is required. The code>name/code> field should be unique./p>blockquote>p>Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classsuccess>If successful, the response contains the id of the created dictionary group object. If the name already exists, a 409 conflict response is returned./aside>h3 idlist-all-available-dictionary-groups>List all available dictionary groups/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/dictionary-groups/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/dictionary-groups span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/dictionary-groups/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/dictionary-groups/code>/p>blockquote>p>Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>timestamp/span>span classw> /span>span classerr>in/span>span classw> /span>span classerr>ISO/span>span classmi>-8601/span>span classw> /span>span classerr>format/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classsuccess>If successful, the response contains a list of dictionary group objects with a “created_at” field./aside>h3 iddelete-dictionary-groups>Delete dictionary groups/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>delete/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/dictionary-groups/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>ids/span>span classp>:/span> span classp>/span>span classmi>1/span>span classp>,/span> span classmi>2/span>span classp>,/span> span classmi>3/span>span classp>/span> span classp>}/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> DELETE span classse>\/span> https://api.epsilon3.io/v1/dictionary-groups span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ ids: 1, 2, 3 }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/dictionary-groups/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>ids/span>span classerr>:/span>span classw> /span>span classp>@(/span>span classmi>1/span>span classp>,/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw> /span>span classmi>3/span>span classp>)/span>span classw> /span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Delete/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>p>DELETE code>https://api.epsilon3.io/v1/dictionary-groups/code>/p>aside classwarning>Attempting to delete a dictionary group that is used by existing dictionaries will return a 409 conflict response./aside>blockquote>p>Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ids/span>span classp>:/span>span classw> /span>span classerr>array/span>span classw> /span>span classerr>(integer)/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ids/span>span classp>:/span>span classw> /span>span classp>/span>span classmi>2/span>span classp>,/span>span classw> /span>span classmi>3/span>span classp>,/span>span classw> /span>span classmi>10/span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>aside classsuccess>If successful, the response body is empty./aside>`/p>h1 idevents-api>Events API/h1>p>Events are used in schedules to plan operations and milestones. Epsilon3's events API currently supports the following capabilities./p>h2 idget-events>Get Events/h2>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/planning/events/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>params/span>span classo>/span>span classp>{/span> span classs>start/span>span classp>:/span> span classs>2023-07-26T00:00:00.000Z/span>span classp>,/span> span classs>end/span>span classp>:/span> span classs>2023-08-09T00:00:00.000Z/span>span classp>,/span> span classs>eventType/span>span classp>:/span> span classs>unscheduled/span>span classp>,/span> span classs>exclude_recurrences/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classp>}/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> span classs2>https://api.epsilon3.io/v1/planning/events?start2023-07-26T00:00:00.000Z&end2023-08-09T00:00:00.000Z&eventTypeunscheduled&exclude_recurrencestrue/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/planning/events?start2023-07-26T00:00:00.000Z&end2023-08-09T00:00:00.000Z&eventTypeunscheduled&exclude_recurrencestrue/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>/api/v1/planning/events/code>/p>p>Retrieves events under/p>p>strong>Query Parameters/strong>/p>ul>li>start (required unless exclude_recurrences or eventType is 'unscheduled'): The start of the time range to fetch events from. Should be in ISO string format./li>li>end (required unless exclude_recurrences or eventType is 'unscheduled'): The end of the time range to fetch events from. Should be in ISO string format./li>li>eventType (optional): To get 'unscheduled' events, pass this as a query parameter. If provided with 'unscheduled', start and end parameters become optional./li>li>exclude_recurrences (optional): To get only non-recurring events, pass this as a query parameter with value true. If provided, start and end parameters become optional./li>/ul>blockquote>p>Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>GET /api/v1/planning/events?start2023-07-26T00:00:00.000Z&end2023-08-09T00:00:00.000Z/code>/pre>/div>blockquote>p>Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>events/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>DVEYVZ2qp8sk2KgvA6zOkn/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Galactic Innovators Summit/span>span classp>,/span>span classw> /span>span classnl>start/span>span classp>:/span>span classw> /span>span classs2>2023-08-30T13:00:00.000Z/span>span classp>,/span>span classw> /span>span classnl>end/span>span classp>:/span>span classw> /span>span classs2>2023-08-30T18:00:00.000Z/span>span classp>,/span>span classw> /span>span classnl>procedure_id/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>procedure_section_id/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>run_id/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>swimlane_id/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>duration/span>span classp>:/span>span classw> /span>span classs2>PT5H/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>DphgSy369ewI3QbzIzhjz6/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Space Exploration Workshop/span>span classp>,/span>span classw> /span>span classnl>start/span>span classp>:/span>span classw> /span>span classs2>2023-08-30T10:30:00.000Z/span>span classp>,/span>span classw> /span>span classnl>end/span>span classp>:/span>span classw> /span>span classs2>2023-08-30T12:30:00.000Z/span>span classp>,/span>span classw> /span>span classnl>procedure_id/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>procedure_section_id/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>run_id/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>swimlane_id/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>duration/span>span classp>:/span>span classw> /span>span classs2>PT2H/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idget-event>Get Event/h2>p>GET code>/api/v1/planning/events/:eventId/code>/p>p>Retrieves a specific event./p>p>strong>Parameters/strong>/p>ul>li>code>eventId/code> (path parameter): Id of the event./li>/ul>blockquote>p>Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>GET /api/v1/planning/events/test_event_id/code>/pre>/div>blockquote>p>Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>QuACGmyZHp7qMMOUM64SRg/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Space Colony Simulation Test/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>Test Description/span>span classp>,/span>span classw> /span>span classnl>start/span>span classp>:/span>span classw> /span>span classs2>2023-07-30T09:00:00.000Z/span>span classp>,/span>span classw> /span>span classnl>end/span>span classp>:/span>span classw> /span>span classs2>2023-07-30T17:00:00.000Z/span>span classp>,/span>span classw> /span>span classnl>duration/span>span classp>:/span>span classw> /span>span classs2>PT8H/span>span classp>,/span>span classw> /span>span classnl>procedure_id/span>span classp>:/span>span classw> /span>span classs2>45KqIG4QZV1S5oOYZaxE9y/span>span classp>,/span>span classw> /span>span classnl>procedure_section_id/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>run_id/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>swimlane_id/span>span classp>:/span>span classw> /span>span classs2>DpSTO81RP9fZSUd8d8ffY4/span>span classp>,/span>span classw> /span>span classnl>rrule/span>span classp>:/span>span classw> /span>span classs2>RRULE:FREQDAILY;INTERVAL3/span>span classp>,/span>span classw> /span>span classnl>recurrence_id/span>span classp>:/span>span classw> /span>span classs2>ChEIi3cXJVXCidYlVgMqTl/span>span classp>,/span>span classw> /span>span classnl>recurrence_date/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>Here are some notes with:/span>span classse>\n/span>span classs2>- **Markdown components**/span>span classp>,/span>span classw> /span>span classnl>dependencies/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>in/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>DhawCJ3URB7sNd8rRZ8r3H/span>span classp>,/span>span classw> /span>span classnl>source/span>span classp>:/span>span classw> /span>span classs2>1RXszDst3d16WeXn1GiNLB/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>out/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>jX88nSfgTK22KL7DZyUJjc/span>span classp>,/span>span classw> /span>span classnl>target/span>span classp>:/span>span classw> /span>span classs2>3rfiluxsbzKwGbJOW8VIAZ/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>predecessor_id/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>If the event doesn't exist, it will respond with a 404 status code./p>h2 idupdate-event>Update Event/h2>blockquote>p>Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>PATCH /api/v1/planning/events/test_event_id/code>/pre>/div>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>3rfiluxsbzKwGbJOW8VIAZ/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Test Event/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>Test Description/span>span classp>,/span>span classw> /span>span classnl>start/span>span classp>:/span>span classw> /span>span classs2>2023-07-26T17:00:00Z/span>span classp>,/span>span classw> /span>span classnl>duration/span>span classp>:/span>span classw> /span>span classs2>PT6H4S/span>span classp>,/span>span classw> /span>span classnl>dependencies/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>in/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>source/span>span classp>:/span>span classw> /span>span classs2>QuACGmyZHp7qMMOUM64SRg/span>span classp>,/span>span classw> /span>span classnl>target/span>span classp>:/span>span classw> /span>span classs2>3rfiluxsbzKwGbJOW8VIAZ/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>out/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>PATCH code>/api/v1/planning/events/:eventId/code>/p>p>Updates a specific event./p>p>strong>Parameters/strong>/p>ul>li>code>eventId/code> (path parameter): Id of the event./li>/ul>p>strong>Request Body/strong>/p>p>The request body should be a JSON object that contains the details of the event to be updated. The following fields are supported:/p>ul>li>code>name/code>: (required) Event name, must be a string./li>li>code>start/code>: (optional) Start time of the event, must be an ISO datetime string./li>li>code>duration/code>: (optional) Duration of event, must be in ISO 8601 duration string. This is used to calculate event's end date./li>li>code>procedure_id/code>: (optional) Procedure id./li>li>code>procedure_section_id/code>: (optional) Procedure section id./li>li>code>run_id/code>: (optional) Run id./li>li>code>swimlane_id/code>: (optional) Swimlane id./li>li>code>dependencies/code>: (optional) Dependencies of the event, must be an object.ul>li>code>dependencies.in/code>: (optional) Incoming dependencies, must be an array./li>li>code>dependencies.out/code>: (optional) Outgoing dependencies, must be an array./li>/ul>/li>li>code>rrule/code>: (optional) Recurrence rule./li>li>code>recurrence_id/code>: (optional) Recurrence id./li>li>code>description/code>: (optional) Event description./li>li>code>notes/code>: (optional) Event notes./li>li>code>status/code>: (optional) Event status can be one of these following values: 'completed' | 'running' | 'paused' | 'success' | 'abort' | 'failure' | 'planning' | 'ended';/li>li>code>milestone/code>: (optional)/li>/ul>p>strong>Response/strong>The response status code will be 200 and return a copy of the updated event./p>h2 idcreate-event>Create Event/h2>p>POST code>/api/v1/planning/events/code>/p>blockquote>p>Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>POST /api/v1/events/code>/pre>/div>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Test Event/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>Description goes here/span>span classp>,/span>span classw> /span>span classnl>start/span>span classp>:/span>span classw> /span>span classs2>2023-08-08T00:00:00.000Z/span>span classp>,/span>span classw> /span>span classnl>duration/span>span classp>:/span>span classw> /span>span classs2>PT6H4S/span>span classp>,/span>span classw> /span>span classnl>procedure_id/span>span classp>:/span>span classw> /span>span classs2>45KqIG4QZV1S5oOYZaxE9y/span>span classp>,/span>span classw> /span>span classnl>procedure_section_id/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>dependencies/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>in/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>source/span>span classp>:/span>span classw> /span>span classs2>6NSi9FIBDN1xrWEV4Q8HQR/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>out/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>swimlane_id/span>span classp>:/span>span classw> /span>span classs2>DpSTO81RP9fZSUd8d8ffY4/span>span classp>,/span>span classw> /span>span classnl>rrule/span>span classp>:/span>span classw> /span>span classs2>RRULE:FREQDAILY;INTERVAL1/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>Here are some notes with **markdown**/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>Creates a new event./p>p>strong>Parameters/strong>/p>p>No path parameters are required for this endpoint./p>p>strong>Request Body/strong>/p>p>The request body should be a JSON object that contains the details of the event to be created. The following fields are supported:/p>ul>li>code>name/code>: (required) Event name, must be a string./li>li>code>start/code>: (optional) Start time of the event, must be an ISO datetime string./li>li>code>duration/code>: (optional) Duration of event, must be in ISO 8601 duration string. This is used to calculate event's end date./li>li>code>procedure_id/code>: (optional) Procedure id./li>li>code>procedure_section_id/code>: (optional) Procedure section id./li>li>code>swimlane_id/code>: (optional) Swimlane id./li>li>code>dependencies/code>: (optional) Dependencies of the event, must be an object.ul>li>code>dependencies.in/code>: (optional) Incoming dependencies, must be an array./li>li>code>dependencies.out/code>: (optional) Outgoing dependencies, must be an array./li>/ul>/li>li>code>rrule/code>: (optional) Recurrence rule./li>li>code>description/code>: (optional) Event description./li>li>code>notes/code>: (optional) Event notes./li>li>code>status/code>: (optional) Event status can be one of these following values: 'completed' | 'running' | 'paused' | 'success' | 'abort' | 'failure' | 'planning' | 'ended';/li>li>code>milestone/code>: (optional)/li>/ul>p>strong>Response/strong>/p>p>The response status code will be 201 and return a JSON object containing the ID of the newly created event./p>h2 iddelete-event>Delete Event/h2>p>DELETE code>/api/v1/planning/events/:eventId/code>/p>blockquote>p>Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>DELETE /api/v1/planning/events/test_event_id/code>/pre>/div>p>Deletes an event./p>p>strong>Parameters/strong>/p>ul>li>code>eventId/code> (path parameter): Id of the event./li>/ul>p>strong>Response/strong>/p>p>The response status code will be 204 for a successful response./p>h1 idexternal-data-api>External Data API/h1>p>Epsilon3’s external data API supports the following capabilities:/p>ul>li>Create an external data type that can be selected from a dropdown in procedures/li>li>Connect an external data service that can be queried in procedures/li>/ul>h3 idcreate-or-update-an-external-data-item-type>Create or update an external data item type/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/external-data/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>type/span>span classp>:/span> span classs>x-axis/span>span classp>,/span> span classs>label/span>span classp>:/span> span classs>X Axis/span>span classp>,/span> span classs>dictionary_id/span>span classp>:/span> span classmi>1/span> span classp>}/span> span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST span classse>\/span> https://api.epsilon3.io/v1/external-data span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ type: x-axis, label: X Axis, dictionary_id: 1 }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/external-data/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>type/span>span classerr>:/span>span classw> /span>span classs2>x-axis/span>span classp>,/span>span classw> /span>span classs2>label/span>span classerr>:/span>span classw> /span>span classs2>X Axis/span>span classp>,/span>span classw> /span>span classs2>dictionary_id/span>span classerr>:/span>span classw> /span>span classmi>1/span>span classw> /span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Post/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>blockquote>p>Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>label/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>dictionary_id/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classw> /span>span classerr>(optional)/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>POST code>https://api.epsilon3.io/v1/external-data/code>/p>p>The request body should contain an External Data Item object with the following required fields: code>type/code> & code>label/code>. The optional code>dictionary_id/code> field allows the External Data Item to be related to a dictionary. If no code>dictionary_id/code> is provided, the external data item will be related to the default dictionary./p>aside classnotice>code>type/code> is the unique identifier for the external data object. The use of `key` is deprecated and will be removed soon./aside>aside classsuccess>If successful, the response body contains the created or updated External Data Item object./aside>h3 idlist-all-external-data-items>List all external data items/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/external-data/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/external-data span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/external-data/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/external-data/code>/p>blockquote>p>Example Response/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>work_order/span>span classp>,/span>span classw> /span>span classnl>label/span>span classp>:/span>span classw> /span>span classs2>Work Order/span>span classp>,/span>span classw> /span>span classnl>dictionary_id/span>span classp>:/span>span classw> /span>span classmi>1/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>part_number/span>span classp>,/span>span classw> /span>span classnl>label/span>span classp>:/span>span classw> /span>span classs2>Part Number/span>span classp>,/span>span classw> /span>span classnl>dictionary_id/span>span classp>:/span>span classw> /span>span classmi>1/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>support_ticket/span>span classp>,/span>span classw> /span>span classnl>label/span>span classp>:/span>span classw> /span>span classs2>Support Ticket/span>span classp>,/span>span classw> /span>span classnl>dictionary_id/span>span classp>:/span>span classw> /span>span classmi>1/span>span classw> /span>span classp>}/span>span classw>/span>span classp>/span>span classw>/span>/code>/pre>/div>aside classwarning>The request body must be empty./aside>aside classsuccess>If successful, the response body contains a list of External Data Item objects./aside>h3 iddelete-external-data>Delete external data/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>delete/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/external-data/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>ids/span>span classp>:/span> span classp>/span>span classmi>1/span>span classp>,/span> span classmi>2/span>span classp>,/span> span classmi>3/span>span classp>/span> span classp>}/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> DELETE span classse>\/span> https://api.epsilon3.io/v1/external-data span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ ids: 1, 2, 3 }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/external-data/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>ids/span>span classerr>:/span>span classw> /span>span classp>@(/span>span classmi>1/span>span classp>,/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw> /span>span classmi>3/span>span classp>)/span>span classw> /span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Delete/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>p>DELETE `code>https://api.epsilon3.io/v1/external-data/code>/p>blockquote>p>Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ids/span>span classp>:/span>span classw> /span>span classerr>array/span>span classw> /span>span classerr>(integer)/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ids/span>span classp>:/span>span classw> /span>span classp>/span>span classmi>123/span>span classp>,/span>span classw> /span>span classmi>456/span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classsuccess>If successful, the response body is empty with 204 status code./aside>h1 idfiles-api>Files API/h1>p>Support retrieving Files./p>h2 idretrieve-a-file>Retrieve a file/h2>p>This endpoint retrieves a single file./p>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>mimetypes/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/files/sample-file-id/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>stream/span>span classo>/span>span classbp>True/span>span classp>,/span>span classp>)/span>span classn>content_type/span> span classo>/span> span classn>response/span>span classp>./span>span classn>headers/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>Content-Type/span>span classp>,/span> span classs>/span>span classp>)/span>span classn>extension/span> span classo>/span> span classn>mimetypes/span>span classp>./span>span classn>guess_extension/span>span classp>(/span>span classn>content_type/span>span classp>./span>span classn>split/span>span classp>(/span>span classs>;/span>span classp>)/span>span classmi>0/span>span classp>./span>span classn>strip/span>span classp>())/span>span classk>with/span> span classnb>open/span>span classp>(/span>span classs>image_name_here/span> span classo>+/span> span classn>extension/span>span classp>,/span> span classs>wb/span>span classp>)/span> span classk>as/span> span classnb>file/span>span classp>:/span> span classk>for/span> span classn>chunk/span> span classow>in/span> span classn>response/span>span classp>./span>span classn>iter_content/span>span classp>(/span>span classn>chunk_size/span>span classo>/span>span classmi>8192/span>span classp>):/span> span classnb>file/span>span classp>./span>span classn>write/span>span classp>(/span>span classn>chunk/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>span classc># Capture headers into a variable/span>span classnv>headers/span>span classo>/span>span classsi>$(/span>curl span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>:/span> span classnt>-D/span> - span classs2>https://api.epsilon3.io/v1/files/sample-file-id/span> span classnt>-o/span> temp_filespan classsi>)/span>span classc># Extract Content-Type/span>span classnv>content_type/span>span classo>/span>span classsi>$(/span>span classnb>echo/span> span classs2>/span>span classnv>$headers/span>span classs2>/span> | span classnb>grep/span> span classnt>-i/span> span classs1>^Content-Type:/span> | span classnb>cut/span> span classnt>-d/span>span classs1> /span> span classnt>-f2/span> | span classnb>tr/span> span classnt>-d/span> span classs1>\r\n/span>span classsi>)/span>span classc># Determine extension/span>span classk>case/span> span classs2>/span>span classnv>$content_type/span>span classs2>/span> span classk>in /span>image/pngspan classp>)/span> span classnv>ext/span>span classo>/span>span classs2>.png/span> span classp>;;/span> image/jpegspan classp>)/span> span classnv>ext/span>span classo>/span>span classs2>.jpg/span> span classp>;;/span> image/gifspan classp>)/span> span classnv>ext/span>span classo>/span>span classs2>.gif/span> span classp>;;/span> application/pdfspan classp>)/span> span classnv>ext/span>span classo>/span>span classs2>.pdf/span> span classp>;;/span> span classk>*/span>span classp>)/span> span classnv>ext/span>span classo>/span>span classs2>.bin/span> span classp>;;/span>span classk>esac/span>span classc># Rename the file to add extension/span>span classnb>mv /span>temp_file span classs2>your_downloaded_file_name/span>span classnv>$ext/span>span classs2>/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/files/sample-file-id/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classc># Set up basic auth/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classnx>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classw> /span>span classerr>+/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>/span>span classerr>::/span>span classnx>ToBase64String/span>span classerr>(/span>span classp>/span>span classn>Text.Encoding/span>span classp>/span>span classerr>::/span>span classnx>ASCII/span>span classerr>./span>span classnx>GetBytes/span>span classerr>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classerr>))/span>span classw>/span>span classp>}/span>span classw>/span>span classc># Download file and capture headers/span>span classw>/span>span classnv>$response/span>span classw> /span>span classo>/span>span classw> /span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$Url/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-OutFile/span>span classw> /span>span classs2>temp_file/span>span classw> /span>span classnt>-PassThru/span>span classw>/span>span classc># Parse content-type/span>span classw>/span>span classnv>$contentType/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$response/span>span classo>./span>span classn>Headers/span>span classp>/span>span classs2>Content-Type/span>span classp>/span>span classo>./span>span classnf>Split/span>span classp>(/span>span classs2>;/span>span classp>)/span>span classmi>0/span>span classp>/span>span classo>./span>span classnf>Trim/span>span classp>()/span>span classw>/span>span classc># Determine extension/span>span classw>/span>span classkr>switch/span>span classw> /span>span classp>(/span>span classnv>$contentType/span>span classp>)/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>image/png/span>span classw> /span>span classp>{/span>span classw> /span>span classnv>$ext/span>span classw> /span>span classo>/span>span classw> /span>span classs2>.png/span>span classw> /span>span classp>}/span>span classw> /span>span classs2>image/jpeg/span>span classw> /span>span classp>{/span>span classw> /span>span classnv>$ext/span>span classw> /span>span classo>/span>span classw> /span>span classs2>.jpg/span>span classw> /span>span classp>}/span>span classw> /span>span classs2>image/gif/span>span classw> /span>span classp>{/span>span classw> /span>span classnv>$ext/span>span classw> /span>span classo>/span>span classw> /span>span classs2>.gif/span>span classw> /span>span classp>}/span>span classw> /span>span classs2>application/pdf/span>span classw> /span>span classp>{/span>span classw> /span>span classnv>$ext/span>span classw> /span>span classo>/span>span classw> /span>span classs2>.pdf/span>span classw> /span>span classp>}/span>span classw> /span>span classn>default/span>span classw> /span>span classp>{/span>span classw> /span>span classnv>$ext/span>span classw> /span>span classo>/span>span classw> /span>span classs2>.bin/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>span classc># Rename to add extension/span>span classw>/span>span classn>Rename-Item/span>span classw> /span>span classnt>-Path/span>span classw> /span>span classs2>temp_file/span>span classw> /span>span classnt>-NewName/span>span classw> /span>span classp>(/span>span classs2>your_downloaded_file_name/span>span classw> /span>span classo>+/span>span classw> /span>span classnv>$ext/span>span classp>)/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/files/sample-file-id/code>/p>h1 idissues-api>Issues API/h1>p>Support managing Issues though their entire lifecycle./p>h2 idcreate-an-issue>Create an issue/h2>p>This endpoint creates a new issue./p>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/issues/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>title/span>span classp>:/span> span classs>Sample title/span>span classp>,/span> span classs>notes/span>span classp>:/span> span classs>Some notes/span>span classp>,/span> span classs>run_id/span>span classp>:/span> span classs>up9goX1AgzCuffxUXbpI1K/span>span classp>,/span> span classs>severity_id/span>span classp>:/span> span classs>123/span>span classp>,/span> span classs>status_id/span>span classp>:/span> span classs>123/span>span classp>,/span> span classs>assignee/span>span classp>:/span> span classs>test@epsilon3.io/span>span classp>,/span> span classs>project_id/span>span classp>:/span> span classs>h78svHgfi4/span>span classp>,/span> span classs>reference_id/span>span classp>:/span> span classs>bIkugfdu94hG42jWkfbh2/span>span classp>,/span> span classs>reference_type/span>span classp>:/span> span classs>run/span>span classp>,/span> span classs>details/span>span classp>:/span> span classp>{/span> span classs>id/span>span classp>:/span> span classs>10/span>span classp>,/span> span classs>value/span>span classp>:/span> span classp>{/span> span classs>recorded/span>span classp>:/span> span classs>Sample value/span>span classp>}/span> span classp>}/span> span classp>}/span> span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST span classse>\/span> https://api.epsilon3.io/v1/issues span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ title: Sample title, notes: Some notes, run_id: up9goX1AgzCuffxUXbpI1K, severity_id: 123, status_id: 123, assignee: test@epsilon3.io, project_id: h78svHgfi4, reference_id: bIkugfdu94hG42jWkfbh2, reference_type: run, details: { id: 10, value: { recorded: Sample value} } }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/issues/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>title/span>span classerr>:/span>span classw> /span>span classs2>Sample title/span>span classp>,/span>span classw> /span>span classs2>notes/span>span classerr>:/span>span classw> /span>span classs2>Some notes/span>span classp>,/span>span classw> /span>span classs2>run_id/span>span classerr>:/span>span classw> /span>span classs2>up9goX1AgzCuffxUXbpI1K/span>span classp>,/span>span classw> /span>span classs2>severity_id/span>span classerr>:/span>span classw> /span>span classs2>123/span>span classp>,/span>span classw> /span>span classs2>status_id/span>span classerr>:/span>span classw> /span>span classs2>123/span>span classp>,/span>span classw> /span>span classs2>assignee/span>span classerr>:/span>span classw> /span>span classs2>test@epsilon3.io/span>span classp>,/span>span classw> /span>span classs2>project_id/span>span classerr>:/span>span classw> /span>span classs2>h78svHgfi4/span>span classp>,/span>span classw> /span>span classs2>reference_id/span>span classerr>:/span>span classw> /span>span classs2>bIkugfdu94hG42jWkfbh2/span>span classp>,/span>span classw> /span>span classs2>reference_type/span>span classerr>:/span>span classw> /span>span classs2>run/span>span classp>,/span>span classw> /span>span classs2>details/span>span classerr>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>10/span>span classp>,/span>span classw> /span>span classs2>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>recorded/span>span classp>:/span>span classw> /span>span classs2>Sample value/span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Post/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>blockquote>p>Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>title/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>run_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>severity_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>status_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>assignee/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>project_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw> /span>span classerr>|/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>reference_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>reference_type/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>details/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>POST code>https://api.epsilon3.io/v1/issues/code>/p>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>123/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classsuccess>If successful, the response code will be 200/aside>h2 idupdate-an-issue>Update an issue/h2>p>This endpoint updates an issue./p>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>patch/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/issues/123/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>title/span>span classp>:/span> span classs>Sample title/span>span classp>,/span> span classs>notes/span>span classp>:/span> span classs>Some notes/span>span classp>,/span> span classs>run_id/span>span classp>:/span> span classs>up9goX1AgzCuffxUXbpI1K/span>span classp>,/span> span classs>severity_id/span>span classp>:/span> span classs>123/span>span classp>,/span> span classs>status_id/span>span classp>:/span> span classs>123/span>span classp>,/span> span classs>assignee/span>span classp>:/span> span classs>test@epsilon3.io/span>span classp>,/span> span classs>project_id/span>span classp>:/span> span classs>h78svHgfi4/span>span classp>,/span> span classs>reference_id/span>span classp>:/span> span classs>bIkugfdu94hG42jWkfbh2/span>span classp>,/span> span classs>reference_type/span>span classp>:/span> span classs>run/span>span classp>,/span> span classs>details/span>span classp>:/span> span classp>{/span> span classs>id/span>span classp>:/span> span classs>10/span>span classp>,/span> span classs>value/span>span classp>:/span> span classp>{/span> span classs>recorded/span>span classp>:/span> span classs>Sample value/span>span classp>}/span> span classp>}/span> span classp>}/span> span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> PATCH span classse>\/span> https://api.epsilon3.io/v1/issues/123 span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ title: Sample title, notes: Some notes, run_id: up9goX1AgzCuffxUXbpI1K, severity_id: 123, status_id: 123, assignee: test@epsilon3.io, project_id: h78svHgfi4, reference_id: bIkugfdu94hG42jWkfbh2, reference_type: run, details: { id: 10, value: { recorded: Sample value} } }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/issues/123/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>title/span>span classerr>:/span>span classw> /span>span classs2>Sample title/span>span classp>,/span>span classw> /span>span classs2>notes/span>span classerr>:/span>span classw> /span>span classs2>Some notes/span>span classp>,/span>span classw> /span>span classs2>run_id/span>span classerr>:/span>span classw> /span>span classs2>up9goX1AgzCuffxUXbpI1K/span>span classp>,/span>span classw> /span>span classs2>severity_id/span>span classerr>:/span>span classw> /span>span classs2>123/span>span classp>,/span>span classw> /span>span classs2>status_id/span>span classerr>:/span>span classw> /span>span classs2>123/span>span classp>,/span>span classw> /span>span classs2>assignee/span>span classerr>:/span>span classw> /span>span classs2>test@epsilon3.io/span>span classp>,/span>span classw> /span>span classs2>project_id/span>span classerr>:/span>span classw> /span>span classs2>h78svHgfi4/span>span classp>,/span>span classw> /span>span classs2>reference_id/span>span classerr>:/span>span classw> /span>span classs2>bIkugfdu94hG42jWkfbh2/span>span classp>,/span>span classw> /span>span classs2>reference_type/span>span classerr>:/span>span classw> /span>span classs2>run/span>span classp>,/span>span classw> /span>span classs2>details/span>span classerr>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>10/span>span classp>,/span>span classw> /span>span classs2>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>recorded/span>span classp>:/span>span classw> /span>span classs2>Sample value/span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Patch/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>blockquote>p>Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>title/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>run_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>severity_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>status_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>assignee/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>project_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw> /span>span classerr>|/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classnl>details/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>recorded/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classerr>steps:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>signoffs/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>operators/span>span classp>:/span>span classw> /span>span classerr>Array<string>/span>span classp>,/span>span classw> /span>span classp>}/span>span classw> /span>span classnl>content/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classerr>alert/span>span classp>,/span>span classw> /span>span classnl>subtype/span>span classp>:/span>span classw> /span>span classerr>note/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>caution/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>warning/span>span classp>,/span>span classw> /span>span classnl>text/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classp>}/span>span classw> /span>span classerr>|/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classerr>procedure_link/span>span classp>,/span>span classw> /span>span classnl>procedure/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>section/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>run/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classerr>;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>PATCH code>https://api.epsilon3.io/v1/issues/123/code>/p>aside classsuccess>If successful, the response code will be 200/aside>h2 idretrieve-single-issue>Retrieve single issue/h2>p>This endpoint allows you to retrieve a single issue with all of its associated data./p>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/issues/123/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> span classs2>https://api.epsilon3.io/v1/issues/123/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/issues/123/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/issues/:issue-id/code>/p>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classerr>title:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>notes?:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>created_by:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>run_id?:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>reference_id:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>reference_type:/span>span classw> /span>span classerr>step/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>run/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>item/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>part/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>order/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>unlinked/span>span classp>,/span>span classw> /span>span classerr>severity:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>color/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>pausesRun/span>span classp>:/span>span classw> /span>span classerr>boolean/span>span classp>,/span>span classw> /span>span classp>}/span>span classerr>;/span>span classw> /span>span classerr>status:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classerr>draft/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>active/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>closed/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>color/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classp>}/span>span classerr>;/span>span classw> /span>span classerr>sub_status:/span>span classw> /span>span classkc>null/span>span classw> /span>span classerr>|/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>status_id/span>span classp>:/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>label/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>color/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>attachments?:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>attachment_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>content_type/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>assignees?:/span>span classw> /span>span classerr>Array<string>/span>span classp>,/span>span classw> /span>span classerr>activity?:/span>span classw> /span>span classerr>Array<Activity/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>RunActions>/span>span classp>,/span>span classw> /span>span classerr>details?:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classp>{/span>span classw> /span>span classerr>recorded:/span>span classw> /span>span classerr>string/span>span classw> /span>span classerr>|/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>}/span>span classerr>;/span>span classw> /span>span classerr>steps:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>signoffs/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>operators/span>span classp>:/span>span classw> /span>span classerr>Array<string>/span>span classp>,/span>span classw> /span>span classp>}/span>span classw> /span>span classnl>content/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classerr>alert/span>span classp>,/span>span classw> /span>span classnl>subtype/span>span classp>:/span>span classw> /span>span classerr>note/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>caution/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>warning/span>span classp>,/span>span classw> /span>span classnl>text/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classp>}/span>span classw> /span>span classerr>|/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classerr>procedure_link/span>span classp>,/span>span classw> /span>span classnl>procedure/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>section/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>run/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classerr>;/span>span classw> /span>span classerr>project_id?:/span>span classw> /span>span classerr>string;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classsuccess>If successful, the response code will be 200/aside>h2 idretrieve-list-of-issues>Retrieve list of issues/h2>p>This endpoint allows you to retrieve all available issues with basic information./p>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/issues?status_typesdraft&status_typesactive/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> span classs2>https://api.epsilon3.io/v1/issues?status_typesdraft&status_typesactive/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/issues?status_typesdraft&status_typesactive/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/issues/code>/p>table>thead>tr>th>Query parameter/th>th>Value/th>/tr>/thead>tbody>tr>td>run_id/td>td>String/td>/tr>tr>td>status_types/td>td>Array - draft | active | closed/td>/tr>tr>td>reference_id/td>td>string/td>/tr>tr>td>reference_type/td>td>string/td>/tr>/tbody>/table>p>Query parameter example usagecode>GET https://api.epsilon3.io/v1/issues?status_typesdraft&status_typesactive&run_idsampleRunId/code>/p>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classerr>id:/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classerr>title:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>status:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classerr>draft/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>active/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>closed/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>color/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classp>}/span>span classerr>;/span>span classw> /span>span classerr>subStatus:/span>span classw> /span>span classkc>null/span>span classw> /span>span classerr>|/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>status_id/span>span classp>:/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>label/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>color/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>created_at:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>created_by:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>run_id:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>reference_id:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>reference_type:/span>span classw> /span>span classerr>step/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>run/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>item/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>part/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>order/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>unlinked/span>span classp>,/span>span classw> /span>span classerr>assignees:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>severity?:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>color/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>pausesRun/span>span classp>:/span>span classw> /span>span classerr>boolean/span>span classp>,/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>projectId?:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classsuccess>If successful, the response code will be 200/aside>h2 idretrieve-issues-metadata-options>Retrieve issues metadata options/h2>p>This endpoint allows you to retrieve all options that you can set as values on an issue. These options are not customizable at this time./p>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/issues/metadata-options/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> span classs2>https://api.epsilon3.io/v1/issues/metadata-options/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/issues/metadata-options/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/issues/metadata-options/code>/p>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classerr>draft/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>active/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>closed/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>color/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>sub_status/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>status_id/span>span classp>:/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>label/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>color/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>severity/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>color/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>pausesRun/span>span classp>:/span>span classw> /span>span classerr>boolean/span>span classp>,/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classsuccess>If successful, the response code will be 200/aside>h2 idsign-off-step-in-an-issue>Sign off step in an issue/h2>p>This endpoint adds a signoff to resolution steps within an issue./p>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/issues/steps/signoff/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>step_index/span>span classp>:/span> span classmi>0/span>span classp>,/span> span classs>signoff_id/span>span classp>:/span> span classs>so_vYY3vnQ2jr/span>span classp>,/span> span classs>operator/span>span classp>:/span> span classs>/span>span classp>,/span> span classs>timestamp/span>span classp>:/span> span classs>2024-10-30T20:16:58.759Z/span> span classp>}/span> span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST span classse>\/span> https://api.epsilon3.io/v1/issues/steps/signoff span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ step_index: 0, signoff_id: so_vYY3vnQ2jr, operator: , timestamp: 2024-10-30T20:16:58.759Z }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/issues/steps/signoff/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>step_index/span>span classerr>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>signoff_id/span>span classerr>:/span>span classw> /span>span classs2>so_vYY3vnQ2jr/span>span classp>,/span>span classw> /span>span classs2>operator/span>span classerr>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classerr>:/span>span classw> /span>span classs2>2024-10-30T20:16:58.759Z/span>span classw> /span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Post/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>blockquote>p>Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>step_index/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classp>,/span>span classw> /span>span classnl>signoff_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>operator/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw> /span>span classerr>-/span>span classw> /span>span classerr>ISO/span>span classmi>8601/span>span classw> /span>span classerr>datetime/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>POST code>https://api.epsilon3.io/v1/issues/steps/signoff/code>/p>aside classnotice>ISO8601 formatted datetime example: `2024-09-18T01:01:01.000Z`/aside>aside classsuccess>If successful, the response code will be 204/aside>h1 idprocedures-api>Procedures API/h1>h2 idaudit-procedures-with-invalid-data>Audit procedures with invalid data/h2>p>This endpoint audits procedures and returns the location of invalid telemetry, commanding or external data blocks./p>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/procedures/auditInvalid/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/procedures/auditInvalid span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/auditInvalid/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/procedures/auditInvalid/code>/p>blockquote>p>Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>procedures/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>invalid_blocks/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>section_content/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>section_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>section_name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>step_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>step_name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>content_type/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>(/span>span classw> /span>span classerr>input/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>telemetry/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>commanding/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>external_item/span>span classw> /span>span classerr>)/span>span classw> /span>span classnl>content_name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>content_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>reason/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>(/span>span classw> /span>span classerr>e.g./span>span classw> /span>span classs2>Invalid external data/span>span classw> /span>span classerr>)/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>procedure_variables/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>variable_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>variable_name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>external_search_data_type/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>reason/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>(/span>span classw> /span>span classerr>e.g./span>span classw> /span>span classs2>Invalid commanding/span>span classw> /span>span classerr>)/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classsuccess>If no invalid data is found, an empty list will be returned./aside>h2 idlist-procedure-summaries>List procedure summaries/h2>p>Retrieves a summarized view of all available procedures./p>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/procedures/summary/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/procedures/summary span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/procedures/summary/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET `code>https://api.epsilon3.io/v1/procedures/summary/code>/p>blockquote>p>Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>_id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>_rev/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>procedure_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>state/span>span classp>:/span>span classw> /span>span classs2>draft/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>in_review/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>released/span>span classerr>);/span>span classw> /span>span classnl>code/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>version/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>project_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>project_name/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>project_code/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>archived/span>span classp>:/span>span classw> /span>span classerr>boolean;/span>span classw> /span>span classnl>editedAt/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>reviewer_groups/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<ReviewerGroup>;/span>span classw> /span>span classnl>tags/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<Tag>;/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classsuccess>If no invalid data is found, an empty list will be returned./aside>h2 idretrieve-a-procedure>Retrieve a procedure/h2>p>Retrieves all available information for an individual procedure by ID./p>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/procedures/sampleProcedureId/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/procedures/sampleProcedureId span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/procedures/sampleProcedureId/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/procedures/:procedure-id/code>/p>blockquote>p>Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classw> /span>span classp>{/span>span classw> /span>span classnl>_id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>_rev/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>procedure_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>project_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>project_name/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>project_code/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>code/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>variables/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<DraftVariable>;/span>span classw> /span>span classnl>headers/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<DraftHeader>;/span>span classw> /span>span classnl>version/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>archived/span>span classp>:/span>span classw> /span>span classerr>boolean;/span>span classw> /span>span classnl>state/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classs2>draft/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>in_review/span>span classerr>;/span>span classw> /span>span classnl>sections/span>span classp>:/span>span classw> /span>span classerr>Array<DraftSection>;/span>span classw> /span>span classnl>reviewer_groups/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<ReviewerGroup>;/span>span classw> /span>span classnl>reviewer_actions_history/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<ReviewerAction>;/span>span classw> /span>span classnl>locked_by/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>locked_at/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>redline_actions/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<RedlineAction>;/span>span classw> /span>span classnl>editedAt/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>editedUserId/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>owner/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>procedure_rev_num/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>number;/span>span classw> /span>span classnl>release_note/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>ReleaseNote;/span>span classw> /span>span classnl>comments/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<ReviewComment>;/span>span classw> /span>span classnl>approvals/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<Approval>;/span>span classw> /span>span classnl>tags/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<Tag>;/span>span classw> /span>span classnl>settings/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Settings;/span>span classw> /span>span classnl>reviewers/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<Reviewer>;/span>span classw> /span>span classnl>end_run_signoffs_groups/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array</span>span classp>{/span>span classw> /span>span classerr>id:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classerr>operators:/span>span classw> /span>span classerr>Array<string>;/span>span classw> /span>span classp>}/span>span classerr>>;/span>span classw> /span>span classnl>default_view_mode/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>dictionary_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>number;/span>span classw> /span>span classnl>is_strict_signoff_enabled/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>boolean;/span>span classw> /span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classsuccess>If no invalid data is found, an empty list will be returned./aside>p>strong>Complimentary schemas/strong>/p>blockquote>p>ReviewerGroup/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>reviewers/span>span classp>:/span>span classw> /span>span classerr>Array<Reviewer>;/span>span classw> /span>span classnl>actions/span>span classp>:/span>span classw> /span>span classerr>Array<ReviewerAction>;/span>span classw>/span>span classp>}/span>span classerr>;/span>span classw>/span>/code>/pre>/div>blockquote>p>Reviewer/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>reviewer_ids/span>span classp>:/span>span classw> /span>span classerr>Array<ReviewerId>;/span>span classw> /span>span classnl>is_required/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classkc>true/span>span classerr>;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>ReviewerId/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classerr>type:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classerr>value:/span>span classw> /span>span classerr>string;/span>span classw>/span>span classp>}/span>span classerr>;/span>span classw>/span>/code>/pre>/div>blockquote>p>ReviewerAction/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>reviewer_id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>user_id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>approved_at/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Tag/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>key/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>DraftVariable/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classerr>input/span>span classp>,/span>span classw> /span>span classnl>rule/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Rule;/span>span classw> /span>span classnl>units/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>input_type/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>text/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>number/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>checkbox;/span>span classw> /span>span classnl>inputType/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>text/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>number/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>checkbox/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>timestamp/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>attachment/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>list/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>select/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>external_item/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>external_search/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>multiple_choice;/span>span classw> /span>span classnl>redlines/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<BlockRedline>;/span>span classw> /span>span classnl>version/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classmi>2/span>span classerr>;/span>span classw> /span>span classnl>dateTimeType/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>date/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>time/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>datetime;/span>span classw> /span>span classnl>include_in_summary/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>boolean;/span>span classw> /span>span classnl>list/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>options/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<string>;/span>span classw> /span>span classnl>external_item_type/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>dictionary_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>number;/span>span classw> /span>span classnl>external_search_type/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>data_type_dictionary_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>number;/span>span classw> /span>span classnl>data_type/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>filter_options/span>span classp>:/span>span classw> /span>span classerr>Array<string>;/span>span classw> /span>span classp>}/span>span classerr>;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>BlockRedline/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classerr>DraftVariable/span>span classw> /span>span classerr>|/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classerr>alert/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>text;/span>span classw> /span>span classnl>subtype/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>note/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>caution/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>warning;/span>span classw> /span>span classnl>text/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>DraftHeader/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>content/span>span classp>:/span>span classw> /span>span classerr>Array<DraftHeaderBlock>;/span>span classw> /span>span classnl>header_field_redlines/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classp>{/span>span classw> /span>span classp>/span>span classerr>field:/span>span classw> /span>span classerr>string/span>span classp>/span>span classerr>:/span>span classw> /span>span classerr>Array<DraftFieldRedline>;/span>span classw> /span>span classp>}/span>span classerr>;/span>span classw> /span>span classnl>redlines/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<DraftHeaderBlock/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>DraftFieldRedline>;/span>span classw>/span>span classp>}/span>span classerr>;/span>span classw>/span>/code>/pre>/div>blockquote>p>DraftHeaderBlock/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>alert/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>attachment/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>text/span>span classerr>;/span>span classw> /span>span classnl>subtype/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classs2>note/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>caution/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>warning/span>span classerr>;/span>span classw> /span>span classnl>text/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>redlines/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<BlockRedline>;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>DraftFieldRedline/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classerr>redline_id:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classerr>created_at:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classerr>user_id:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classerr>redlineIndex:/span>span classw> /span>span classerr>number;/span>span classw> /span>span classerr>name:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classerr>redlineId:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classerr>createdAt:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classerr>userId:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>RedlineAction/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>redline_id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>state/span>span classp>:/span>span classw> /span>span classerr>accepted/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>rejected/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>resolved;/span>span classw> /span>span classnl>resolved_at/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>resolved_by/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>resolution_procedure_rev_num/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>number;/span>span classw> /span>span classnl>release_procedure_rev_num/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>number;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>DraftSection/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>headers/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<DraftHeader>;/span>span classw> /span>span classnl>steps/span>span classp>:/span>span classw> /span>span classerr>Array<DraftStep/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>DraftAddedStep>;/span>span classw> /span>span classnl>snippet_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>snippet_name/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>snippet_rev/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>number;/span>span classw> /span>span classnl>snippet_ids_map/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Object<string/span>span classp>,/span>span classw> /span>span classerr>string>;/span>span classw> /span>span classnl>shows_snippet_detached_message/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>boolean;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>DraftStep/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>headers/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<DraftHeader>;/span>span classw> /span>span classnl>timing/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>duration/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>location/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>channel/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>content/span>span classp>:/span>span classw> /span>span classerr>Array<DraftStepBlock>;/span>span classw> /span>span classnl>signoffs/span>span classp>:/span>span classw> /span>span classerr>Array<Signoff>;/span>span classw> /span>span classnl>dependencies/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<StepDependency>;/span>span classw> /span>span classnl>conditionals/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<Conditional>;/span>span classw> /span>span classnl>actions/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<StepAction>;/span>span classw> /span>span classnl>step_field_redlines/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classp>{/span>span classw> /span>span classp>/span>span classerr>field:/span>span classw> /span>span classerr>string/span>span classp>/span>span classerr>:/span>span classw> /span>span classerr>Array<DraftFieldRedline>;/span>span classw> /span>span classp>}/span>span classerr>;/span>span classw> /span>span classnl>shows_snippet_detached_message/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>boolean;/span>span classw> /span>span classnl>snippet_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>snippet_name/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>snippet_rev/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>number;/span>span classw> /span>span classnl>snippet_ids_map/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Object<string/span>span classp>,/span>span classw> /span>span classerr>string>;/span>span classw> /span>span classnl>redline_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>precedingStepId/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>requires_previous/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>boolean;/span>span classw> /span>span classnl>created_during_run/span>span classp>:/span>span classw> /span>span classkc>true/span>span classerr>;/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>created_by/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>StepDependency/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>dependent_ids/span>span classp>:/span>span classw> /span>span classerr>Array<string>;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Conditional/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>source_type/span>span classp>:/span>span classw> /span>span classerr>step/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>content;/span>span classw> /span>span classnl>state/span>span classp>:/span>span classw> /span>span classerr>completed/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>failed;/span>span classw> /span>span classnl>content_id/span>span classp>:/span>span classw> /span>span classkc>null/span>span classerr>;/span>span classw> /span>span classnl>source_id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>target_id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>target_type/span>span classp>:/span>span classw> /span>span classerr>step;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>StepAction/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classerr>signoff;/span>span classw> /span>span classnl>user_id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>conditional_value/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>signoff_id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>operator/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>ReleaseNote/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>user_id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>text/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>ReviewComment/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>reference_id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>redline_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>text/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>user_id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>redline_comment;/span>span classw> /span>span classnl>source_run_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>resolved/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>boolean;/span>span classw> /span>span classnl>resolved_by/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>resolved_at/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>resolution_procedure_rev_num/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>number;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Approval/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>user_id/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>approved_at/span>span classp>:/span>span classw> /span>span classerr>string;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Settings/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>print_settings/span>span classp>:/span>span classw> /span>span classerr>(options)/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>header/span>span classp>:/span>span classw> /span>span classerr>(options)/span>span classw> /span>span classerr>PrintContent;/span>span classw> /span>span classnl>footer/span>span classp>:/span>span classw> /span>span classerr>(options)/span>span classw> /span>span classerr>PrintContent;/span>span classw> /span>span classp>}/span>span classerr>;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>PrintContent/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>text/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw> /span>span classnl>variable_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string;/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h1 idruns-v2-api>Runs V2 API/h1>h2 idget-run>Get Run/h2>p>Retrieve a single run using its ID./p>p>strong>HTTP Request/strong>/p>p>GET code>https://api.epsilon3.io/v2/runs/:runId/code>/p>p>strong>Path Parameters/strong>/p>ul>li>code>runId/code> (string): ID of the run being retrieved./li>/ul>blockquote>p>strong>Sample Request/strong>/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>runId/span> span classo>/span> span classs>lkC6ZrPrvPnPU4OAqNYcW4/span>span classn>api_url/span> span classo>/span> span classsa>f/span>span classs>/span>span classsi>{/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>API_URL/span>span classp>)/span>span classsi>}/span>span classs>/v2/runs//span>span classsi>{/span>span classn>runId/span>span classsi>}/span>span classs>/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classn>api_url/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>json/span>span classp>())/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v2/runs/span classo>{/span>runIdspan classo>}/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$runId/span>span classw> /span>span classo>/span>span classw> /span>span classs2>lkC6ZrPrvPnPU4OAqNYcW4/span>span classw>/span>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v2/runs//span>span classnv>$runId/span>span classs2>/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>blockquote>p>strong>Example Request URL/strong>/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>GET https://api.epsilon3.io/v2/runs/lkC6ZrPrvPnPU4OAqNYcW4/code>/pre>/div>aside classsuccess>If successful, the response code will be 200/aside>blockquote>p>strong>Example Response Body/strong>/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>_rev/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>procedure_rev/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>start_time/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>edited_at/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>edited_user_id/span>span classp>:/span>span classw> /span>span classerr>(optinal)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>procedure_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>run_number/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>project_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>headers/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<RunHeader>/span>span classp>,/span>span classw> /span>span classnl>code/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>variables/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<RunVariable>/span>span classp>,/span>span classw> /span>span classnl>risks/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<ProcedureRisk>/span>span classp>,/span>span classw> /span>span classnl>bill_of_materials/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>BillOfMaterials/span>span classp>,/span>span classw> /span>span classnl>version/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>owner/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>state/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>RunState/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>RunStatus/span>span classp>,/span>span classw> /span>span classnl>sections/span>span classp>:/span>span classw> /span>span classerr>Array<RunSection/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>RepeatedSection>/span>span classp>,/span>span classw> /span>span classnl>participants/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<Participant>/span>span classp>,/span>span classw> /span>span classnl>archived/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>boolean/span>span classp>,/span>span classw> /span>span classnl>actions/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<RunAction>/span>span classp>,/span>span classw> /span>span classnl>reviewer_actions_history/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<ReviewerAction>/span>span classp>,/span>span classw> /span>span classnl>reviewer_groups/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<ReviewerGroup>/span>span classp>,/span>span classw> /span>span classnl>operation/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>OperationId/span>span classp>,/span>span classw> /span>span classnl>run_tags/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<RunTag>/span>span classp>,/span>span classw> /span>span classnl>run_section/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>completedAt/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>completedUserId/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>procedure_rev_num/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>approvals/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<Approval>/span>span classp>,/span>span classw> /span>span classnl>tags/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<Tag>/span>span classp>,/span>span classw> /span>span classnl>settings/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Settings/span>span classp>,/span>span classw> /span>span classnl>reviewers/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<Reviewer>/span>span classp>,/span>span classw> /span>span classnl>default_view_mode/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>source_run/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>parent_reference/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>RunParentReference/span>span classp>,/span>span classw> /span>span classnl>started_by/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>method/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>user_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>issues/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Record<string/span>span classp>,/span>span classw> /span>span classerr>RunIssue>/span>span classp>,/span>span classw> /span>span classnl>procedure/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>end_run_signoffs_groups/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<EndRunSignoff>/span>span classp>,/span>span classw> /span>span classnl>start_run_signoffs_groups/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<StartRunSignoff>/span>span classp>,/span>span classw> /span>span classnl>dictionary_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>comments/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<ReviewComment>/span>span classp>,/span>span classw> /span>span classnl>operators/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<string>/span>span classp>,/span>span classw> /span>span classnl>procedure_type/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>ProcedureType/span>span classp>,/span>span classw> /span>span classnl>automation_status/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>AutomationStatus/span>span classp>,/span>span classw> /span>span classnl>test_case_list/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>TestCaseList/span>span classp>,/span>span classw> /span>span classnl>auto_procedure_id_enabled/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>boolean/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>RunHeader/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>content/span>span classp>:/span>span classw> /span>span classerr>Array<ContentBlock>/span>span classp>,/span>span classw> /span>span classnl>redlines/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<RunHeaderRedline>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>RunVariable/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>input_type/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>number/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>boolean/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>ProcedureRisk/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>title/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>RunSection/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>headers/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<RunSectionHeader>/span>span classp>,/span>span classw> /span>span classnl>steps/span>span classp>:/span>span classw> /span>span classerr>Array<RunStep/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>RunAddedStep/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>RepeatedStep>/span>span classp>,/span>span classw> /span>span classnl>dependencies/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<Dependency>/span>span classp>,/span>span classw> /span>span classnl>snippet_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>snippet_name/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>snippet_rev/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>number/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>RepeatedSection/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>headers/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<RunSectionHeader>/span>span classp>,/span>span classw> /span>span classnl>steps/span>span classp>:/span>span classw> /span>span classerr>Array<RunStep/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>RepeatedStep>/span>span classp>,/span>span classw> /span>span classnl>dependencies/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<Dependency>/span>span classp>,/span>span classw> /span>span classnl>snippet_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>snippet_name/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>snippet_rev/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>repeat_of/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>repeated_at/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>repeated_user_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>RunStep/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>run_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>state/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classs2>failed/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>paused/span>span classp>,/span>span classw> /span>span classnl>headers/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<RunStepHeader>/span>span classp>,/span>span classw> /span>span classnl>content/span>span classp>:/span>span classw> /span>span classerr>Array<RunStepBlock>/span>span classp>,/span>span classw> /span>span classnl>dependencies/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<Dependency>/span>span classp>,/span>span classw> /span>span classnl>signoffs/span>span classp>:/span>span classw> /span>span classerr>Array<Signoff>/span>span classp>,/span>span classw> /span>span classnl>conditionals/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<Conditional>/span>span classp>,/span>span classw> /span>span classnl>actions/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<StepAction>/span>span classp>,/span>span classw> /span>span classnl>completed/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>completed_at/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>completed_user_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>skipped/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>skipped_at/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>skipped_user_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>snippet_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>snippet_name/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>snippet_rev/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>timing/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>timer/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>StepTiming/span>span classp>,/span>span classw> /span>span classnl>duration/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>StepDuration/span>span classp>,/span>span classw> /span>span classnl>expected_duration/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>location/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>channel/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>redlines/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<RunStepRedline>/span>span classp>,/span>span classw> /span>span classnl>comments/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<RunStepComment>/span>span classp>,/span>span classw> /span>span classnl>shows_snippet_detached_message/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>boolean/span>span classp>,/span>span classw> /span>span classnl>preceding_step_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>automation_status/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>AutomationStatus/span>span classp>,/span>span classw> /span>span classnl>batch_props/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>batch_size/span>span classp>:/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>index/span>span classp>:/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>batch_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>instance_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>RunAddedStep/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>content/span>span classp>:/span>span classw> /span>span classerr>Array<RunStepBlock>/span>span classp>,/span>span classw> /span>span classnl>signoffs/span>span classp>:/span>span classw> /span>span classerr>Array<Signoff>/span>span classp>,/span>span classw> /span>span classnl>dependencies/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<Dependency>/span>span classp>,/span>span classw> /span>span classnl>conditionals/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<Conditional>/span>span classp>,/span>span classw> /span>span classnl>actions/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<StepAction>/span>span classp>,/span>span classw> /span>span classnl>completed/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>completed_at/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>completed_user_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>skipped/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>skipped_at/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>skipped_user_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>snippet_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>snippet_name/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>snippet_rev/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>timing/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>timer/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>StepTiming/span>span classp>,/span>span classw> /span>span classnl>duration/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>StepDuration/span>span classp>,/span>span classw> /span>span classnl>expected_duration/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>location/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>channel/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>created_during_run/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>created_by/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Participant/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>user_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>RunAction/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>user_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>pause/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>resume/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>change operation/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>reopen/span>span classp>,/span>span classw> /span>span classnl>comment/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>EndRunSignoff / StartRunSignoff/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>operators/span>span classp>:/span>span classw> /span>span classerr>Array<string>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Tag/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Settings/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>print_settings/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>header/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>text/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>variable_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>footer/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>text/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>variable_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>RunParentReference/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>run/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>issue/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>risk/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>event/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>operation/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>RunIssue/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>text/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>url/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>Jira/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>Internal/span>span classp>,/span>span classw> /span>span classnl>severity/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Severity/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Status/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>AutomationStatus/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>message/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Signoff/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>operators/span>span classp>:/span>span classw> /span>span classerr>Array<string>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Dependency/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>dependent_ids/span>span classp>:/span>span classw> /span>span classerr>Array<string>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Conditional/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>source_type/span>span classp>:/span>span classw> /span>span classs2>step/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>content/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>content_binary/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>content_ternary/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>duration/span>span classp>,/span>span classw> /span>span classnl>state/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>content_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>source_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>target_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>target_type/span>span classp>:/span>span classw> /span>span classs2>step/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>RunStepHeader/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>content/span>span classp>:/span>span classw> /span>span classerr>Array<RunStepBlock>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>RunStepComment/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>text/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>updated_at/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>user/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>parent_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>attachment/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>object/span>span classp>,/span>span classw> /span>span classnl>mention_list/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>Array<Mention>/span>span classp>,/span>span classw> /span>span classnl>reference_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>StepAction/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>signoff/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>revoke_signoff/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>complete/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>fail/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>skip/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>issue/span>span classp>,/span>span classw> /span>span classnl>user_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>comment/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>signoff_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>operator/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>device_user_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>RunStepBlock/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>content_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>details/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>object/span>span classp>,/span>span classw> /span>span classnl>metadata/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>object/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>BillOfMaterials/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>part/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>part_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>revision_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>components/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>part_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>revision_id/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>quantity/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>number/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>Retrieve a single run using its ID./p>p>strong>HTTP Request/strong>/p>p>GET code>https://api.epsilon3.io/v2/runs/:runId/code>/p>p>strong>Path Parameters/strong>/p>ul>li>code>runId/code> (string): ID of the run being retrieved./li>/ul>h1 idruns-api>Runs API/h1>p>Epsilon3’s Runs API supports creating and managing runs and associated data./p>h2 idstart-a-running-procedure>Start a running procedure/h2>p>This endpoint creates new procedure runs./p>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/runs/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>procedure_id/span>span classp>:/span> span classs>up9goX1AgzCuffxUXbpI1K/span>span classp>,/span> span classs>procedure_variables/span>span classp>:/span> span classp>{/span> span classs>manufacturer/span>span classp>:/span> span classs>tesla/span>span classp>,/span> span classs>VIN/span>span classp>:/span> span classmi>12345/span>span classp>,/span> span classs>four-wheel drive?/span>span classp>:/span> span classn>false/span>span classp>,/span> span classp>}/span> span classp>}/span> span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST span classse>\/span> https://api.epsilon3.io/v1/runs span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ procedure_id: up9goX1AgzCuffxUXbpI1K, procedure_variables: { manufacturer: tesla, VIN: 12345, four-wheel drive?: false, } }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/runs/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>procedure_id/span>span classerr>:/span>span classw> /span>span classs2>up9goX1AgzCuffxUXbpI1K/span>span classp>,/span>span classw> /span>span classs2>procedure_variables/span>span classerr>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>manufacturer/span>span classp>:/span>span classw> /span>span classs2>tesla/span>span classp>,/span>span classw> /span>span classs2>VIN/span>span classp>:/span>span classw> /span>span classmi>12345/span>span classp>,/span>span classw> /span>span classs2>four-wheel drive?/span>span classp>:/span>span classw> /span>span classn>false/span>span classp>,/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Post/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>blockquote>p>Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>procedure_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>procedure_variables/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>variable name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>number/span>span classw> /span>span classerr>|/span>span classw> /span>span classerr>boolean/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>POST code>https://api.epsilon3.io/v1/runs/code>/p>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>run_id/span>span classp>:/span>span classw> /span>span classs2>GMFvqA1qLgrw0xIEc95M2o/span>span classp>,/span>span classw> /span>span classnl>run_number/span>span classp>:/span>span classw> /span>span classmi>42/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>The request body must contain the id of the procedure to start, and can optionally be used to pre-populate procedure variables./p>aside classnotice>The procedure id is the suffix of the URL when viewing a procedure, e.g., code>https://app.epsilon3.io/app/team/<team_id>/procedures/<procedure_id>/code>./aside>p>Request value types correspond to the type of the procedure variable:/p>table>thead>tr>th>Procedure Variable Type/th>th>Request Value Type/th>/tr>/thead>tbody>tr>td>Text/td>td>string/td>/tr>tr>td>Number/td>td>number; or, a string parsable to a number/td>/tr>tr>td>Checkbox/td>td>boolean/td>/tr>tr>td>List & Custom List/td>td>string/td>/tr>tr>td>Multiple Choice/td>td>string/td>/tr>tr>td>Timestamp/td>td>string, timestamp in a hrefhttps://tc39.es/ecma262/multipage/numbers-and-dates.html#sec-date-time-string-format>ISO-8601 format/a>*/td>/tr>/tbody>/table>p>*For time-only timestamp variables (with no date component required), the format may be code>HH:mm/code> or code>HH:mm:ss/code>. The date portion will default to the start of the epoch - January 1, 1970 UTC/p>p>Unsupported variable types: Attachment, Sketch, External Data, External Search/p>aside classsuccess>If successful, the response contains the id of the created run./aside>p>The run can be viewed at code>https://app.epsilon3.io/runs/<run_id>/code>./p>h2 idpause-or-resume-a-running-procedure>Pause or resume a running procedure/h2>p>This endpoint allows you to pause or resume a procedure with an optional comment./p>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/runs/up9goX1AgzCuffxUXbpI1K/pause/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>comment/span>span classp>:/span> span classs>Safety check pause/span> span classp>}/span> span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST span classse>\/span> https://api.epsilon3.io/v1/runs/up9goX1AgzCuffxUXbpI1K/pause span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ comment: Safety check pause }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/runs/up9goX1AgzCuffxUXbpI1K/pause/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>comment/span>span classerr>:/span>span classw> /span>span classs2>Safety check pause/span>span classw> /span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Post/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>blockquote>p>Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>comment/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classp>}/span>span classw>/span>/code>/pre>/div>p>POST code>https://api.epsilon3.io/v1/runs/:runId/pause/code>ORPOST code>https://api.epsilon3.io/v1/runs/:runId/resume/code>/p>p>The runId parameter in the URL must contain the id of the running procedure to pause/resume./p>aside classnotice>The run id is the suffix of the URL when viewing a running procedure, e.g., code>https://app.epsilon3.io/app/team/<team_id>/runs/<runId>/code>./aside>aside classsuccess>If successful, the response code will be 204/aside>h2 idretrieve-list-of-running-procedure-summaries>Retrieve list of running procedure summaries/h2>p>This endpoint allows you to retrieve a list of summarized running procedures with an optional filter for run state./p>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/runs/summary/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>params/span>span classo>/span>span classp>{/span> span classs>run-state/span>span classp>:/span> span classp>/span>span classs>paused/span>span classp>,/span> span classs>completed/span>span classp>,/span> span classp>}/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> span classs2>https://api.epsilon3.io/v1/runs/summary?run-statepaused&run-statecompleted/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/runs/summary?run-statepaused&run-statecompleted/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/runs/summary/code>/p>table>thead>tr>th>Query parameter/th>th>Value/th>/tr>/thead>tbody>tr>td>run-state/td>td>Array - running | paused | completed/td>/tr>tr>td>operation-keys/td>td>Array - string/td>/tr>tr>td>project-ids/td>td>Array - string/td>/tr>tr>td>tag-ids/td>td>Array - string/td>/tr>tr>td>procedure-ids/td>td>Array - string/td>/tr>tr>td>start-time-before/td>td>String - ISO8601 datetime/td>/tr>tr>td>start-time-after/td>td>String - ISO8601 datetime/td>/tr>tr>td>end-time-before/td>td>String - ISO8601 datetime/td>/tr>tr>td>end-time-after/td>td>String - ISO8601 datetime/td>/tr>/tbody>/table>aside classnotice>ISO8601 formatted datetime example: `2024-09-18T01:01:01.000Z`/aside>p>Query parameter example usagecode>GET https://api.epsilon3.io/v1/runs/summary?run-statepaused&run-statecompleted&project-idsabc&start-time-before2024-09-18T01:01:01.000Z/code>/p>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>code/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>completedAt/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>timestamp/span>span classw> /span>span classerr>in/span>span classw> /span>span classerr>ISO/span>span classmi>-8601/span>span classw> /span>span classerr>format/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>operation/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>project_id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>run_tags/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classerr>key:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>name:/span>span classw> /span>span classerr>string/span>span classp>},/span>span classw> /span>span classerr>.../span>span classw> /span>span classp>,/span>span classw> /span>span classnl>run_section/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>source_run/span>span classp>:/span>span classw> /span>span classerr>(optional)/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>starttime/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>timestamp/span>span classw> /span>span classerr>in/span>span classw> /span>span classerr>ISO/span>span classmi>-8601/span>span classw> /span>span classerr>format/span>span classp>,/span>span classw> /span>span classnl>state/span>span classp>:/span>span classw> /span>span classs2>running/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>completed/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>paused/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>success/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>failure/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>abort/span>span classp>,/span>span classw> /span>span classnl>skipped_steps/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classp>,/span>span classw> /span>span classnl>completed_steps/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classp>,/span>span classw> /span>span classnl>failed_steps/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classp>,/span>span classw> /span>span classnl>total_steps/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classp>,/span>span classw> /span>span classnl>not_required_steps/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classp>,/span>span classw> /span>span classnl>participant_user_ids/span>span classp>:/span>span classw> /span>span classerr>array(string)/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classsuccess>If successful, the response code will be 200/aside>h2 idend-a-running-procedure>End a running procedure/h2>p>This endpoint allows you to end a procedure with an optional comment or status. When a running procedure is ended via this endpoint, any telemetry data that has not been recorded will be stored./p>aside classnotice>Simulated telemetry will not be recorded when a running procedure is ended via the API./aside>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/runs/up9goX1AgzCuffxUXbpI1K/end/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>comment/span>span classp>:/span> span classs>Everything looks OK./span>span classp>,/span> span classs>status/span>span classp>:/span> span classs>success/span> span classp>}/span> span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST span classse>\/span> https://api.epsilon3.io/v1/runs/up9goX1AgzCuffxUXbpI1K/end span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ comment: Everything looks OK., status: success }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/runs/up9goX1AgzCuffxUXbpI1K/end/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>comment/span>span classerr>:/span>span classw> /span>span classs2>Everything looks OK./span>span classp>,/span>span classw> /span>span classs2>status/span>span classerr>:/span>span classw> /span>span classs2>success/span>span classw> /span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Post/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>blockquote>p>Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>comment/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw> /span>span classerr>(optional)/span>span classp>,/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw> /span>span classerr>(optional)/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>Allowed code>status/code> values are: - code>success/code> - code>failure/code> - code>abort/code>/p>p>code>POST https://api.epsilon3.io/v1/runs/:runId/end/code>/p>p>The runId parameter in the URL must contain the id of the running procedure to end./p>aside classnotice>The run id is the suffix of the URL when viewing a running procedure, e.g., code>https://app.epsilon3.io/app/team/<team_id>/runs/<runId>/code>./aside>aside classsuccess>If successful, the response code will be 204./aside>h2 idretrieve-available-run-tags>Retrieve available run tags/h2>p>This endpoint allows you to retrieve all run tags available to be assigned to a run./p>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/runs/tags/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> span classs2>https://api.epsilon3.io/v1/runs/tags/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/runs/tags/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/runs/tags/code>/p>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>tags/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>key/span>span classp>:/span>span classw> /span>span classs2>qji7zlB0WV/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Sample Tag/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classsuccess>If successful, the response code will be 200/aside>h2 idcreate-run-tags>Create run tags/h2>p>This endpoint allows you to create tags that you can then assign to runs./p>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/runs/tags/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>tag_names/span>span classp>:/span> span classp>/span>span classs>Sample Tag 1/span>span classp>,/span> span classs>Sample Tag 2/span>span classp>/span> span classp>}/span> span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST span classse>\/span> https://api.epsilon3.io/v1/runs/tags span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ tag_names: Sample Tag 1, Sample Tag 2 }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/runs/tags/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>tag_names/span>span classerr>:/span>span classw> /span>span classp>/span>span classs2>Sample Tag 1/span>span classp>,/span>span classw> /span>span classs2>Sample Tag 2/span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Post/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>blockquote>p>Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>tag_names/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>Sample Tag 1/span>span classp>,/span>span classw> /span>span classs2>Sample Tag 2/span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>/code>/pre>/div>p>POST code>https://api.epsilon3.io/v1/runs/tags/code>/p>aside classsuccess>If successful, the response code will be 201 and the response body will contain the created tags with their corresponding IDs./aside>h2 idretrieve-run-metadata>Retrieve run metadata/h2>p>This endpoint allows you to retrieve the metadata of a run./p>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/runs/up9goX1AgzCuffxUXbpI1K/metadata/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> span classs2>https://api.epsilon3.io/v1/runs/up9goX1AgzCuffxUXbpI1K/metadata/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/runs/up9goX1AgzCuffxUXbpI1K/metadata/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/runs/:runId/metadata/code>/p>p>The runId parameter in the URL must contain the id of the running procedure to update./p>aside classnotice>The run id is the suffix of the URL when viewing a running procedure, e.g., code>https://app.epsilon3.io/app/team/<team_id>/runs/<runId>/code>./aside>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>state/span>span classp>:/span>span classw> /span>span classs2>running/span>span classp>,/span>span classw> /span>span classnl>tags/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>qji7zlB0WV/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Sample Tag/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classerr>project:/span>span classw> /span>span classp>{/span>span classw> /span>span classerr>code:/span>span classw> /span>span classs2>P1/span>span classp>,/span>span classw> /span>span classerr>id:/span>span classw> /span>span classs2>OFJsa3MWU7/span>span classp>,/span>span classw> /span>span classerr>name:/span>span classw> /span>span classs2>ProjectOne/span>span classp>,/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>operation/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Sample Operation/span>span classp>,/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>sample operation/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>participants:/span>span classw> /span>span classp>/span>span classs2>test1@epsilon3.io/span>span classp>,/span>span classw> /span>span classs2>test2@epsilon3.io/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classsuccess>If successful, the response code will be 200/aside>h2 idset-run-metadata>Set run metadata/h2>p>This endpoint allows you to set metadata about the run. Currently only run tags supported./p>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>patch/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/runs/up9goX1AgzCuffxUXbpI1K/metadata/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>run_tag_ids/span>span classp>:/span> span classp>/span>span classs>qji7zlB0WV/span>span classp>/span> span classp>}/span> span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> PATCH span classse>\/span> https://api.epsilon3.io/v1/runs/up9goX1AgzCuffxUXbpI1K/metadata span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ run_tag_ids: qji7zlB0WV }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/runs/up9goX1AgzCuffxUXbpI1K/metadata/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>run_tag_ids/span>span classerr>:/span>span classw> /span>span classp>/span>span classs2>qji7zlB0WV/span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Patch/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>blockquote>p>Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>run_tag_ids/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>qji7zlB0WV/span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>/code>/pre>/div>p>PATCH code>https://api.epsilon3.io/v1/runs/:runId/metadata/code>/p>p>The runId parameter in the URL must contain the id of the running procedure to update./p>aside classnotice>The run id is the suffix of the URL when viewing a running procedure, e.g., code>https://app.epsilon3.io/app/team/<team_id>/runs/<runId>/code>./aside>aside classsuccess>If successful, the response code will be 204/aside>h2 idstart-automation>Start automation/h2>p>This endpoint allows you to start automation for a run./p>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/runs/up9goX1AgzCuffxUXbpI1K/automation/start/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>step_id/span>span classp>:/span> span classs>step_Gi2nyYKZjf/span>span classp>,/span> span classs>section_id/span>span classp>:/span> span classs>sctn_zk5SU0lzbF/span> span classp>}/span> span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST span classse>\/span> https://api.epsilon3.io/v1/runs/up9goX1AgzCuffxUXbpI1K/automation/start span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ step_id: step_Gi2nyYKZjf, section_id: sctn_zk5SU0lzbF }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/runs/up9goX1AgzCuffxUXbpI1K/automation/start/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>step_id/span>span classerr>:/span>span classw> /span>span classs2>step_Gi2nyYKZjf/span>span classp>,/span>span classw> /span>span classs2>section_id/span>span classerr>:/span>span classw> /span>span classs2>sctn_zk5SU0lzbF/span>span classw> /span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Post/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>p>POST code>https://api.epsilon3.io/v1/runs/:runId/automation/start/code>/p>h3 idparameters>Parameters/h3>table>thead>tr>th>Parameter/th>th>Type/th>th>Optional/th>th>Description/th>/tr>/thead>tbody>tr>td>step_id/td>td>string/td>td>True/td>td>Step ID, if provided, automation will only run that step. If not provided, automation will run from the first automatable step./td>/tr>tr>td>section_id/td>td>string/td>td>True/td>td>Section ID, if provided, automation will only run steps in that section. If not provided, automation will run from the first automatable step./td>/tr>/tbody>/table>p>The runId parameter in the URL must contain the id of the running procedure to update./p>aside classnotice>The run id is the suffix of the URL when viewing a running procedure, e.g., code>https://app.epsilon3.io/app/team/<team_id>/runs/<runId>/code>./aside>aside classsuccess>If successful, the response code will be 204/aside>h2 idstop-automation>Stop automation/h2>p>This endpoint allows you to stop automation for a run./p>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/runs/up9goX1AgzCuffxUXbpI1K/automation/stop/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>step_id/span>span classp>:/span> span classs>step_Gi2nyYKZjf/span>span classp>,/span> span classs>section_id/span>span classp>:/span> span classs>sctn_zk5SU0lzbF/span> span classp>}/span> span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST span classse>\/span> https://api.epsilon3.io/v1/runs/up9goX1AgzCuffxUXbpI1K/automation/stop span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ step_id: step_Gi2nyYKZjf, section_id: sctn_zk5SU0lzbF }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/runs/up9goX1AgzCuffxUXbpI1K/automation/stop/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>step_id/span>span classerr>:/span>span classw> /span>span classs2>step_Gi2nyYKZjf/span>span classp>,/span>span classw> /span>span classs2>section_id/span>span classerr>:/span>span classw> /span>span classs2>sctn_zk5SU0lzbF/span>span classw> /span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Post/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>p>POST code>https://api.epsilon3.io/v1/runs/:runId/automation/stop/code>/p>p>The runId parameter in the URL must contain the id of the running procedure to update./p>aside classnotice>The run id is the suffix of the URL when viewing a running procedure, e.g., code>https://app.epsilon3.io/app/team/<team_id>/runs/<runId>/code>./aside>aside classsuccess>If successful, the response code will be 204/aside>h1 idswimlanes-api>Swimlanes API/h1>p>Swimlanes are used in schedules to group events in the Gantt chart. Epsilon3's swimlanes API currently supports the following capabilities./p>h2 idget-swimlanes>Get Swimlanes/h2>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/swimlanes/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/swimlanes span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/swimlanes/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>/api/v1/swimlanes/code>/p>p>Retrieves all swimlane/p>blockquote>p>Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>swimlanes/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>DpSTO81RP9fZSUd8d8ffY4/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Swimlane Exo/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>9ozH0ZOXLLBRZg4K0v1CXf/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>New/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>A2T07M4MkQeiJQqW7xOH6w/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>API Swimlane/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>F1HKrIQ8gY6UIHRj1qhclC/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Launch/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>zAt5hyS3FEmvy4THcTIIVh/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>QA Check/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idupdate-swimlane>Update Swimlane/h2>p>PATCH code>/api/v1/swimlanes/:swimlane_id/code>/p>p>Updates a specific swimlane./p>blockquote>p>Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>PATCH /api/v1/swimlane/test_swimlane_id/code>/pre>/div>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Patched Swimlane/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>strong>Parameters/strong>/p>ul>li>code>swimlane_id/code> (path parameter): Id of the swimlane./li>/ul>p>strong>Request Body/strong>/p>p>The request body should be a JSON object that contains the details of the swimlane to be updated. The following fields are supported:/p>ul>li>code>name/code>: (required) Swimlane name, must be a string./li>/ul>p>strong>Response/strong>The response status code will be 204 for a succcessful message/p>h2 idcreate-swimlane>Create Swimlane/h2>p>POST code>/api/v1/swimlanes/code>/p>blockquote>p>Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>POST /api/v1/swimlanes/code>/pre>/div>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>New Swimlane/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>Creates a new swimlane./p>p>strong>Parameters/strong>/p>p>No path parameters are required for this endpoint./p>p>strong>Request Body/strong>/p>p>The request body should be a JSON object that contains the details of the swimlane to be created. The following fields are supported:/p>ul>li>code>name/code>: (required) Swimlane name, must be a string./li>/ul>p>strong>Response/strong>/p>p>The response status code will be 201 and return a JSON object containing the ID of the newly created swimlane./p>h2 iddelete-swimlane>Delete Swimlane/h2>p>DELETE code>/api/v1/swimlanes/:swimlane_id/code>/p>blockquote>p>Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>DELETE /api/v1/swimlanes/test_swimlane_id/code>/pre>/div>p>Deletes an swimlane./p>p>strong>Parameters/strong>/p>ul>li>code>swimlane_id/code> (path parameter): Id of the swimlane./li>/ul>p>strong>Response/strong>/p>p>The response status code will be 204 for a successful response./p>h1 idtelemetry-api>Telemetry API/h1>p>Epsilon3’s telemetry API supports creating, updating, retrieving, or deleting telemetry parameters. Uploading telemetry parameters to the API allows the user to do the following in Epsilon3:/p>ul>li>Search by parameter name for manual input of telemetry values in procedures/li>li>Display parameter description and automatically populate units/li>/ul>h3 idcreate-or-update-a-telemetry-parameter>Create or update a telemetry parameter/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/telemetry/parameters/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>json/span>span classo>/span>span classp>{/span> span classs>name/span>span classp>:/span> span classs>test.simulation.error/span>span classp>,/span> span classs>type/span>span classp>:/span> span classs>enum/span>span classp>,/span> span classs>dictionary_id/span>span classp>:/span> span classmi>1/span>span classp>,/span> span classs>description/span>span classp>:/span> span classs>Payload error flag/span>span classp>,/span> span classs>refresh_rate_ms/span>span classp>:/span> span classmi>10000/span>span classp>,/span> span classs>values/span>span classp>:/span> span classp>{/span> span classs>0/span>span classp>:/span> span classs>FAIL/span>span classp>,/span> span classs>1/span>span classp>:/span> span classs>SUCCESS/span> span classp>}/span> span classp>}/span> span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST span classse>\/span> https://api.epsilon3.io/v1/telemetry/parameters span classse>\/span> span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>: span classse>\/span> span classnt>-d/span> span classs1>{ name: test.simulation.error, type: enum, dictionary_id: 1, description: Payload error flag, refresh_rate_ms: 10000, values: { 0: FAIL, 1: SUCCESS } }/span>/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/telemetry/parameters/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Content-Type/span>span classw> /span>span classo>/span>span classw> /span>span classs2>application/json/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classnv>$body/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>name/span>span classerr>:/span>span classw> /span>span classs2>test.simulation.error/span>span classp>,/span>span classw> /span>span classs2>type/span>span classerr>:/span>span classw> /span>span classs2>enum/span>span classp>,/span>span classw> /span>span classs2>dictionary_id/span>span classerr>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classerr>:/span>span classw> /span>span classs2>Payload error flag/span>span classp>,/span>span classw> /span>span classs2>refresh_rate_ms/span>span classerr>:/span>span classw> /span>span classmi>10000/span>span classp>,/span>span classw> /span>span classs2>values/span>span classerr>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>0/span>span classp>:/span>span classw> /span>span classs2>FAIL/span>span classp>,/span>span classw> /span>span classs2>1/span>span classp>:/span>span classw> /span>span classs2>SUCCESS/span>span classw> /span>span classp>}/span>span classw> /span>span classp>}/span>span classw> /span>span classo>|/span>span classw> /span>span classn>ConvertTo-Json/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Post/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw> /span>span classnt>-Body/span>span classw> /span>span classnv>$body/span>span classw>/span>/code>/pre>/div>blockquote>p>Request Body (Parameter Object)/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>dictionary_id/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classw> /span>span classerr>(optional)/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw> /span>span classerr>(optional)/span>span classp>,/span>span classw> /span>span classnl>units/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw> /span>span classerr>(optional)/span>span classp>,/span>span classw> /span>span classnl>refresh_rate_ms/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classw> /span>span classerr>(optional)/span>span classp>,/span>span classw> /span>span classnl>values/span>span classp>:/span>span classw> /span>span classerr>object/span>span classw> /span>span classerr>(optional/span>span classw> /span>span classerr>-/span>span classw> /span>span classerr>required/span>span classw> /span>span classerr>for/span>span classw> /span>span classerr>enum/span>span classw> /span>span classerr>and/span>span classw> /span>span classerr>aggregate/span>span classw> /span>span classerr>types)/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>POST code>https://api.epsilon3.io/v1/telemetry/parameters/code>/p>p>The request body should contain a Parameter object. The fields code>name/code> and code>type/code> are required. The code>name/code> field should be unique per dictionary. The optional code>dictionary_id/code> field allows the parameter to be related to a dictionary. If no code>dictionary_id/code> is provided, the parameter will be related to the default dictionary. The parameter code>refresh_rate_ms/code> is a positive integer denoting the number of milliseconds the UI will wait before refreshing the value, defaults to 1000 (1 second) if not provided. The code>values/code> parameter is required for code>enum/code> and code>aggregate/code> type parameters. For enum types, code>values/code> represents a mapping of integer keys to string labels - each integer key corresponds to a unique string label. For aggregate types, code>values/code> represents an array of parameter objects - each object has a required code>name/code> and code>type/code> field (a code>values/code> field is required if code>type/code> is code>enum/code>)/p>blockquote>p>Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>dictionary_id/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classp>,/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>timestamp/span>span classw> /span>span classerr>in/span>span classw> /span>span classerr>ISO/span>span classmi>-8601/span>span classw> /span>span classerr>format/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Enum Request/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>test.simulation.enum/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>enum/span>span classp>,/span>span classw> /span>span classnl>dictionary_id/span>span classp>:/span>span classw> /span>span classmi>5/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>Enum representing state of simulation/span>span classp>,/span>span classw> /span>span classnl>refresh_rate_ms/span>span classp>:/span>span classw> /span>span classmi>1000/span>span classp>,/span>span classw> /span>span classnl>values/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>0/span>span classp>:/span>span classw> /span>span classs2>FAIL/span>span classp>,/span>span classw> /span>span classnl>1/span>span classp>:/span>span classw> /span>span classs2>SUCCESS/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Aggregate Request/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>test.simulation.aggregate/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>aggregate/span>span classp>,/span>span classw> /span>span classnl>dictionary_id/span>span classp>:/span>span classw> /span>span classmi>5/span>span classp>,/span>span classw> /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>Aggregate type representing state of simulation/span>span classp>,/span>span classw> /span>span classnl>refresh_rate_ms/span>span classp>:/span>span classw> /span>span classmi>1000/span>span classp>,/span>span classw> /span>span classnl>values/span>span classp>:/span>span classw> /span>span classp>{/span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>test_val/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>float/span>span classp>},/span>span classw> /span>span classp>{/span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>test_enum/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>enum/span>span classp>,/span>span classw> /span>span classnl>values/span>span classp>:{/span>span classw> /span>span classnl>0/span>span classp>:/span>span classw> /span>span classs2>FAIL/span>span classp>,/span>span classw> /span>span classnl>1/span>span classp>:/span>span classw> /span>span classs2>SUCCESS/span>span classw> /span>span classp>}}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>Supported types:/p>ul>li>code>float/code>/li>li>code>int/code>/li>li>code>string/code>/li>li>code>bool/code>/li>li>code>enum/code>/li>li>code>aggregate/code>/li>/ul>aside classwarning>Supported integer range is -9007199254740991 to 9007199254740991 (53 bit signed)./aside>aside classsuccess>If successful, the response contains the created or updated Parameter object with a code>created_at/code> field. If the parameter already exists, the request will update the existing parameter. The parameter name can be used to retrieve or update the parameter./aside>h3 idlist-all-available-telemetry-parameters>List all available telemetry parameters/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/telemetry/parameters/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/telemetry/parameters span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/telemetry/parameters/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/telemetry/parameters/code>/p>blockquote>p>Sample Request with Query Parameters/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/telemetry/parameters/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>params/span>span classo>/span>span classp>{/span> span classs>dictionary-group-ids/span>span classp>:/span> span classs>1,5,28/span> span classp>}/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> span classs2>https://api.epsilon3.io/v1/telemetry/parameters?dictionary-group-ids1,5,28/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/telemetry/parameters?dictionary-group-ids1,5,28/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/telemetry/parameters?dictionary-group-ids{dictionary-group-ids}/code>/p>p>The optional URL parameter code>dictionary-group-ids/code> may be provided to filter telemetry parameters by dictionary groups. The value should be a comma-separated list of dictionary group IDs. The response will only contain telemetry parameters that belong to at least one of the specified dictionary groups./p>blockquote>p>Response Body (List of Parameter Objects)/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>dictionary_id/span>span classp>:/span>span classw> /span>span classerr>integer/span>span classp>,/span>span classw> /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>timestamp/span>span classw> /span>span classerr>in/span>span classw> /span>span classerr>ISO/span>span classmi>-8601/span>span classw> /span>span classerr>format/span>span classp>,/span>span classw> /span>span classnl>refresh_rate_ms/span>span classp>:/span>span classw> /span>span classerr>number/span>span classp>,/span>span classw> /span>span classnl>values/span>span classp>:/span>span classw> /span>span classerr>object/span>span classw> /span>span classerr>(Represents/span>span classw> /span>span classerr>a/span>span classw> /span>span classerr>mapping/span>span classw> /span>span classerr>of/span>span classw> /span>span classerr>integer/span>span classw> /span>span classerr>keys/span>span classw> /span>span classerr>to/span>span classw> /span>span classerr>string/span>span classw> /span>span classerr>labels)/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classsuccess>If successful, the response contains a list of Parameter objects with a “created_at” field./aside>h3 idretrieve-a-telemetry-parameter-by-name>Retrieve a telemetry parameter by name/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/telemetry/parameters/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>),/span> span classn>params/span>span classo>/span>span classp>{/span> span classs>name/span>span classp>:/span> span classs>test.simulation.error/span>span classp>,/span> span classs>dictionary_id/span>span classp>:/span> span classmi>1/span> span classp>}/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> span classs2>https://api.epsilon3.io/v1/telemetry/parameters/query?nametest.simulation.error&dictionary_id1/span> span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/telemetry/parameters/query?nametest.simulation.error&dictionary_id1/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/telemetry/parameters/query?name{name}&dictionary_id{dictionary_id}/code>/p>p>The URL parameter code>name/code> is required and must be URL encoded. An optional code>dictionary_id/code> may be provided to choose a specific dictionary. If code>dictionary_id/code> is not included, the default dictionary will be used./p>aside classwarning>The request body must be empty./aside>aside classsuccess>If successful, the response contains a Parameter object with a “created_at” field./aside>h3 iddelete-parameters>Delete parameters/h3>p>DELETE code>https://api.epsilon3.io/v1/telemetry/parameters/code>/p>blockquote>p>Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ids/span>span classp>:/span>span classw> /span>span classerr>array/span>span classw> /span>span classerr>(integer)/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Request Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>ids/span>span classp>:/span>span classw> /span>span classp>/span>span classmi>123/span>span classp>,/span>span classw> /span>span classmi>456/span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>aside classsuccess>If successful, the response body is empty./aside>h1 idtest-management-api>Test Management API/h1>h2 idconditions>Conditions/h2>h3 idlist-conditions>List Conditions/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/testing/conditions/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/testing/conditions span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/testing/conditions/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/testing/conditions/code>/p>p>Retrieve all conditions defined in your workspace./p>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>089dab71-f13a-43b1-a350-481c873129f1/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Speed/span>span classp>,/span>span classw> /span>span classnl>units/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classs2>MPH/span>span classp>,/span>span classw> /span>span classs2>KPH/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>.../span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idget-condition>Get Condition/h3>p>GET code>https://api.epsilon3.io/v1/testing/conditions/:id/code>/p>p>Retrieve a single condtion using its ID./p>p>strong>Parameters/strong>/p>ul>li>code>id/code> (path parameter): ID of the condtion being retrieved./li>/ul>blockquote>p>Example Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>GET https://api.epsilon3.io/v1/testing/conditions/089dab71-f13a-43b1-a350-481c873129f1/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>089dab71-f13a-43b1-a350-481c873129f1/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Speed/span>span classp>,/span>span classw> /span>span classnl>units/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classs2>MPH/span>span classp>,/span>span classw> /span>span classs2>KPH/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idhazards>Hazards/h2>h3 idlist-hazards>List Hazards/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/testing/risks/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/testing/risks span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/testing/risks/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/testing/risks/code>/p>p>Retrieve all hazards defined in your workspace./p>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>f2161547-615e-4959-a989-91f3627d20d1/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Altitude Loss/span>span classp>,/span>span classw> /span>span classnl>cause/span>span classp>:/span>span classw> /span>span classs2>Stall/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>Work in progress/span>span classp>,/span>span classw> /span>span classnl>effect/span>span classp>:/span>span classw> /span>span classs2>Inadequate altitude for recovery/span>span classp>,/span>span classw> /span>span classnl>category/span>span classp>:/span>span classw> /span>span classs2>Mechanical/span>span classp>,/span>span classw> /span>span classnl>severity/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classnl>probability/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>mitigation/span>span classp>:/span>span classw> /span>span classs2>Experienced Test Pilot: Ensure a highly skilled test pilot with experience in stall recovery is at the controls. Safety Equipment: Ensure the aircraft is equipped with safety features, such as a stall warning system, to aid in stall recovery./span>span classp>,/span>span classw> /span>span classnl>updated_at/span>span classp>:/span>span classw> /span>span classs2>2024-01-24T21:00:39.421Z/span>span classp>,/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>.../span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idget-hazard>Get Hazard/h3>p>GET code>https://api.epsilon3.io/v1/testing/risks/:id/code>/p>p>Retrieve a single hazard using its ID./p>p>strong>Parameters/strong>/p>ul>li>code>id/code> (path parameter): ID of the hazard being retrieved./li>/ul>blockquote>p>Example Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>GET https://api.epsilon3.io/v1/testing/risks/f2161547-615e-4959-a989-91f3627d20d1/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>f2161547-615e-4959-a989-91f3627d20d1/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Altitude Loss/span>span classp>,/span>span classw> /span>span classnl>cause/span>span classp>:/span>span classw> /span>span classs2>Stall/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>Work in progress/span>span classp>,/span>span classw> /span>span classnl>effect/span>span classp>:/span>span classw> /span>span classs2>Inadequate altitude for recovery/span>span classp>,/span>span classw> /span>span classnl>category/span>span classp>:/span>span classw> /span>span classs2>Mechanical/span>span classp>,/span>span classw> /span>span classnl>severity/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classnl>probability/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>mitigation/span>span classp>:/span>span classw> /span>span classs2>Experienced Test Pilot: Ensure a highly skilled test pilot with experience in stall recovery is at the controls. Safety Equipment: Ensure the aircraft is equipped with safety features, such as a stall warning system, to aid in stall recovery./span>span classp>,/span>span classw> /span>span classnl>updated_at/span>span classp>:/span>span classw> /span>span classs2>2024-01-24T21:00:39.421Z/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idlist-hazard-versions>List Hazard Versions/h3>p>GET code>https://api.epsilon3.io/v1/testing/risks/:id/versions/code>/p>p>Retrieve all the versions for a hazard./p>p>strong>Parameters/strong>/p>ul>li>code>id/code> (path parameter): ID of the hazard being retrieved./li>/ul>blockquote>p>Example Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>GET https://api.epsilon3.io/v1/testing/risks/f2161547-615e-4959-a989-91f3627d20d1/versions/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>123/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classw> /span>span classs2>2024-01-24T21:00:39.421Z/span>span classp>,/span>span classw> /span>span classnl>record/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>f2161547-615e-4959-a989-91f3627d20d1/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Altitude Loss/span>span classp>,/span>span classw> /span>span classnl>cause/span>span classp>:/span>span classw> /span>span classs2>Stall/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>Work in progress/span>span classp>,/span>span classw> /span>span classnl>effect/span>span classp>:/span>span classw> /span>span classs2>Inadequate altitude for recovery/span>span classp>,/span>span classw> /span>span classnl>category/span>span classp>:/span>span classw> /span>span classs2>Mechanical/span>span classp>,/span>span classw> /span>span classnl>severity/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classnl>probability/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>mitigation/span>span classp>:/span>span classw> /span>span classs2>Experienced Test Pilot: Ensure a highly skilled test pilot with experience in stall recovery is at the controls. Safety Equipment: Ensure the aircraft is equipped with safety features, such as a stall warning system, to aid in stall recovery./span>span classp>,/span>span classw> /span>span classnl>updated_at/span>span classp>:/span>span classw> /span>span classs2>2024-01-24T21:00:39.421Z/span>span classp>,/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>.../span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idget-hazard-version>Get Hazard Version/h3>p>GET code>https://api.epsilon3.io/v1/testing/risks/:id/versions/:versionId/code>/p>p>Retrieve a single version for a hazard./p>p>strong>Parameters/strong>/p>ul>li>code>id/code> (path parameter): ID of the hazard being retrieved./li>li>code>versionId/code> (path parameter): ID of the version being retrieved./li>/ul>blockquote>p>Example Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>GET https://api.epsilon3.io/v1/testing/risks/f2161547-615e-4959-a989-91f3627d20d1/versions/123/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>123/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classw> /span>span classs2>2024-01-24T21:00:39.421Z/span>span classp>,/span>span classw> /span>span classnl>record/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>f2161547-615e-4959-a989-91f3627d20d1/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Altitude Loss/span>span classp>,/span>span classw> /span>span classnl>cause/span>span classp>:/span>span classw> /span>span classs2>Stall/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>Work in progress/span>span classp>,/span>span classw> /span>span classnl>effect/span>span classp>:/span>span classw> /span>span classs2>Inadequate altitude for recovery/span>span classp>,/span>span classw> /span>span classnl>category/span>span classp>:/span>span classw> /span>span classs2>Mechanical/span>span classp>,/span>span classw> /span>span classnl>severity/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classnl>probability/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>mitigation/span>span classp>:/span>span classw> /span>span classs2>Experienced Test Pilot: Ensure a highly skilled test pilot with experience in stall recovery is at the controls. Safety Equipment: Ensure the aircraft is equipped with safety features, such as a stall warning system, to aid in stall recovery./span>span classp>,/span>span classw> /span>span classnl>updated_at/span>span classp>:/span>span classw> /span>span classs2>2024-01-24T21:00:39.421Z/span>span classp>,/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idtest-points>Test Points/h2>h3 idlist-test-points>List Test Points/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/testing/cases/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/testing/cases span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/testing/cases/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/testing/cases/code>/p>p>Retrieve all test points defined in your workspace./p>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>f2161547-615e-4959-a989-91f3627d20d1/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Cruise/span>span classp>,/span>span classw> /span>span classnl>test_case_conditions/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Speed/span>span classp>,/span>span classw> /span>span classnl>units/span>span classp>:/span>span classw> /span>span classs2>MPH/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classs2>22/span>span classp>,/span>span classw> /span>span classnl>condition_id/span>span classp>:/span>span classw> /span>span classs2>089dab71-f13a-43b1-a350-481c873129f1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>.../span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idget-test-point>Get Test Point/h3>p>GET code>https://api.epsilon3.io/v1/testing/cases/:id/code>/p>p>Retrieve a single test point using its ID./p>p>strong>Parameters/strong>/p>ul>li>code>id/code> (path parameter): ID of the test point being retrieved./li>/ul>blockquote>p>Example Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>GET https://api.epsilon3.io/v1/testing/cases/f2161547-615e-4959-a989-91f3627d20d1/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>f2161547-615e-4959-a989-91f3627d20d1/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Cruise/span>span classp>,/span>span classw> /span>span classnl>test_case_conditions/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Speed/span>span classp>,/span>span classw> /span>span classnl>units/span>span classp>:/span>span classw> /span>span classs2>MPH/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classs2>22/span>span classp>,/span>span classw> /span>span classnl>condition_id/span>span classp>:/span>span classw> /span>span classs2>089dab71-f13a-43b1-a350-481c873129f1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>risks/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>list/span>span classw> /span>span classerr>of/span>span classw> /span>span classerr>associated/span>span classw> /span>span classerr>hazards/span>span classw> /span>span classnl>requirements/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>list/span>span classw> /span>span classerr>of/span>span classw> /span>span classerr>associated/span>span classw> /span>span classerr>requirements/span>span classw> /span>span classnl>runs/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>list/span>span classw> /span>span classerr>of/span>span classw> /span>span classerr>associated/span>span classw> /span>span classerr>runs/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idlist-test-point-versions>List Test Point Versions/h3>p>GET code>https://api.epsilon3.io/v1/testing/cases/:id/versions/code>/p>p>Retrieve all the versions for a test point./p>p>strong>Parameters/strong>/p>ul>li>code>id/code> (path parameter): ID of the test point being retrieved./li>/ul>blockquote>p>Example Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>GET https://api.epsilon3.io/v1/testing/cases/f2161547-615e-4959-a989-91f3627d20d1/versions/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>123/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classw> /span>span classs2>2024-01-24T21:00:39.421Z/span>span classp>,/span>span classw> /span>span classnl>record/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>f2161547-615e-4959-a989-91f3627d20d1/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Cruise/span>span classp>,/span>span classw> /span>span classnl>test_case_conditions/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Speed/span>span classp>,/span>span classw> /span>span classnl>units/span>span classp>:/span>span classw> /span>span classs2>MPH/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classs2>22/span>span classp>,/span>span classw> /span>span classnl>condition_id/span>span classp>:/span>span classw> /span>span classs2>089dab71-f13a-43b1-a350-481c873129f1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>.../span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idget-test-point-version>Get Test Point Version/h3>p>GET code>https://api.epsilon3.io/v1/testing/cases/:id/versions/:versionId/code>/p>p>Retrieve a single version for a test point./p>p>strong>Parameters/strong>/p>ul>li>code>id/code> (path parameter): ID of the test point being retrieved./li>li>code>versionId/code> (path parameter): ID of the version being retrieved./li>/ul>blockquote>p>Example Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>GET https://api.epsilon3.io/v1/testing/cases/f2161547-615e-4959-a989-91f3627d20d1/versions/123/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>123/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classw> /span>span classs2>2024-01-24T21:00:39.421Z/span>span classp>,/span>span classw> /span>span classnl>record/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>f2161547-615e-4959-a989-91f3627d20d1/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Cruise/span>span classp>,/span>span classw> /span>span classnl>test_case_conditions/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Speed/span>span classp>,/span>span classw> /span>span classnl>units/span>span classp>:/span>span classw> /span>span classs2>MPH/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classs2>22/span>span classp>,/span>span classw> /span>span classnl>condition_id/span>span classp>:/span>span classw> /span>span classs2>089dab71-f13a-43b1-a350-481c873129f1/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h2 idrequirements>Requirements/h2>h3 idlist-requirements>List Requirements/h3>blockquote>p>Sample Request/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classkn>import/span> span classnn>os/span>span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span> span classn>url/span>span classo>/span>span classs>https://api.epsilon3.io/v1/testing/requirements/span>span classp>,/span> span classn>auth/span>span classo>/span>span classp>(/span>span classn>os/span>span classp>./span>span classn>environ/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>EPSILON3_API_KEY/span>span classp>),/span> span classs>/span>span classp>)/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET span classse>\/span> https://api.epsilon3.io/v1/testing/requirements span classse>\/span> span classnt>-u/span> span classs2>/span>span classnv>$EPSILON3_API_KEY/span>span classs2>/span>:/code>/pre>/div>div classhighlight>pre classhighlight powershell tab-powershell>code>span classnv>$apiUrl/span>span classw> /span>span classo>/span>span classw> /span>span classs2>https://api.epsilon3.io/v1/testing/requirements/span>span classw>/span>span classnv>$apiKey/span>span classw> /span>span classo>/span>span classw> /span>span classnv>$/span>span classnn>env/span>span classp>:/span>span classnv>EPSILON3_API_KEY/span>span classw>/span>span classnv>$authHeader/span>span classw> /span>span classo>/span>span classw> /span>span classp>/span>span classn>Convert/span>span classp>::/span>span classn>ToBase64String/span>span classp>(/span>span classn>Text.Encoding/span>span classp>::/span>span classn>ASCII.GetBytes/span>span classp>(/span>span classs2>/span>span classnv>$apiKey/span>span classs2>:/span>span classp>))/span>span classw>/span>span classnv>$headers/span>span classw> /span>span classo>/span>span classw> /span>span classp>@{/span>span classw> /span>span classs2>Authorization/span>span classw> /span>span classo>/span>span classw> /span>span classs2>Basic /span>span classnv>$authHeader/span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>span classn>Invoke-RestMethod/span>span classw> /span>span classnt>-Uri/span>span classw> /span>span classnv>$apiUrl/span>span classw> /span>span classnt>-Method/span>span classw> /span>span classnx>Get/span>span classw> /span>span classnt>-Headers/span>span classw> /span>span classnv>$headers/span>span classw>/span>/code>/pre>/div>p>GET code>https://api.epsilon3.io/v1/testing/requirements/code>/p>p>Retrieve all requirements defined in your workspace./p>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>6be45049-ed63-4d53-b839-a0a719f94be9/span>span classp>,/span>span classw> /span>span classnl>custom_id/span>span classp>:/span>span classw> /span>span classs2>A-100/span>span classp>,/span>span classw> /span>span classnl>position/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>text/span>span classp>:/span>span classw> /span>span classs2>The aircraft should be a commercial passenger airplane designed for carrying passengers and cargo./span>span classp>,/span>span classw> /span>span classnl>priority/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>High/span>span classp>,/span>span classw> /span>span classnl>color/span>span classp>:/span>span classw> /span>span classs2>red-200/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>secondary/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>This is not a military aircraft./span>span classw> /span>span classp>},/span>span classw> /span>span classerr>.../span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idget-requirement>Get Requirement/h3>p>GET code>https://api.epsilon3.io/v1/testing/requirements/:id/code>/p>p>Retrieve a single requirement using its ID./p>p>strong>Parameters/strong>/p>ul>li>code>id/code> (path parameter): ID of the requirement being retrieved./li>/ul>blockquote>p>Example Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>GET https://api.epsilon3.io/v1/testing/requirements/6be45049-ed63-4d53-b839-a0a719f94be9/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>6be45049-ed63-4d53-b839-a0a719f94be9/span>span classp>,/span>span classw> /span>span classnl>custom_id/span>span classp>:/span>span classw> /span>span classs2>A-100/span>span classp>,/span>span classw> /span>span classnl>position/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>text/span>span classp>:/span>span classw> /span>span classs2>The aircraft should be a commercial passenger airplane designed for carrying passengers and cargo./span>span classp>,/span>span classw> /span>span classnl>priority/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>High/span>span classp>,/span>span classw> /span>span classnl>color/span>span classp>:/span>span classw> /span>span classs2>red-200/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>secondary/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>This is not a military aircraft./span>span classp>,/span>span classw> /span>span classnl>cases/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>list/span>span classw> /span>span classerr>of/span>span classw> /span>span classerr>associated/span>span classw> /span>span classerr>test/span>span classw> /span>span classerr>points/span>span classw> /span>span classnl>source_links/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>list/span>span classw> /span>span classerr>of/span>span classw> /span>span classerr>associated/span>span classw> /span>span classerr>requirements/span>span classw> /span>span classerr>this/span>span classw> /span>span classerr>requirement/span>span classw> /span>span classerr>is/span>span classw> /span>span classerr>a/span>span classw> /span>span classerr>source/span>span classw> /span>span classerr>of/span>span classw> /span>span classnl>target_links/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>list/span>span classw> /span>span classerr>of/span>span classw> /span>span classerr>associated/span>span classw> /span>span classerr>requirements/span>span classw> /span>span classerr>that/span>span classw> /span>span classerr>target/span>span classw> /span>span classerr>this/span>span classw> /span>span classerr>requirement/span>span classw> /span>span classnl>attachments/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>list/span>span classw> /span>span classerr>of/span>span classw> /span>span classerr>attachment/span>span classw> /span>span classerr>metadata/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idlist-requirement-versions>List Requirement Versions/h3>p>GET code>https://api.epsilon3.io/v1/testing/requirements/:id/versions/code>/p>p>Retrieve all the versions for a requirement./p>p>strong>Parameters/strong>/p>ul>li>code>id/code> (path parameter): ID of the requirement being retrieved./li>/ul>blockquote>p>Example Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>GET https://api.epsilon3.io/v1/testing/requirements/6be45049-ed63-4d53-b839-a0a719f94be9/versions/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>123/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classw> /span>span classs2>2024-01-24T21:00:39.421Z/span>span classp>,/span>span classw> /span>span classnl>record/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>6be45049-ed63-4d53-b839-a0a719f94be9/span>span classp>,/span>span classw> /span>span classnl>custom_id/span>span classp>:/span>span classw> /span>span classs2>A-100/span>span classp>,/span>span classw> /span>span classnl>position/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>text/span>span classp>:/span>span classw> /span>span classs2>The aircraft should be a commercial passenger airplane designed for carrying passengers and cargo./span>span classp>,/span>span classw> /span>span classnl>priority/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>High/span>span classp>,/span>span classw> /span>span classnl>color/span>span classp>:/span>span classw> /span>span classs2>red-200/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>secondary/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>This is not a military aircraft./span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classerr>.../span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h3 idget-requirement-version>Get Requirement Version/h3>p>GET code>https://api.epsilon3.io/v1/testing/requirements/:id/versions/:versionId/code>/p>p>Retrieve a single version for a requirement./p>p>strong>Parameters/strong>/p>ul>li>code>id/code> (path parameter): ID of the requirement being retrieved./li>li>code>versionId/code> (path parameter): ID of the version being retrieved./li>/ul>blockquote>p>Example Request URL/p>/blockquote>div classhighlight>pre classhighlight plaintext>code>GET https://api.epsilon3.io/v1/testing/requirements/6be45049-ed63-4d53-b839-a0a719f94be9/versions/123/code>/pre>/div>blockquote>p>Example Response Body/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>123/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classw> /span>span classs2>2024-01-24T21:00:39.421Z/span>span classp>,/span>span classw> /span>span classnl>record/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>6be45049-ed63-4d53-b839-a0a719f94be9/span>span classp>,/span>span classw> /span>span classnl>custom_id/span>span classp>:/span>span classw> /span>span classs2>A-100/span>span classp>,/span>span classw> /span>span classnl>position/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>text/span>span classp>:/span>span classw> /span>span classs2>The aircraft should be a commercial passenger airplane designed for carrying passengers and cargo./span>span classp>,/span>span classw> /span>span classnl>priority/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>High/span>span classp>,/span>span classw> /span>span classnl>color/span>span classp>:/span>span classw> /span>span classs2>red-200/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>secondary/span>span classp>,/span>span classw> /span>span classnl>notes/span>span classp>:/span>span classw> /span>span classs2>This is not a military aircraft./span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div> /div> div classdark-box> div classlang-selector> a href# data-language-namepython>python/a> a href# data-language-nameshell>shell/a> a href# data-language-namepowershell>powershell/a> /div> /div> /div> div classpage-wrapper> div classdark-box>/div> div classcontent> h1 idrealtime-introduction>Realtime Introduction/h1>p>Epsilon3, facilitates seamless real-time data exchange to integrate with anythird party software platform through the use of the socketIO and webhook communication protocols./p>p>The following modules are currently supported/p>ul>li>Commanding/li>li>External Data/li>li>Notifications/li>li>Telemetry/li>/ul>p>Epsilon3 provides sample python clients that contain all the core logic needed to connect to Epsilon3 system so thatonly custom integration logic needs to be added./p>h2 idgetting-started>Getting Started/h2>h3 iddownload-sample-client>Download Sample Client/h3>ul>li>a hrefhttps://docs.epsilon3.io/examples/client-python-socketio.tar.gz>SocketIO Client/a>/li>li>a hrefhttps://docs.epsilon3.io/examples/client-python-webhooks.tar.gz>Webhooks Client/a>/li>/ul>h3 idset-environment-variables>Set Environment Variables/h3>blockquote>p>Add your API key as an environment variable/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classn>export/span> span classn>EPSILON3_API_KEY/span>span classo>/span>span classn>your_api_key/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>span classnb>export /span>span classnv>EPSILON3_API_KEY/span>span classo>/span>your_api_key/code>/pre>/div>blockquote>p>(Optional) If you are in the United Kingdom instance you will also need to set the correct URL/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classn>export/span> span classn>EPSILON3_API_URL/span>span classo>/span>span classs>https://api.uk.epsilon3.io/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>span classnb>export /span>span classnv>EPSILON3_API_URL/span>span classo>/span>span classs1>https://api.uk.epsilon3.io/span>/code>/pre>/div>blockquote>p>(Optional) If using the Webhook version you will also need to add your webhook key as an environment variable/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classn>export/span> span classn>EPSILON3_WEBHOOK_KEY/span>span classo>/span>span classn>your_webhook_key/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>span classnb>export /span>span classnv>EPSILON3_WEBHOOK_KEY/span>span classo>/span>your_webhook_key/code>/pre>/div>p>Note: Webhook key registration necessary, contact Epsilon3 support for assistance./p>h3 idwebhook-signature-verification>Webhook signature verification/h3>p>Epsilon3 provides a python module called webhook_auth for verifying that requests sent to your webhooks come from Epsilon3 and not a third party./p>p>Perform signature verification by passing your webhook secret key, the request payload, and the Epsilon3-Signature header to the provided function verify_webhook_signature. This function will return True if the signature can be verified, and False otherwise./p>p>For additional information regarding webhook signature verification or if you’d like to verify webhook signatures manually, please contact Epsilon3 for support./p>h3 idrun-the-application>Run the Application/h3>blockquote>p>In a terminal window navigate to the directory where the Realtime Client was downloaded,unzip it and then navigate into it. e.g./p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classn>cd/span> span classn>client/span>span classo>-/span>span classn>python/span>span classo>-/span>span classn>socketio/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>span classnb>cd /span>client-python-socketio/code>/pre>/div>blockquote>p>Install project dependencies/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classn>pipenv/span> span classn>install/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>pipenv span classnb>install/span>/code>/pre>/div>blockquote>p>Activate the project's python environment/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classn>pipenv/span> span classn>shell/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>pipenv shell/code>/pre>/div>blockquote>p>Run the application/p>p>SocketIO version/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classn>python/span> span classn>app/span>span classp>./span>span classn>py/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>python app.py/code>/pre>/div>blockquote>p>Webhook version/p>/blockquote>div classhighlight>pre classhighlight python tab-python>code>span classn>flask/span> span classn>aiorun/span>/code>/pre>/div>div classhighlight>pre classhighlight shell tab-shell>code>flask aiorun/code>/pre>/div>h1 idcommanding>Commanding/h1>p>For information on creating commands to use within a procedure please see the a href#commanding-api>Commanding API Section/a>/p>p>Commands can be synchronous or asynchronous depending on the property code>correlation_id/code>. If missing, the command is treated as synchronous with a default maximum expiration of 55 seconds, otherwise the expiration is what was set on command creation. Useful for commands with long execution times./p>h2 idlisten-for-a-command-in-real-time>Listen for a command in real-time/h2>blockquote>p>Example Request/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>test.pressure.level/span>span classp>,/span>span classw> /span>span classnl>dictionary_id/span>span classp>:/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw> /span>span classnl>arguments/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>psi/span>span classp>:/span>span classw> /span>span classmf>7.8/span>span classp>,/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>operation/span>span classp>:/span>span classw> /span>span classs2>To infinity and beyond!/span>span classp>,/span>span classw> /span>span classnl>variables/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>test.variable1/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>test.variable1/span>span classp>,/span>span classw> /span>span classnl>input_type/span>span classp>:/span>span classw> /span>span classs2>text/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classs2>hello world/span>span classp>,/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>test.variable2/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>test.variable2/span>span classp>,/span>span classw> /span>span classnl>input_type/span>span classp>:/span>span classw> /span>span classs2>number/span>span classp>,/span>span classw> /span>span classp>},/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>metadata/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>user/span>span classp>:/span>span classw> /span>span classs2>test@epsilon3.io/span>span classp>,/span>span classw> /span>span classnl>run_id/span>span classp>:/span>span classw> /span>span classs2>QoxCWp4C6kSY5xWUmKj0ye/span>span classp>,/span>span classw> /span>span classnl>run_starttime/span>span classp>:/span>span classw> /span>span classs2>2022-12-25T22:34:53.623Z/span>span classp>,/span>span classw> /span>span classnl>procedure_code/span>span classp>:/span>span classw> /span>span classs2>Launch123/span>span classp>,/span>span classw> /span>span classnl>procedure_name/span>span classp>:/span>span classw> /span>span classs2>alpha/span>span classp>,/span>span classw> /span>span classnl>procedure_version/span>span classp>:/span>span classw> /span>span classs2>1.3a/span>span classp>,/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>correlation_id/span>span classp>:/span>span classw> /span>span classs2>team123-run456-section789-step012-block345-user678/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>The SocketIO/Webhook clients provide different namespaces to use websockets more efficiently and provide separate communication channels. For real-time commanding, clients can listen for:/p>p>Namespace code>/v1/commands/realtime/code>/p>p>Event name code>send_command/code>/p>p>Once a SocketIO or Webhook client is running, they will receive real-time requests to execute commands triggered from running procedures./p>h3 idclient-request>Client Request/h3>p>The request payload contains the following:/p>ul>li>code>name/code> The command name/li>li>code>dictionary_id/code> (Optional) the id of the command dictionary. When not specified, the default dictionary is used./li>li>code>arguments/code> (Optional) A dictionary of command arguments/li>li>code>operation/code> (Optional) The name of the operation the run belongs to/li>li>code>variables/code> (Optional) A dictionary of the procedure variables and their values, if present in the current run/li>li>code>metadata/code> High level information related to the procedure/li>li>code>correlation_id/code> (Optional) ID of command that must be returned with response for asynchronous commands/li>/ul>h3 idclient-response>Client Response/h3>h4 idsynchronous-commands>Synchronous Commands/h4>blockquote>p>Example Response (Synchronous)/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>test.pressure.level/span>span classp>,/span>span classw> /span>span classnl>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>received_at/span>span classp>:/span>span classw> /span>span classs2>2022-12-25T22:34:53.623Z/span>span classp>,/span>span classw> /span>span classnl>message/span>span classp>:/span>span classw> /span>span classs2>Pressure level tested/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h4 idasynchronous-commands>Asynchronous Commands/h4>blockquote>p>Example Request (Asynchronous)/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>executing/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>success/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>failure/span>span classw> /span>span classerr>|/span>span classw> /span>span classs2>timeout/span>span classp>,/span>span classw> /span>span classnl>correlation_id/span>span classp>:/span>span classw> /span>span classs2>team123-run456-section789-step012-block345-user678/span>span classp>,/span>span classw> /span>span classnl>results/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>test.pressure.level/span>span classp>,/span>span classw> /span>span classnl>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>received_at/span>span classp>:/span>span classw> /span>span classs2>2022-12-25T22:34:53.623Z/span>span classp>,/span>span classw> /span>span classnl>message/span>span classp>:/span>span classw> /span>span classs2>Pressure level tested/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>completed_at/span>span classp>:/span>span classw> /span>span classs2>2022-12-25T22:34:53.623Z/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>Asynchronous commands are identified by the presence of a code>correlation_id/code> field in the request. The execution flow is:/p>ol>li>strong>Immediate Response/strong>: Return code>{"status": "executing"}/code> immediately upon receiving the command/li>li>strong>Background Execution/strong>: Process the command asynchronously /li>li>strong>Completion Event/strong>: Send the final results via the code>command_finished/code> event/li>/ol>p>For strong>SocketIO clients/strong>, send completion via:code>pythonawait io.emit('command_finished', finished_response, namespace'/v1/commands/realtime')/code>/p>h3 idcommand-timeout>Command Timeout/h3>p>Commands with code>expiration_seconds/code> will automatically timeout if not completed within the specified duration. When a timeout occurs:/p>ul>li>The command is marked as failed in Epsilon3/li>li>No further completion events are processed for that correlation ID/li>/ul>h3 idlimitations>Limitations/h3>ul>li>Maximum timeout: 18000 seconds (5 hours)/li>li>Commands cannot be cancelled once started (except via timeout)/li>li>Async commands require correlation ID tracking for proper completion handling/li>li>Page refresh will not interrupt running commands, but UI state is preserved/li>/ul>h1 idexternal-data>External Data/h1>p>For information on creating external data items to use within a procedure please see the a href#external-data-api>External Data API Section/a>/p>h2 idlisten-for-real-time-requests-for-external-data>Listen for real-time requests for external data/h2>p>The sample clients provide different namespaces to use websockets more efficiently and provide separate communication channels. For real-time external data, clients can listen for:/p>p>Namespace code>/v1/external-data/items/code>/p>p>Event names code>search/code> and code>item/code>/p>p>Once a SocketIO or Webhook client is running, they will receive real-time requests triggered from procedures to retrieve external data./p>h3 idclient-request>Client Request/h3>blockquote>p>Example Request/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>work_order/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>External/span>span classw> /span>span classerr>Data/span>span classw> /span>span classerr>Item/span>span classw> /span>span classerr>type/span>span classw> /span>span classerr>to/span>span classw> /span>span classerr>query/span>span classw> /span>span classnl>term/span>span classp>:/span>span classw> /span>span classs2>1234/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>Query/span>span classw> /span>span classerr>search/span>span classw> /span>span classerr>string/span>span classw> /span>span classnl>dictionary_id/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>metadata/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>user/span>span classp>:/span>span classw> /span>span classs2>test@epsilon3.io/span>span classp>,/span>span classw> /span>span classnl>run_id/span>span classp>:/span>span classw> /span>span classs2>QoxCWp4C6kSY5xWUmKj0ye/span>span classp>,/span>span classw> /span>span classnl>run_starttime/span>span classp>:/span>span classw> /span>span classs2>2022-12-25T22:34:53.623Z/span>span classp>,/span>span classw> /span>span classnl>procedure_code/span>span classp>:/span>span classw> /span>span classs2>Launch123/span>span classp>,/span>span classw> /span>span classnl>procedure_name/span>span classp>:/span>span classw> /span>span classs2>alpha/span>span classp>,/span>span classw> /span>span classnl>procedure_version/span>span classp>:/span>span classw> /span>span classs2>1.3a/span>span classp>,/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>The request argument is an object containing the external data item type to query, the dictionaryId and a query search string./p>h3 idclient-response>Client Response/h3>blockquote>p>Example Response/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>places/span>span classerr>,/span>span classw>/span>span classnl>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classerr>,/span>span classw>/span>span classnl>message/span>span classp>:/span>span classw> /span>span classs2>Items located./span>span classerr>,/span>span classw>/span>span classnl>items/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>unique id/span>span classp>,/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Locations/span>span classp>,/span>span classw> /span>span classnl>label/span>span classp>:/span>span classw> /span>span classs2>Fun places/span>span classp>,/span>span classw> /span>span classnl>url/span>span classp>:/span>span classw> /span>span classs2>https://www.epsilon3.io/span>span classp>,/span>span classw> /span>span classnl>valid/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classnl>details/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>City/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classs2>Milwaukee/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>State/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classs2>Wisconsin/span>span classw> /span>span classp>},/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>span classp>/span>span classw>/span>/code>/pre>/div>p>The client should return an object which contains/p>ul>li>code>type/code> (Required) The External Data Item “key” to query/li>li>code>success/code> (Required) A boolean flag indicating whether the client properly received and understood the request/li>li>code>message/code> (Optional) A field used for additional information, e.g., details why “success” is false/li>li>code>items/code> (Required) A list of External Data Item objects matching the search criteria with the following structure:ul>li>code>id/code> (required) A unique identifier for the data item/li>li>code>name/code> (Required) This field is used for displaying the item alongside the id, if present/li>li>code>label/code> (Optional) This provides a custom label for displaying the item, and will override the id/name fields for display/selection purposes/li>li>code>url/code> (Optional) This field is used for storing a url/li>li>code>valid/code> (Optional) This field indicates to the end user if the item is valid or not. When unspecified this item will default to valid (true)/li>li>code>details/code> (Optional) This contains an array of key/value pairs to be associated with the data item. Each pair should contain a “name” as the key and “value” as the value/li>/ul>/li>/ul>aside classwarning>It is up to the client’s discretion to determine what the search algorithm should be and how to incorporate dictionaryId, with the exception of an empty term should return all items./aside>h1 idnotifications>Notifications/h1>p>The sample clients provide different namespaces to use websockets more efficiently and provide separate communication channels. For real-time notifications, clients can listen for:/p>p>Namespace code>/v1/notifications/realtime/code>/p>p>Event name code>notification/code>/p>p>Event subtypes/p>ul>li>code>remaining_step_operators/code>/li>li>code>run_ended/code>/li>li>code>reviewers/code>/li>li>code>automation/code>/li>/ul>p>Once a socketIO or Webhook client is running, they will receive real-time requests triggered from procedures to send notifications./p>h2 idsending-notifications>Sending notifications/h2>p>Notifications can be manually triggered in any running Epsilon3 procedure by clicking the notification button to the left of a step’s signoff buttons./p>p>img srcimages/notifications1-9eb806bd.png alt />/p>aside classwarning>NOTE: Notification buttons are only available when a notification listener is connected to the current workspace and a step requires specific operator roles to signoff./aside>p>The returned object is a response object containing a single code>received/code> property to indicate whether the notification was successfully processed by the client. A code>{'received': True}/code> response is reflected in Epsilon3 by a success indicator. A code>{'received': False}/code> response or a lack of response from any client is reflected in Epsilon3 by a failure indicator./p>h3 idsuccess-indicator>Success Indicator/h3>p>img srcimages/notifications2-f0784506.png alt />/p>h3 idfailure-indicator>Failure Indicator/h3>p>img srcimages/notifications3-d0f5390b.png alt />/p>h2 idnotification-objects>Notification Objects/h2>p>Notification event objects are received by a listener when a notification is emitted by the connected Epsilon3 workspace./p>blockquote>p>Notification Object/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>subtype/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classerr>timestamp/span>span classw> /span>span classerr>in/span>span classw> /span>span classerr>ISO/span>span classmi>-8601/span>span classw> /span>span classerr>format/span>span classp>,/span>span classw> /span>span classnl>api_version/span>span classp>:/span>span classw> /span>span classerr>float/span>span classp>,/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>message/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>run_url/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>section_name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>step_name/span>span classp>:/span>span classw> /span>span classerr>string/span>span classp>,/span>span classw> /span>span classnl>users_to_notify/span>span classp>:/span>span classw> /span>span classerr>array/span>span classp>,/span>span classw> /span>span classnl>remaining_operator_roles/span>span classp>:/span>span classw> /span>span classerr>array/span>span classp>,/span>span classw> /span>span classnl>notification_source/span>span classp>:/span>span classw> /span>span classerr>string/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>blockquote>p>Example Notification Event Object/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>id/span>span classp>:/span>span classw> /span>span classs2>event_URyUS086KeBSJQcCgA9ENNihHzvKMvWu/span>span classp>,/span>span classw> /span>span classnl>type/span>span classp>:/span>span classw> /span>span classs2>notification/span>span classp>,/span>span classw> /span>span classnl>subtype/span>span classp>:/span>span classw> /span>span classs2>remaining_step_operators/span>span classp>,/span>span classw> /span>span classnl>timestamp/span>span classp>:/span>span classw> /span>span classs2>2022-08-18T19:48:57.608Z/span>span classp>,/span>span classw> /span>span classnl>api_version/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>message/span>span classp>:/span>span classw> /span>span classs2>A step is waiting for your signoff./span>span classp>,/span>span classw> /span>span classnl>run_url/span>span classp>:/span>span classw> /span>span classs2>https://app.epsilon3.io/runs/XmWQs0J3TfPDwQVJCAfJby/span>span classp>,/span>span classw> /span>span classnl>section_name/span>span classp>:/span>span classw> /span>span classs2>A/span>span classp>,/span>span classw> /span>span classnl>step_name/span>span classp>:/span>span classw> /span>span classs2>A1/span>span classp>,/span>span classw> /span>span classnl>users_to_notify/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classs2>user1@epsilon3.io/span>span classp>,/span>span classw> /span>span classs2>user2@epsilon3.io/span>span classw> /span>span classp>,/span>span classw> /span>span classnl>remaining_operator_roles/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>OP1/span>span classp>,/span>span classw> /span>span classnl>notification_source/span>span classp>:/span>span classw> /span>span classs2>user3@epsilon3.io/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>h1 idtelemetry>Telemetry/h1>p>For information on creating telemetry parameters to use within a procedure please see the a href#telemetry-api>Telemetry API Section/a>/p>h2 idreal-time-telemetry-namespace>Real-time Telemetry Namespace/h2>p>The sample clients provide different namespaces to use websockets more efficiently and provide separate communication channels. For real-time telemetry, clients use:/p>p>Namespace code>/v1/telemetry/realtime/code>/p>p>Once a SocketIO client is running, it will receive real-time requests triggered from procedures to retrieve telemetry parameters./p>h3 idstart-stream-event>Start Stream Event/h3>p>Event name code>start_stream/code>/p>blockquote>p>Example Request/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>test.simulation.error/span>span classp>,/span>span classw> /span>span classnl>stream_id/span>span classp>:/span>span classw> /span>span classs2>abc123/span>span classp>,/span>span classw> /span>span classnl>refresh_rate/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classnl>dictionary_id/span>span classp>:/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw> /span>span classnl>operation/span>span classp>:/span>span classw> /span>span classs2>To infinity and beyond!/span>span classp>,/span>span classw> /span>span classnl>variables/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>variable1/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>test.variable1/span>span classp>,/span>span classw> /span>span classnl>input_type/span>span classp>:/span>span classw> /span>span classs2>text/span>span classp>,/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classs2>hello world/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>variable2/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>test.variable2/span>span classp>,/span>span classw> /span>span classnl>input_type/span>span classp>:/span>span classw> /span>span classs2>number/span>span classw> /span>span classp>}/span>span classw> /span>span classp>},/span>span classw> /span>span classnl>metadata/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>user/span>span classp>:/span>span classw> /span>span classs2>test@epsilon3.io/span>span classp>,/span>span classw> /span>span classnl>run_id/span>span classp>:/span>span classw> /span>span classs2>QoxCWp4C6kSY5xWUmKj0ye/span>span classp>,/span>span classw> /span>span classnl>run_starttime/span>span classp>:/span>span classw> /span>span classs2>2022-12-25T22:34:53.623Z/span>span classp>,/span>span classw> /span>span classnl>procedure_code/span>span classp>:/span>span classw> /span>span classs2>Launch123/span>span classp>,/span>span classw> /span>span classnl>procedure_name/span>span classp>:/span>span classw> /span>span classs2>alpha/span>span classp>,/span>span classw> /span>span classnl>procedure_version/span>span classp>:/span>span classw> /span>span classs2>1.3a/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>Epsilon3 sends a code>start_stream/code> event when a procedure run requires streaming telemetry data. The request contains:/p>ul>li>code>name/code> the telemetry parameter name/li>li>code>stream_id/code> unique identifier for this stream, this needs to be returned with any data updates/li>li>code>refresh_rate/code> (optional) frequency in seconds to send updates (defaults to 1)/li>li>code>dictionary_id/code> (optional) the id of the parameter dictionary/li>li>code>operation/code> (optional) the name of the operation the run belongs to/li>li>code>variables/code> (optional) a dictionary of procedure variables and their values/li>li>code>metadata/code> array of information about runs requesting this telemetry parameter/li>/ul>h3 iddata-update-event>Data Update Event/h3>p>Event name code>data_update/code> (client emits to Epsilon3 server)/p>blockquote>p>Example Response/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>stream_id/span>span classp>:/span>span classw> /span>span classs2>abc123/span>span classp>,/span>span classw> /span>span classnl>data/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classnl>value/span>span classp>:/span>span classw> /span>span classmf>42.5/span>span classp>,/span>span classw> /span>span classnl>recorded_at/span>span classp>:/span>span classw> /span>span classs2>2022-12-25T22:34:53.623Z/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>Clients should periodically emit code>data_update/code> events with the latest telemetry values at the requested code>refresh_rate/code>. The response contains:/p>ul>li>code>stream_id/code> the stream identifier from the start_stream request/li>li>code>data/code> object containing:ul>li>code>value/code> the current value for the telemetry parameter/li>li>code>recorded_at/code> timestamp when the value was recorded (ISO-8601 format)/li>/ul>/li>/ul>h3 idend-streams-event>End Streams Event/h3>p>Event name code>end_streams/code>/p>blockquote>p>Example Request/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classnl>stream_ids/span>span classp>:/span>span classw> /span>span classp>/span>span classs2>abc123/span>span classp>,/span>span classw> /span>span classs2>def456/span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>Epsilon3 sends an code>end_streams/code> event when runs complete or no longer need telemetry data. Clients should stop streaming data for the specified stream IDs. The request contains:/p>ul>li>code>stream_ids/code> array of stream identifiers to terminate/li>/ul>h3 iddisconnect-event>Disconnect Event/h3>p>Event name code>disconnect/code>/p>p>Clients should handle the code>disconnect/code> event to clean up all active streams and reset state when the connection to the namespace is lost./p>h2 iderror-and-status-events>Error and Status Events/h2>h3 iderror-event>Error Event/h3>p>Event name code>error/code>/p>p>Epsilon3 emits error events when issues occur with telemetry streaming. Clients should handle these events to stop streaming and log error information./p>h3 idconnection-status-event>Connection Status Event/h3>p>Event name code>telemetry_connection_status/code>/p>p>Epsilon3 emits connection status events to provide diagnostics about:/p>ul>li>Dangling streams that should have been terminated/li>li>Exceeded rate limits/li>li>Other connection health information/li>/ul>p>Clients should monitor this event for operational insights and troubleshooting./p> /div> div classdark-box> div classlang-selector> a href# data-language-nameshell>shell/a> /div> /div> /div> /body>/html>
View on OTX
|
View on ThreatMiner
Please enable JavaScript to view the
comments powered by Disqus.
Data with thanks to
AlienVault OTX
,
VirusTotal
,
Malwr
and
others
. [
Sitemap
]