Skip to main content

Recently active topics

4
Andrea Downing
Andrea DowningSMA Community Team
 REST API
Sending Legacy Events via the API

The OpCon API provides a way to send legacy or external events, similar to traditional messaging events used in older versions of OpCon. This feature is useful for backward compatibility and for integrating with systems that still rely on legacy event formats.Use CasesTriggering legacy event handlers configured in OpCon. Sending console display messages for monitoring purposes. Integrating with external systems that use legacy event formats.Example RequestBelow is a PowerShell example that demonstrates how to send a legacy console display event using the OpCon API:$body = @{    events = @(        @{            id = "1"            eventType = "ConsoleDisplay"            message = "Legacy event triggered via API"        }    )} | ConvertTo-Json -Depth 3Invoke-RestMethod -Uri "$url/events/legacy" -Method Post -Body $body -ContentType "application/json" -Headers @{Authorization = $token} ConsiderationsThe API will confirm submission of the event but does not validate the success of the eve

10
Andrea Downing
Andrea Downing
Andrea DowningSMA Community Team
 REST API
Evaluating Expressions via the API

 The OpCon API provides a powerful endpoint for evaluating expressions, which is especially useful for testing property expressions, date formats, and conditional logic used in Self Service, job dependencies, and other automation scenarios.Why Use the Expression Evaluation Endpoint?This endpoint allows you to:Validate expression syntax before using it in production. Preview the evaluated result of date and property expressions. Test conditional logic used in disable/hide rules or job dependencies.Endpoint OverviewThe endpoint used for evaluating expressions is:POST /expressions/evaluateExample 1: Evaluating a Date ExpressionTo evaluate a date expression like `$DATE`, send the following JSON payload: {  "expression": "$DATE"}A successful response might look like:{  "expression": "$DATE",  "status": "Success",  "result": "2024-04-17"} Example 2: Evaluating a Conditional ExpressionYou can also evaluate logical expressions. For example:{  "expression": "$DAYOFWEEK == 'Monday'"}This will re

20
Andrea Downing
Andrea Downing
Andrea DowningSMA Community Team
 REST API
Adding Jobs to Schedules via the API

The OpCon API allows users to programmatically add jobs to schedules, enabling dynamic automation and integration with external systems. This guide provides a step-by-step overview of how to use the API to add jobs to schedules, including required fields and example requests. Required InformationTo add a job to a schedule using the API, you will need the following information:Schedule name or ID Job name or ID Frequency and instance details Any instance properties or overrides Authentication token with appropriate permissionsExample RequestBelow is an example of a POST request to the /schedule-actions endpoint to add a job to a schedule:POST /api/schedule-actions HTTP/1.1Host: your-opcon-serverAuthorization: Token your-auth-tokenContent-Type: application/json{  "scheduleName": "DailyProcessing",  "action": "AddJob",  "jobName": "DataImportJob",  "frequency": "Daily",  "instanceProperties": [    {      "name": "InputFile",      "value": "data_2024_01_01.csv"    }  ]}TipsEnsure the job a

80
Andrea Downing
jesnyder
jesnyder
 OpCon Wizards
Frequency Question

If I wanted to build a job on the 11th day(any) of a quarterly period after weekends or holidays.  What’s the best way to do that?  For example, a frequency that would build on the following days this year.01/13/202504/11/202507/14/202510/14/2025

635
jesnyder

Badge winners

Show all badges
Terms & ConditionsCookie settings