API docs by Redocly

OpCon REST API (24.3.0.0)

Download OpenAPI specification:Download

Welcome to the SMA OpCon REST API reference. Use this REST API to interact with the OpCon database.

AccessCodes

Gets a list of Access Codes based on optional criteria specified

Sample request (this returns a list of Access Codes by Name in descending order):

GET /api/accessCodes?sortBy=name:desc
Authorizations:
Token
query Parameters
IncludeCrossReferenceDailyJobs
boolean

Flag to include a list of Daily Jobs secured by the Access Code

IncludeCrossReferenceMasterJobs
boolean

Flag to include a list of Master Jobs secured by the Access Code

Name
string

The Access Code Name (Can accept ? and * wildcards)

Ids
string

Comma-separated list of Access Code Ids

Limit
integer <int32>

Limits the results being fetched. 0 retrieves just a count

Offset
integer <int32>

Retrieves records beginning at this record number

SortOrders
Array of strings
AccessibleCodes
Array of integers <int32> [ items <int32 > ]
SortBy
string

Option to sort Access Codes by Name in ascending (default) or descending (:desc) order

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new Access Code and returns it with its Id, if successful

Sample request:

POST /api/accessCodes
        
{
    "name": "Operator"
}
Authorizations:
Token
Request Body schema:
id
integer or null <int32>

The id of the access code

name
string or null

The name of the access code

description
string or null
Array of objects or null (OpCon.Api.Data.Entities.CrossReference.CrossReferenceDailyJob)
Array of objects or null (OpCon.Api.Data.Entities.CrossReference.CrossReferenceMasterJob)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "crossReferencesDailyJobs": [
    ],
  • "crossReferencesMasterJobs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "crossReferencesDailyJobs": [
    ],
  • "crossReferencesMasterJobs": [
    ]
}

Gets the Access Code with the specified Id

Sample request (this returns the Access Code with Id = 1):

GET /api/accessCodes/1
Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "crossReferencesDailyJobs": [
    ],
  • "crossReferencesMasterJobs": [
    ]
}

Updates the Access Code with the specified Id

Sample request (this updates the Access Code with Id = 1):

PUT /api/accessCodes/1
        
{
    "id": 1,
    "name": "Operator"
}
Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer or null <int32>

The id of the access code

name
string or null

The name of the access code

description
string or null
Array of objects or null (OpCon.Api.Data.Entities.CrossReference.CrossReferenceDailyJob)
Array of objects or null (OpCon.Api.Data.Entities.CrossReference.CrossReferenceMasterJob)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "crossReferencesDailyJobs": [
    ],
  • "crossReferencesMasterJobs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "crossReferencesDailyJobs": [
    ],
  • "crossReferencesMasterJobs": [
    ]
}

Deletes the Access Code with the specified Id

Sample request (this deletes the Access Code with Id = 1):

DELETE /api/accessCodes/1
Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

ACS

Gets a list of supported applications for this installation

Sample request:

GET api/acs/applications
Authorizations:
Token

Responses

Response samples

Content type
application/json
[
  • "string"
]

Gets a list of the names of all tasks which the specified application supports

Sample request:

GET api/acs/{application:string}/tasktypes
Authorizations:
Token
path Parameters
application
required
string

Responses

Gets the JSON schema defining the UI and the form data for a given framework integration as well as the current configuration values

Sample request:

POST /api/acs/rjsf
Authorizations:
Token
Request Body schema:
object (OpCon.Api.Data.Services.ACS.Models.ACSConfigData)
languages
Array of strings or null
isReadOnly
boolean

Responses

Request samples

Content type
{
  • "currentConfig": {
    },
  • "languages": [
    ],
  • "isReadOnly": true
}

Gets the JSON schema defining the UI and the form data for a given job type provided by the specified integration as well as the current config values. This call has side effects and can, if not set to read only, update machine records.

Sample request:

GET /api/acs/rjsf/task
Authorizations:
Token
Request Body schema:
object (OpCon.Api.Data.Services.ACS.Models.ACSTaskConfigData)
languages
Array of strings or null
isReadOnly
boolean
integrationIds
Array of integers or null <int32>

Responses

Request samples

Content type
{
  • "currentConfig": {
    },
  • "languages": [
    ],
  • "isReadOnly": true,
  • "integrationIds": [
    ]
}

Gets a list of Machines supported by the given application

Sample request: ** GET api/acs/{application:string}/{taskName:string}/machines

Authorizations:
Token
path Parameters
application
required
string
taskName
required
string

Responses

BatchUsers

Gets a list of Batch Users based on optional criteria specified

Sample request (this returns a list of Batch Users by Name in descending order): 

GET /api/batchUsers?sortby=name:desc
Authorizations:
Token
query Parameters
Ids
string

Comma-separated list of Batch User Ids

Limit
integer <int32>

Limits the results being fetched

Offset
integer <int32>

Retrieves records beginning at this record number

Platform
string

The Platform (Operating System) of the Batch User (Can accept ? and * wildcards)

PlatformId
integer <int32>

The Id of the Platform Type of the Batch User

RoleName
string

The Batch User Role Name (Can accept ? and * wildcards)

LoginName
string

The Batch User Login Name (Can accept ? and * wildcards)

IncludeRoles
boolean

Flag to include a list of Roles assigned to the Batch User

IncludeAssociations
boolean

Flag to include a list of Daily and Master Jobs to which the Batch User is assigned

AcsApplication
string

The ACS Application of the Batch User (Only used when PlatformID is 27 - ACS)

SortOrder.SortBy
string
SortOrder.IdColumns
Array of strings
SortOrder.ValidSortOrders
Array of strings
SortOrder.ColumnList
Array of strings
SortOrder.SortTypeList
Array of strings
SortBy
string

Option to sort Batch Users by Id or LoginName in ascending (default) or descending (:desc) order

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "platform": {
    },
  • "loginName": "string",
  • "password": "string",
  • "acsApplication": "string",
  • "roles": [
    ],
  • "dailyJobs": [
    ],
  • "jobs": [
    ],
  • "previousLoginName": "string"
}

Creates a new Batch User and returns it with its Id, if successful

Sample request: 

POST /api/batchUsers  

{  
"platform": {  
    "id": 3,  
    "name": "Windows"  
    }  
"loginName": "TestUser",  
"password": "userPassword"  
"roles": [  
    {  
        "id": 1  
    },  
    {  
        "id": 2  
    }  
    ]  
}
Authorizations:
Token
Request Body schema:
id
integer or null <int32>

Id of the batch user

object (OpCon.Api.Data.Entities.Platform)
loginName
string or null

User name for the batch user

password
string or null

This field is not returned on a GET request. It may be sent in a POST request. If the field is null in a PUT request, it gets ignored and the existing value is unchanged. The value is encrypted optional

acsApplication
string or null

If the Platform is 27 (ACS), then this field describes the application for this batch user. For all other values, this field will be null.

Array of objects or null (OpCon.Api.Data.Services.Roles.Models.Role)

Roles associated with this batch user optional

Array of objects or null (OpCon.Api.Data.Entities.CrossReference.CrossReferenceDailyJob)

Daily jobs associated with this batch user

Array of objects or null (OpCon.Api.Data.Entities.CrossReference.CrossReferenceMasterJob)

Master jobs associated with this batch user

previousLoginName
string or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "platform": {
    },
  • "loginName": "string",
  • "password": "string",
  • "acsApplication": "string",
  • "roles": [
    ],
  • "dailyJobs": [
    ],
  • "jobs": [
    ],
  • "previousLoginName": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "platform": {
    },
  • "loginName": "string",
  • "password": "string",
  • "acsApplication": "string",
  • "roles": [
    ],
  • "dailyJobs": [
    ],
  • "jobs": [
    ],
  • "previousLoginName": "string"
}

Gets the Batch User with the specified Id

Sample request (this returns the Batch User with Id = 1): 

GET /api/batchUsers/1
Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "platform": {
    },
  • "loginName": "string",
  • "password": "string",
  • "acsApplication": "string",
  • "roles": [
    ],
  • "dailyJobs": [
    ],
  • "jobs": [
    ],
  • "previousLoginName": "string"
}

Updates the Batch user with the specified Id

Sample request (this updates the Batch User with Id = 1):

PUT /api/batchUsers/1  

{  
    "platform": {  
        "id": 1,  
        "name": "Windows"  
    }  
    "loginName": "TestUser"  
}
Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer or null <int32>

Id of the batch user

object (OpCon.Api.Data.Entities.Platform)
loginName
string or null

User name for the batch user

password
string or null

This field is not returned on a GET request. It may be sent in a POST request. If the field is null in a PUT request, it gets ignored and the existing value is unchanged. The value is encrypted optional

acsApplication
string or null

If the Platform is 27 (ACS), then this field describes the application for this batch user. For all other values, this field will be null.

Array of objects or null (OpCon.Api.Data.Services.Roles.Models.Role)

Roles associated with this batch user optional

Array of objects or null (OpCon.Api.Data.Entities.CrossReference.CrossReferenceDailyJob)

Daily jobs associated with this batch user

Array of objects or null (OpCon.Api.Data.Entities.CrossReference.CrossReferenceMasterJob)

Master jobs associated with this batch user

previousLoginName
string or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "platform": {
    },
  • "loginName": "string",
  • "password": "string",
  • "acsApplication": "string",
  • "roles": [
    ],
  • "dailyJobs": [
    ],
  • "jobs": [
    ],
  • "previousLoginName": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "platform": {
    },
  • "loginName": "string",
  • "password": "string",
  • "acsApplication": "string",
  • "roles": [
    ],
  • "dailyJobs": [
    ],
  • "jobs": [
    ],
  • "previousLoginName": "string"
}

Deletes the Batch User with the specified Id

Sample request (this deletes a Batch User with Id = 11):

DELETE /api/batchUsers/11
Authorizations:
Token
path Parameters
id
required
integer <int32>
query Parameters
Ids
string

Comma-separated list of Batch User Ids

Limit
integer <int32>

Limits the results being fetched

Offset
integer <int32>

Retrieves records beginning at this record number

Platform
string

The Platform (Operating System) of the Batch User (Can accept ? and * wildcards)

PlatformId
integer <int32>

The Id of the Platform Type of the Batch User

RoleName
string

The Batch User Role Name (Can accept ? and * wildcards)

LoginName
string

The Batch User Login Name (Can accept ? and * wildcards)

IncludeRoles
boolean

Flag to include a list of Roles assigned to the Batch User

IncludeAssociations
boolean

Flag to include a list of Daily and Master Jobs to which the Batch User is assigned

AcsApplication
string

The ACS Application of the Batch User (Only used when PlatformID is 27 - ACS)

SortOrder.SortBy
string
SortOrder.IdColumns
Array of strings
SortOrder.ValidSortOrders
Array of strings
SortOrder.ColumnList
Array of strings
SortOrder.SortTypeList
Array of strings
SortBy
string

Option to sort Batch Users by Id or LoginName in ascending (default) or descending (:desc) order

Responses

Calendars

Gets a list of Calendars based on optional criteria specified

Sample request (this returns a list of Calendars by name in descending order):

GET /api/calendars?sortby=name:desc
Authorizations:
Token
query Parameters
Count
boolean

Flag to include a total count in the response header

Type
integer <int32>

The Type of the Calendars to fetch (0 = Individual Holiday Calendars, 1 = Other Calendars)

Name
string

The Calendar Name (Can accept ? and * wildcards)

Description
string

The Calendar Description (Can accept ? and * wildcards)

IncludeCrossReferences
boolean

Flag to include a list of Daily and Master Jobs to which the Calendar is assigned

Ids
string

Comma-separated list of Calendar Ids

Limit
integer <int32>

Limits the results being fetched

Offset
integer <int32>

Retrieves records beginning at this record number

SortOrders
Array of strings
IgnoreCase
boolean

Flag to indicate case-insensitive search criteria

BasicDetails
boolean

Flag to return just basic details

SortBy
string

Option to sort Calendars by Id, Name, Description or Type in ascending (default) or descending (:desc) order

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new Calendar and returns it with its Id, if successful

Sample request (this creates a new calendar):

POST /api/calendars

{
    "name": "CalendarName"
}
Authorizations:
Token
Request Body schema:
id
integer or null <int32>

The id of the calendar

object (OpCon.Api.Data.Entities.MasterSchedule)
type
integer <int32>

The type of the calendar

name
string or null

The name of the calendar

dates
Array of strings or null

The dates for this calendar

description
string or null

The description of the calendar

Array of objects or null (OpCon.Api.Data.Services.Calendars.CalendarAssociation)

Responses

Request samples

Content type
{
  • "id": 0,
  • "schedule": {
    },
  • "type": 0,
  • "name": "string",
  • "dates": [
    ],
  • "description": "string",
  • "calendarAssociations": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "schedule": {
    },
  • "type": 0,
  • "name": "string",
  • "dates": [
    ],
  • "description": "string",
  • "calendarAssociations": [
    ]
}

Gets a count of Calendars based on optional criteria specified

Sample request (this returns a count of calendars having name like the name provided):

GET /api/calendars/count?name=HC:
Authorizations:
Token
query Parameters
Count
boolean

Flag to include a total count in the response header

Type
integer <int32>

The Type of the Calendars to fetch (0 = Individual Holiday Calendars, 1 = Other Calendars)

Name
string

The Calendar Name (Can accept ? and * wildcards)

Description
string

The Calendar Description (Can accept ? and * wildcards)

IncludeCrossReferences
boolean

Flag to include a list of Daily and Master Jobs to which the Calendar is assigned

Ids
string

Comma-separated list of Calendar Ids

Limit
integer <int32>

Limits the results being fetched

Offset
integer <int32>

Retrieves records beginning at this record number

SortOrders
Array of strings
IgnoreCase
boolean

Flag to indicate case-insensitive search criteria

BasicDetails
boolean

Flag to return just basic details

SortBy
string

Option to sort Calendars by Id, Name, Description or Type in ascending (default) or descending (:desc) order

Responses

Response samples

Content type
application/json
0
0

Gets the Calendar with the specified Id

Sample request (this returns the Calendar with Id = 1 ):

GET /api/calendars/1
Authorizations:
Token
path Parameters
id
required
integer <int32>
query Parameters
Count
boolean

Flag to include a total count in the response header

Type
integer <int32>

The Type of the Calendars to fetch (0 = Individual Holiday Calendars, 1 = Other Calendars)

Name
string

The Calendar Name (Can accept ? and * wildcards)

Description
string

The Calendar Description (Can accept ? and * wildcards)

IncludeCrossReferences
boolean

Flag to include a list of Daily and Master Jobs to which the Calendar is assigned

Ids
string

Comma-separated list of Calendar Ids

Limit
integer <int32>

Limits the results being fetched

Offset
integer <int32>

Retrieves records beginning at this record number

SortOrders
Array of strings
IgnoreCase
boolean

Flag to indicate case-insensitive search criteria

BasicDetails
boolean

Flag to return just basic details

SortBy
string

Option to sort Calendars by Id, Name, Description or Type in ascending (default) or descending (:desc) order

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "schedule": {
    },
  • "type": 0,
  • "name": "string",
  • "dates": [
    ],
  • "description": "string",
  • "calendarAssociations": [
    ]
}

Updates the Calendar with the specified Id

Sample request:

PUT /api/calendar/1

{
    "id": 1,
    "name": "CalendarName",
    "dates": [ "03/16/2021", "06/02/2021" ]
}
Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer or null <int32>

The id of the calendar

object (OpCon.Api.Data.Entities.MasterSchedule)
type
integer <int32>

The type of the calendar

name
string or null

The name of the calendar

dates
Array of strings or null

The dates for this calendar

description
string or null

The description of the calendar

Array of objects or null (OpCon.Api.Data.Services.Calendars.CalendarAssociation)

Responses

Request samples

Content type
{
  • "id": 0,
  • "schedule": {
    },
  • "type": 0,
  • "name": "string",
  • "dates": [
    ],
  • "description": "string",
  • "calendarAssociations": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "schedule": {
    },
  • "type": 0,
  • "name": "string",
  • "dates": [
    ],
  • "description": "string",
  • "calendarAssociations": [
    ]
}

Deletes the Calendar with the specified Id

Sample request:

DELETE /api/calendars/11
Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Deletes Calendar dates older than 30 days for the Calendar with the specified Id, and returns the updated Calendar, if successful

Sample request:

POST /api/calendars/10/deleteOldDates

{
    "calendar": {
        "id": 10,
    }
}
Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "schedule": {
    },
  • "type": 0,
  • "name": "string",
  • "dates": [
    ],
  • "description": "string",
  • "calendarAssociations": [
    ]
}

Deletes Calendar dates older than 30 days from all Calendars

Sample request:

POST /api/calendars/deleteAllOldDates
Authorizations:
Token

Responses

CloudEvents

Gets a list of CloudEvents filters and associated actions based on the optional criteria specified

Sample request:

GET /api/cloudEvents
Authorizations:
Token
query Parameters
Server
string
Path
string
Protocol
string
logonUserName
string
Type
string
Result
integer <int64>
Name
string

Limit results to CloudEventsTriggers whose names match this pattern

EventTypeFilter
string

Limit results to CloudEventsTriggers whose CloudEvents Type matches this pattern

SourceFilter
string

Limit results to CloudEventsTriggers whose Source matches this pattern

OpconEventCountFilter
string
IncludeCount
boolean

Specifies whether to include the total number of records matching these criteria in the response

SortBy
string

Option to sort Cloud Events by Name, EventTypeFilter, SourceFilter, or OpconEventCountFilter

Offset
integer <int32>

Retrieves records beginning at this record number

Limit
integer <int32>

Limits the results being fetched

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new CloudEvents filter and associated actions

Sample request:

POST /api/cloudEvents
Authorizations:
Token
Request Body schema:
id
integer <int32>
name
string or null
object (OpCon.Api.Data.Services.CloudEvents.Models.CloudEventsFilter)
Array of objects or null (OpCon.Api.Data.Services.CloudEvents.Models.OpConEvent)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "filter": {
    },
  • "events": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "filter": {
    },
  • "events": [
    ]
}

Updates an existing CloudEvents filter and associated actions

Sample request:

PUT /api/cloudevents
Authorizations:
Token
Request Body schema:
id
integer <int32>
name
string or null
object (OpCon.Api.Data.Services.CloudEvents.Models.CloudEventsFilter)
Array of objects or null (OpCon.Api.Data.Services.CloudEvents.Models.OpConEvent)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "filter": {
    },
  • "events": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "filter": {
    },
  • "events": [
    ]
}

Deletes an existing CloudEvents filter and associated actions

Sample request:

DELETE /api/cloudEvents/{cloudEventsId}
Authorizations:
Token
path Parameters
cloudEventsId
required
integer <int32>

Responses

Gets a list of CloudEvents types based on the optional criteria specified

Sample request:

GET /api/cloudEvents/schema
Authorizations:
Token
Request Body schema:
type
string or null

Responses

Request samples

Content type
{
  • "type": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Gets the schema for a CloudEvents type

Sample request:

GET /api/cloudEvents/schema/{cloudEventsType}
Authorizations:
Token
path Parameters
cloudEventsType
required
string

Responses

Response samples

Content type
application/json
{
  • "schemaVersion": "http://example.com",
  • "valid": true,
  • "reference": "http://example.com",
  • "ref": { },
  • "recursiveReference": "http://example.com",
  • "recursiveAnchor": true,
  • "id": "http://example.com",
  • "anchor": "string",
  • "type": 0,
  • "default": [
    ],
  • "properties": {
    },
  • "items": [
    ],
  • "itemsPositionValidation": true,
  • "required": [
    ],
  • "allOf": [
    ],
  • "anyOf": [
    ],
  • "oneOf": [
    ],
  • "if": { },
  • "then": { },
  • "else": { },
  • "not": { },
  • "contains": { },
  • "propertyNames": { },
  • "enum": [
    ],
  • "const": [
    ],
  • "uniqueItems": true,
  • "minimumLength": 0,
  • "maximumLength": 0,
  • "minimum": 0,
  • "maximum": 0,
  • "exclusiveMinimum": true,
  • "exclusiveMaximum": true,
  • "minimumItems": 0,
  • "maximumItems": 0,
  • "minimumProperties": 0,
  • "maximumProperties": 0,
  • "minimumContains": 0,
  • "maximumContains": 0,
  • "contentEncoding": "string",
  • "contentMediaType": "string",
  • "writeOnly": true,
  • "readOnly": true,
  • "extensionData": {
    },
  • "title": "string",
  • "description": "string",
  • "multipleOf": 0,
  • "pattern": "string",
  • "dependencies": {
    },
  • "dependentRequired": {
    },
  • "dependentSchemas": {
    },
  • "patternProperties": {
    },
  • "additionalProperties": { },
  • "allowAdditionalProperties": true,
  • "allowAdditionalPropertiesSpecified": true,
  • "unevaluatedProperties": { },
  • "allowUnevaluatedProperties": true,
  • "additionalItems": { },
  • "allowAdditionalItems": true,
  • "allowAdditionalItemsSpecified": true,
  • "unevaluatedItems": { },
  • "allowUnevaluatedItems": true,
  • "format": "string",
  • "validators": [
    ]
}

Posts CloudEvents to OpCon

Sample request:

POST /api/cloudEvents/events
Authorizations:
Token
Request Body schema:
property name*
additional property
Array of arrays (Newtonsoft.Json.Linq.JToken)

Responses

Request samples

Content type
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

DailyGraphEdges

Gets a list of Daily Graph Edges based on optional criteria specified

Sample request (this returns a list of all daily graph edges):

GET /api/dailyGraphEdges?level=-1
Authorizations:
Token
query Parameters
ScheduleIds
string

Schedule ids to include

Level
integer <int32>

Number of successor and predecessor levels (-1, 0, 1, 2). -1 returns all predecessors up to 1000 levels. Default is 1.

JobIds
string

Job ids to include

ScheduleDates
Array of integers <int32> [ items <int32 > ]

Schedule dates to include

Dates
string
PredecessorLevel
integer <int32>

Number of predecessor levels (-1, 0, 1, 2). -1 returns all predecessors up to 1000 levels. Default is 1.

SuccessorLevel
integer <int32>

Number of successor levels (-1, 0, 1, 2). -1 returns all successors up to 1000 levels. Default is 1.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets a list of Daily Graph Edges based on optional criteria specified using POST to overcome the long query limitation

Sample request (this returns a list of all Daily Graph Edges):

POST /api/dailyGraphEdges?level=-1
Authorizations:
Token
Request Body schema:
scheduleIds
string or null

Schedule ids to include

level
integer or null <int32>

Number of successor and predecessor levels (-1, 0, 1, 2). -1 returns all predecessors up to 1000 levels. Default is 1.

jobIds
string or null

Job ids to include

scheduleDates
Array of integers or null <int32>

Schedule dates to include

dates
string or null
predecessorLevel
integer or null <int32>

Number of predecessor levels (-1, 0, 1, 2). -1 returns all predecessors up to 1000 levels. Default is 1.

successorLevel
integer or null <int32>

Number of successor levels (-1, 0, 1, 2). -1 returns all successors up to 1000 levels. Default is 1.

Responses

Request samples

Content type
{
  • "scheduleIds": "string",
  • "level": 0,
  • "jobIds": "string",
  • "scheduleDates": [
    ],
  • "dates": "string",
  • "predecessorLevel": 0,
  • "successorLevel": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Gets a list of Daily Graph Edges by job Id

Sample request (this returns a list of Daily Graph Edges for the Daily Schedule having the Id '20221229|1|1'):

GET /api/dailyGraphEdges/20221229|1|1
Authorizations:
Token
path Parameters
id
required
string
query Parameters
ScheduleIds
string

Schedule ids to include

Level
integer <int32>

Number of successor and predecessor levels (-1, 0, 1, 2). -1 returns all predecessors up to 1000 levels. Default is 1.

JobIds
string

Job ids to include

ScheduleDates
Array of integers <int32> [ items <int32 > ]

Schedule dates to include

Dates
string
PredecessorLevel
integer <int32>

Number of predecessor levels (-1, 0, 1, 2). -1 returns all predecessors up to 1000 levels. Default is 1.

SuccessorLevel
integer <int32>

Number of successor levels (-1, 0, 1, 2). -1 returns all successors up to 1000 levels. Default is 1.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DailyJobEvent

Gets a list of Daily Job Events

Sample request (this returns a list of Daily Job Events in descending order):

    GET /api/dailyJobs/{jobId}/events
Authorizations:
Token
path Parameters
required
object (OpCon.Api.Data.Entities.Jobs.DailyJobKey)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new Daily Job Event

Sample request:

     POST /api/dailyJobs/{jobId}/events/

     {
         "job": {
             "id": "20210712|6000|1|Unix1"
         },
         "user": {
             "id": 0,
             "name": "ocadm"
         },
         "trigger": {
             "type": "Status",
             "id": 900,
             "name": "Finished OK"
         },
         "event": {
             "type": "$CONSOLE:DISPLAY",
         "parameters": {
             "message": "HELLO"
             }
         },
         "frequency": {
             "name": "********"
  }

}

Authorizations:
Token
path Parameters
required
object (OpCon.Api.Data.Entities.Jobs.DailyJobKey)
Request Body schema:
required
object (OpCon.Api.Data.Services.DailyJobEvents.Models.DailyJobId)
required
object (OpCon.Api.Data.Services.DailyJobEvents.Models.SmaUserModel)
required
object
required
object (OpCon.Api.Data.Services.DailyJobEvents.Models.JobEventDetailsModel)
required
object (OpCon.Api.Data.Services.DailyJobEvents.Models.JobEventFrequencyModel)
id
integer <int32>

Responses

Request samples

Content type
{
  • "job": {
    },
  • "user": {
    },
  • "trigger": {
    },
  • "event": {
    },
  • "frequency": {
    },
  • "id": 0
}

Response samples

Content type
application/json
{
  • "job": {
    },
  • "user": {
    },
  • "trigger": {
    },
  • "event": {
    },
  • "frequency": {
    },
  • "id": 0
}

Updates the Daily Job Events for the specified Job Id

Sample request:

     PUT /api/dailyJobs/{jobId}/events/

     {
         "job": {
             "id": "20210712|6000|1|Unix1"
         },
         "user": {
             "id": 0,
             "name": "ocadm"
         },
         "trigger": {
             "type": "Status",
             "id": 900,
             "name": "Finished OK"
         },
         "event": {
             "type": "$CONSOLE:DISPLAY",
         "parameters": {
             "message": "HELLO"
             }
         },
         "frequency": {
             "name": "********"
  }

}

Authorizations:
Token
path Parameters
required
object (OpCon.Api.Data.Entities.Jobs.DailyJobKey)
Request Body schema:
required
object (OpCon.Api.Data.Services.DailyJobEvents.Models.DailyJobId)
required
object (OpCon.Api.Data.Services.DailyJobEvents.Models.SmaUserModel)
required
object
required
object (OpCon.Api.Data.Services.DailyJobEvents.Models.JobEventDetailsModel)
required
object (OpCon.Api.Data.Services.DailyJobEvents.Models.JobEventFrequencyModel)
id
integer <int32>

Responses

Request samples

Content type
{
  • "job": {
    },
  • "user": {
    },
  • "trigger": {
    },
  • "event": {
    },
  • "frequency": {
    },
  • "id": 0
}

Response samples

Content type
application/json
{
  • "job": {
    },
  • "user": {
    },
  • "trigger": {
    },
  • "event": {
    },
  • "frequency": {
    },
  • "id": 0
}

Deletes a Daily Job Event with the specified Id for the specified Job Id

Sample request:

    DELETE /api/dailyJobs/{jobId}/events/{eventId}
Authorizations:
Token
path Parameters
required
object (OpCon.Api.Data.Entities.Jobs.DailyJobKey)
eventId
required
integer <int32>

Responses

DailyJobs

Gets a list of Daily Jobs based on optional criteria specified

Sample request (returns a list of daily jobs with a job name starting with SMA):

GET /api/dailyJobs?jobName=SMA*
Authorizations:
Token
query Parameters
Uids
string

A comma-separated list of Daily Job Unique Ids (1, 2, etc.)

IncludeDocumentation
boolean

Flag to include a list of Documentation associated with the Daily Job

IncludeThresholdResourceDependencies
boolean

Flag to include a list of Threshold and Resource Dependencies associated with the Daily Job

IncludeThresholdResourceUpdates
boolean

Flag to include a list of Threshold and Resource Updates associated with the Daily Job

IncludeExpressionDependencies
boolean

Flag to include a list of Expression Dependencies associated with the Daily Job

IncludeDependencies
boolean

Flag to include a list of Job Dependencies associated with the Daily Job

IncludeConfigurations
boolean

Flag to include configurations associated with the Daily Job

IncludeCount
boolean

Flag to include a total count of Daily Jobs in the response header

IncludeDetails
boolean

Flag to include details of Daily Job

IncludeEvents
boolean

Flag to include a list of Events associated with the Daily Job

TerminationDescription
string

The Termination Description of the Daily Job

JobName
string

The Job Name of the Daily Job (Can accept ? and * wildcards)

Machine
string

The primary Machine Name assigned to run the Daily Job

StartMachine
string

The Machine Name on which the Daily Job is running

PrimaryMachine
string

The primary Machine Name assigned to run the Daily Job

AlternateMachine
string

The first alternate Machine Name assigned to run the Daily Job

AlternateMachine2
string

The second alternate Machine Name assigned to run the Daily Job

AlternateMachine3
string

The third alternate Machine Name assigned to run the Daily Job

Reason
string

The Daily Job Reason

ScheduleDates
Array of integers <int32> [ items <int32 > ]

Comma-separated list of dates the Daily Job is scheduled to run

SortOrders
Array of strings
JobStatus
string

The Status of the Daily Job

JobStatusCategories
Array of strings

Comma-separated list of Daily Job Statuses

JobType
string

The Daily Job Job Type

PriorityValue
integer <int32>

The Daily Job Priority

ScheduleStatus
string

The Daily Job Schedule Status

ScheduleName
string

The Daily Job Schedule Name

Path
string

The Daily Job Path

TagList
Array of strings

Comma separated list of Daily Job Tags

LimitValue
integer <int32>

Limits the results being fetched

OffsetValue
integer <int32>

Retrieves records beginning at this record number

DepartmentList
Array of integers <int32> [ items <int32 > ]

Comma-separated list of Department Ids

AccessCodeList
Array of integers <int32> [ items <int32 > ]

Comma-separated list of Access Code Ids

JobNumber
integer <int32>
Ids
string

Comma-separated list of Daily Job Ids

ScheduleIds
string
Name
string
Dates
string
Status
string
SortBy
string

Option to sort Daily Jobs by Id (in ascending (default) or descending (:desc) order), Name, Status, Date, Path, Duration (Calculated Duration), Start (Calculated Start Time), End (Calculated End Time), State (Job State), Machine (on which the Daily Job is running), JobType, Priority (Job Priority), TermDesc (Termination Description), and ScheduleStatus (Schedule Status)

Priority
string
AccessCodeIds
string
Limit
string
Offset
string
Tags
string
Categories
string
DepartmentIds
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets a list of Daily Jobs based on optional criteria specified using POST to overcome the long query limitation

Sample request (this returns a list of all daily jobs):

POST /api/dailyJobs
Authorizations:
Token
Request Body schema:
uids
string or null

A comma-separated list of Daily Job Unique Ids (1, 2, etc.)

includeDocumentation
boolean

Flag to include a list of Documentation associated with the Daily Job

includeThresholdResourceDependencies
boolean

Flag to include a list of Threshold and Resource Dependencies associated with the Daily Job

includeThresholdResourceUpdates
boolean

Flag to include a list of Threshold and Resource Updates associated with the Daily Job

includeExpressionDependencies
boolean

Flag to include a list of Expression Dependencies associated with the Daily Job

includeDependencies
boolean

Flag to include a list of Job Dependencies associated with the Daily Job

includeConfigurations
boolean

Flag to include configurations associated with the Daily Job

includeCount
boolean

Flag to include a total count of Daily Jobs in the response header

includeDetails
boolean

Flag to include details of Daily Job

includeEvents
boolean

Flag to include a list of Events associated with the Daily Job

terminationDescription
string or null

The Termination Description of the Daily Job

jobName
string or null

The Job Name of the Daily Job (Can accept ? and * wildcards)

machine
string or null

The primary Machine Name assigned to run the Daily Job

startMachine
string or null

The Machine Name on which the Daily Job is running

primaryMachine
string or null

The primary Machine Name assigned to run the Daily Job

alternateMachine
string or null

The first alternate Machine Name assigned to run the Daily Job

alternateMachine2
string or null

The second alternate Machine Name assigned to run the Daily Job

alternateMachine3
string or null

The third alternate Machine Name assigned to run the Daily Job

reason
string or null

The Daily Job Reason

scheduleDates
Array of integers or null <int32>

Comma-separated list of dates the Daily Job is scheduled to run

sortOrders
Array of strings or null
jobStatus
string or null

The Status of the Daily Job

jobStatusCategories
Array of strings or null

Comma-separated list of Daily Job Statuses

jobType
string or null

The Daily Job Job Type

priorityValue
integer or null <int32>

The Daily Job Priority

scheduleStatus
string or null

The Daily Job Schedule Status

scheduleName
string or null

The Daily Job Schedule Name

path
string or null

The Daily Job Path

tagList
Array of strings or null

Comma separated list of Daily Job Tags

limitValue
integer or null <int32>

Limits the results being fetched

offsetValue
integer or null <int32>

Retrieves records beginning at this record number

departmentList
Array of integers or null <int32>

Comma-separated list of Department Ids

accessCodeList
Array of integers or null <int32>

Comma-separated list of Access Code Ids

jobNumber
integer or null <int32>
ids
string or null

Comma-separated list of Daily Job Ids

scheduleIds
string or null
name
string or null
dates
string or null
status
string or null
sortBy
string or null

Option to sort Daily Jobs by Id (in ascending (default) or descending (:desc) order), Name, Status, Date, Path, Duration (Calculated Duration), Start (Calculated Start Time), End (Calculated End Time), State (Job State), Machine (on which the Daily Job is running), JobType, Priority (Job Priority), TermDesc (Termination Description), and ScheduleStatus (Schedule Status)

priority
string or null
accessCodeIds
string or null
limit
string or null
offset
string or null
tags
string or null
categories
string or null
departmentIds
string or null

Responses

Request samples

Content type
{
  • "uids": "string",
  • "includeDocumentation": true,
  • "includeThresholdResourceDependencies": true,
  • "includeThresholdResourceUpdates": true,
  • "includeExpressionDependencies": true,
  • "includeDependencies": true,
  • "includeConfigurations": true,
  • "includeCount": true,
  • "includeDetails": true,
  • "includeEvents": true,
  • "terminationDescription": "string",
  • "jobName": "string",
  • "machine": "string",
  • "startMachine": "string",
  • "primaryMachine": "string",
  • "alternateMachine": "string",
  • "alternateMachine2": "string",
  • "alternateMachine3": "string",
  • "reason": "string",
  • "scheduleDates": [
    ],
  • "sortOrders": [
    ],
  • "jobStatus": "string",
  • "jobStatusCategories": [
    ],
  • "jobType": "string",
  • "priorityValue": 0,
  • "scheduleStatus": "string",
  • "scheduleName": "string",
  • "path": "string",
  • "tagList": [
    ],
  • "limitValue": 0,
  • "offsetValue": 0,
  • "departmentList": [
    ],
  • "accessCodeList": [
    ],
  • "jobNumber": 0,
  • "ids": "string",
  • "scheduleIds": "string",
  • "name": "string",
  • "dates": "string",
  • "status": "string",
  • "sortBy": "string",
  • "priority": "string",
  • "accessCodeIds": "string",
  • "limit": "string",
  • "offset": "string",
  • "tags": "string",
  • "categories": "string",
  • "departmentIds": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Gets the Daily Job with the specified daily job Id

Sample request:

GET /api/dailyJobs/20231106|1|1|SMA Check Identity Limit
Authorizations:
Token
path Parameters
dailyJobId
required
string

Responses

Response samples

Content type
application/json
{
  • "uid": 0,
  • "uniqueJobId": "string",
  • "details": {
    },
  • "feedback": { },
  • "department": {
    },
  • "instanceProperties": [
    ],
  • "steps": [
    ],
  • "id": "string",
  • "priority": 0,
  • "jobName": "string",
  • "frequency": {
    },
  • "jobNumber": 0,
  • "jorsRequestParameters": "string",
  • "incidentTicketId": "string",
  • "incidentTicketURL": "string",
  • "type": {
    },
  • "accessCode": {
    },
  • "machine": {
    },
  • "alternateMachine": {
    },
  • "alternateMachine2": {
    },
  • "alternateMachine3": {
    },
  • "machineGroup": {
    },
  • "startMachine": {
    },
  • "tags": [
    ],
  • "jobStatus": {
    },
  • "schedule": {
    },
  • "terminationDescription": "string",
  • "computedStartTime": {
    },
  • "computedEndTime": {
    },
  • "computedDuration": {
    },
  • "documentation": {
    },
  • "thresholdDependencies": [
    ],
  • "resourceDependencies": [
    ],
  • "thresholdUpdates": [
    ],
  • "resourceUpdates": [
    ],
  • "dependencies": [