API docs by Redocly

OpCon REST API (26.0.0.0)

Download OpenAPI specification:

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
No sample

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
No sample

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
No sample

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
No sample

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
No sample

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
machineNetComName
string or null

Responses

Request samples

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

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. This endpoint includes schedule-instance properties from the specified Master Schedule

Sample request:

GET /api/acs/rjsf/task/master
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> [ items <int32 > ]
scheduleId
integer or null <int32>

Responses

Request samples

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

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. This endpoint includes schedule-instance properties from the specified Daily Schedule

Sample request:

GET /api/acs/rjsf/task/daily
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> [ items <int32 > ]
scheduleKey
string or null

Responses

Request samples

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

Gets a list of Machines which support the given application and task type

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

Authorizations:
Token
path Parameters
application
required
string
taskName
required
string

Responses

Gets a list of Machines which support the given application

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

Authorizations:
Token
path Parameters
application
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
No sample

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
No sample

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
No sample

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
No sample

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
No sample

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
No sample

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
No sample

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
No sample

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
No sample

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
No sample

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
No sample

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
No sample

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
No sample

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
No sample

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
No sample

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
No sample

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
No sample

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> [ items <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
No sample

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
No sample

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
No sample

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
No sample

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
No sample

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
No sample

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> [ items <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> [ items <int32 > ]

Comma-separated list of Department Ids

accessCodeList
Array of integers or null <int32> [ items <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
No sample

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
No sample

Updates the Daily Job with the specified daily job Id

Sample request:

PUT /api/dailyJobs/20231106|1|1|SMA Check Identity Limit

{
    "id": "20231106|1|1|SMA Check Identity Limit",
    "name": "SMA Check Identity Limit 2",
    "details": { ... },
    "department": { "id": 32000 },
    "frequency": { ... },
    "jobType": { "id": 6 },
    "accessCode": { "id": 0 },
    "primaryMachine": { "id": 1 },
}
Authorizations:
Token
path Parameters
dailyJobId
required
string
Request Body schema:
uid
integer or null <int64>
uniqueJobId
string or null
object (OpCon.Api.Data.Entities.Jobs.DailyJobDetails)
object (OpCon.Api.Data.Entities.Jobs.DailyJobFeedback)
object (OpCon.Api.Data.Services.Departments.Models.Department)
Array of objects or null (OpCon.Api.Data.Entities.InstanceProperty)
steps
Array of strings or null
id
string or null
priority
integer <int32>
jobName
string or null
object (OpCon.Api.Data.Entities.Frequency)

A frequency

jobNumber
integer <int32>
jorsRequestParameters
string or null
incidentTicketId
string or null
incidentTicketURL
string or null
object (OpCon.Api.Data.Entities.LsamType)
object (OpCon.Api.Data.Services.AccessCodes.Models.AccessCode)

An access code with id and name fields

object (OpCon.Api.Data.Entities.Machine)
object (OpCon.Api.Data.Entities.Machine)
object (OpCon.Api.Data.Entities.Machine)
object (OpCon.Api.Data.Entities.Machine)
object (OpCon.Api.Data.Entities.MachineGroup)
object (OpCon.Api.Data.Entities.Machine)
tags
Array of strings or null
object (OpCon.Api.Data.Entities.JobStatus)
object (OpCon.Api.Data.Entities.DailySchedule)
terminationDescription
string or null
object (OpCon.Api.Data.Entities.Jobs.ComputedTime)
object (OpCon.Api.Data.Entities.Jobs.ComputedTime)
object (OpCon.Api.Data.Entities.Jobs.ComputedDuration)
object (OpCon.Api.Data.Entities.Jobs.DailyJobDocumentation)
Array of objects or null (OpCon.Api.Data.Entities.Jobs.DailyJobThresholdDependency)
Array of objects or null (OpCon.Api.Data.Entities.Jobs.DailyJobResourceDependency)
Array of objects or null (OpCon.Api.Data.Entities.Jobs.DailyJobThresholdResourceUpdate)
Array of objects or null (OpCon.Api.Data.Entities.Jobs.DailyJobThresholdResourceUpdate)
Array of objects or null (OpCon.Api.Data.DailyJobDependency)
Array of objects or null (OpCon.Api.Data.Services.DailyJobEvents.Models.DailyJobEventModel)
Array of objects or null (OpCon.Api.Data.Entities.Jobs.DailyJobConfigurationProperty)
object (OpCon.Api.Data.Entities.Jobs.DailyJobExpressionDependencyCollection)
detailMessages
Array of strings or null
isRecurrent
boolean
features
Array of strings or null
currentStep
string or null
jobGroup
integer <int32>
startMachineId
integer <int32>
startOffset
number <double>
startAbsoluteRelative
string or null
lateToStartTime
number <double>
lateToStartAbsoluteRelative
string or null
start
number <double>
termination
number <double>
estimatedRunTime
integer <int32>
lastUpdate
number <double>
maxMinutes
integer <int32>
originalJobName
string or null
shortName
string or null
calculatedStartTime
number or null <double>
startTimeIsEstimated
boolean
calculatedEndTime
number or null <double>
endTimeIsEstimated
boolean
calculatedDuration
integer <int64>
durationIsEstimated
boolean
subScheduleDailyName
string or null
subScheduleDailyPath
string or null
subScheduleDailyInstance
integer or null <int32>
subScheduleDailyId
integer or null <int32>
subScheduleDailyDate
integer or null <int32>
subScheduleMasterName
string or null
subScheduleMasterId
integer or null <int32>

Responses

Request samples

Content type
{
  • "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": [
    ],
  • "events": [
    ],
  • "configurations": [
    ],
  • "expressionDependencies": {
    },
  • "detailMessages": [
    ],
  • "isRecurrent": true,
  • "features": [
    ],
  • "currentStep": "string",
  • "jobGroup": 0,
  • "startMachineId": 0,
  • "startOffset": 0.1,
  • "startAbsoluteRelative": "string",
  • "lateToStartTime": 0.1,
  • "lateToStartAbsoluteRelative": "string",
  • "start": 0.1,
  • "termination": 0.1,
  • "estimatedRunTime": 0,
  • "lastUpdate": 0.1,
  • "maxMinutes": 0,
  • "originalJobName": "string",
  • "shortName": "string",
  • "calculatedStartTime": 0.1,
  • "startTimeIsEstimated": true,
  • "calculatedEndTime": 0.1,
  • "endTimeIsEstimated": true,
  • "calculatedDuration": 0,
  • "durationIsEstimated": true,
  • "subScheduleDailyName": "string",
  • "subScheduleDailyPath": "string",
  • "subScheduleDailyInstance": 0,
  • "subScheduleDailyId": 0,
  • "subScheduleDailyDate": 0,
  • "subScheduleMasterName": "string",
  • "subScheduleMasterId": 0
}

Response samples

Content type
No sample

Gets a count of Daily Jobs matching the optional criteria specified

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

GET /api/dailyJobs/count?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
No sample

Gets a count of Daily Jobs matching the optional criteria specified and grouped by Job Status

Sample request:

GET /api/dailyJobs/count_by_status?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
No sample

Gets a list of Documentation for the Daily Job with the specified daily job Id

Sample request:

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

Responses

Response samples

Content type
No sample

Creates Documentation for the Daily Job with the specified daily job Id

Sample request:

POST /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/documentation

{ "frequency": "Daily", "job": "Check Identity Limit" }

Authorizations:
Token
path Parameters
rawId
required
string

Daily job id

Request Body schema:

Documentation

id
integer or null <int32>
frequency
string or null
job
string or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "frequency": "string",
  • "job": "string"
}

Response samples

Content type
No sample

Gets the Documentation with the specified documentation Id for the Daily Job with the specified daily job Id

Sample request:

GET /api/dailyJobs/documentation/20231106|1|1|SMA Check Identity Limit/1
Authorizations:
Token
path Parameters
rawId
required
string
documentationId
required
integer <int32>

Responses

Response samples

Content type
No sample

Updates Documentation with the specified documentation Id for the Daily Job with the specified daily job Id

Sample request:

PUT /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/documentation/1

{
    "frequency": "Daily",
    "job": "Check Identity Limit"
}
Authorizations:
Token
path Parameters
rawId
required
string
documentationId
required
integer <int32>
Request Body schema:
id
integer or null <int32>
frequency
string or null
job
string or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "frequency": "string",
  • "job": "string"
}

Response samples

Content type
No sample

Deletes the Documentation with the specified documentation Id for the Daily Job with the specified daily job Id

Sample request:

DELETE /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/documentation/1
Authorizations:
Token
path Parameters
rawId
required
string
documentationId
required
integer <int32>

Responses

Gets the Status of the Daily Job with the specified daily job Id

Sample request:

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

Responses

Response samples

Content type
No sample

Gets a list of Instance Properties for the Daily Job with the specified daily job Id

Sample request:

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

Responses

Response samples

Content type
No sample

Creates an Instance Property for the Daily Job with the specified daily job Id

Sample request:

POST /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/properties

{ "key": "instance2", "value": "value2" }

Authorizations:
Token
path Parameters
rawId
required
string
Request Body schema:
key
string or null
value
string or null

Responses

Request samples

Content type
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
No sample

Gets the Instance Property with the specified Name for the Daily Job with the specified daily job Id

Sample request:

GET /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/properties/instance1
Authorizations:
Token
path Parameters
rawId
required
string
name
required
string

Responses

Response samples

Content type
No sample

Updates the Instance Property with the specified property Name for the Daily Job with the specified daily job Id

Sample request:

PUT /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/properties/instance1

{
    "key": "instance1",
    "value": "value1"    
}
Authorizations:
Token
path Parameters
rawId
required
string
name
required
string
Request Body schema:
key
string or null
value
string or null

Responses

Request samples

Content type
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
No sample

Deletes the Instance Property with the specified instance Name for the Daily Job with the specified daily job Id

Sample request:

DELETE /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/properties/instance1
Authorizations:
Token
path Parameters
rawId
required
string
name
required
string

Responses

Copies the Daily Job definition to the Master Job

Sample request:

PUT /api/dailyJobs/copyToMasterJob/20231106|1|1|Job Name
Authorizations:
Token
path Parameters
jobId
required
string

Responses

Gets a list of Events for the Daily Job with the specified Id

Sample request:

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

Responses

Response samples

Content type
No sample

Gets the Event with the specified Id for the Daily Job with the specified Id

Sample request:

GET /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/events/1
Authorizations:
Token
path Parameters
rawId
required
string
eventId
required
integer <int32>

Responses

Response samples

Content type
No sample

Gets a list of Daily Job Expression Dependencies

Sample request (this returns a list of Expression Dependencies in ascending order):

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

Responses

Response samples

Content type
No sample

Creates an Expression Dependency for the Daily Job with the specified Job Id

Sample request:

    POST /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/expressionDependencies/

    {
        "expression1": "someExpression",
        "expression2": "expressionTwo"
    }
Authorizations:
Token
path Parameters
rawId
required
string
Request Body schema:
id
integer or null <int32>

The expression dependecy unique identifier

expression1
string or null

The string value for the expression.

expression2
string or null

The string value for the expression.

Responses

Request samples

Content type
{
  • "id": 0,
  • "expression1": "string",
  • "expression2": "string"
}

Response samples

Content type
No sample

Gets a Daily Job Expression Dependency with the specified Id

Sample request (this returns a Expression Dependency in ascending order):

GET /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/expressionDependencies/1
Authorizations:
Token
path Parameters
rawId
required
string
expressionId
required
integer <int32>

Responses

Response samples

Content type
No sample

Updates the Expression Dependency specified by the Id for the Daily Job with the specified Job Id

Sample request:

    PUT /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/expressionDependencies/1

    {
        "id": 1,
        "expression1": "someExpression",
        "expression2": "expressionTwo"
    }
Authorizations:
Token
path Parameters
rawId
required
string
expressionId
required
integer <int32>
Request Body schema:
id
integer or null <int32>

The expression dependecy unique identifier

expression1
string or null

The string value for the expression.

expression2
string or null

The string value for the expression.

Responses

Request samples

Content type
{
  • "id": 0,
  • "expression1": "string",
  • "expression2": "string"
}

Response samples

Content type
No sample

Deletes an Expression Dependency with the specified Id for the Daily Job with the specified Job Id

Sample request):

    DELETE /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/expressionDependencies/1
Authorizations:
Token
path Parameters
rawId
required
string
expressionId
required
integer <int32>
Request Body schema:
id
integer or null <int32>

The expression dependecy unique identifier

expression1
string or null

The string value for the expression.

expression2
string or null

The string value for the expression.

Responses

Request samples

Content type
{
  • "id": 0,
  • "expression1": "string",
  • "expression2": "string"
}

Gets a list of Resource Dependencies for the Daily Job with the specified Id

Sample request:

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

Responses

Response samples

Content type
No sample

Creates a Resource Dependency for the Daily Job with the specified Id

Sample request:

POST /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/resourceDependencies
Authorizations:
Token
path Parameters
rawId
required
string
Request Body schema:
id
integer or null <int32>
object (OpCon.Api.Data.Services.Resources.Resource)
requires
integer or null <int32>
requiresAll
boolean or null
object (OpCon.Api.Data.Entities.Frequency)

A frequency

Responses

Request samples

Content type
{
  • "id": 0,
  • "resource": {
    },
  • "requires": 0,
  • "requiresAll": true,
  • "frequency": {
    }
}

Response samples

Content type
No sample

Gets the Resource Dependency with the specified Id for the Daily Job with the specified Id

Sample request:

GET /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/resourceDependencies/1
Authorizations:
Token
path Parameters
rawId
required
string
resourceId
required
integer <int32>

Responses

Response samples

Content type
No sample

Updates the Resource Dependency with the specified Id for the Daily Job with the specified Id

Sample request:

PUT /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/resourceDependencies/1
Authorizations:
Token
path Parameters
rawId
required
string
resourceId
required
integer <int32>
Request Body schema:
id
integer or null <int32>
object (OpCon.Api.Data.Services.Resources.Resource)
requires
integer or null <int32>
requiresAll
boolean or null
object (OpCon.Api.Data.Entities.Frequency)

A frequency

Responses

Request samples

Content type
{
  • "id": 0,
  • "resource": {
    },
  • "requires": 0,
  • "requiresAll": true,
  • "frequency": {
    }
}

Response samples

Content type
No sample

Deletes the Resource Dependency with the specified Id for the Daily Job with the specified Id

Sample request:

DELETE /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/resourceDependencies/1
Authorizations:
Token
path Parameters
rawId
required
string
resourceId
required
integer <int32>

Responses

Gets a list of Threshold Dependencies for the Daily Job with the specified Id

Sample request:

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

Responses

Response samples

Content type
No sample

Creates a Threshold Dependency for the Daily Job with the specified Id

Sample request:

POST /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/thresholdDependencies
Authorizations:
Token
path Parameters
rawId
required
string
Request Body schema:
id
integer or null <int32>
object (OpCon.Api.Data.Services.Thresholds.Threshold)
value
integer <int32>
operator
string or null
object (OpCon.Api.Data.Entities.Frequency)

A frequency

Responses

Request samples

Content type
{
  • "id": 0,
  • "threshold": {
    },
  • "value": 0,
  • "operator": "string",
  • "frequency": {
    }
}

Response samples

Content type
No sample

Gets the Threshold Dependency with the specified Id for the Daily Job with the specified Id

Sample request:

GET /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/thresholdDependencies/1
Authorizations:
Token
path Parameters
rawId
required
string
thresholdId
required
integer <int32>

Responses

Response samples

Content type
No sample

Updates the Threshold Dependency with the specified Id for the Daily Job with the specified Id

Sample request:

PUT /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/thresholdDependencies/1
Authorizations:
Token
path Parameters
rawId
required
string
thresholdId
required
integer <int32>
Request Body schema:
id
integer or null <int32>
object (OpCon.Api.Data.Services.Thresholds.Threshold)
value
integer <int32>
operator
string or null
object (OpCon.Api.Data.Entities.Frequency)

A frequency

Responses

Request samples

Content type
{
  • "id": 0,
  • "threshold": {
    },
  • "value": 0,
  • "operator": "string",
  • "frequency": {
    }
}

Response samples

Content type
No sample

Deletes the Threshold Dependency with the specified Id for the Daily Job with the specified Id

Sample request:

DELETE /api/dailyJobs/20231106|1|1|SMA Check Identity Limit/thresholdDependencies/1
Authorizations:
Token
path Parameters
rawId
required
string
thresholdId
required
integer <int32>

Responses

Gets a list of Incident Tickets for the Daily Job with the specified Unique Id

Sample request:

GET /api/dailyJobs/111/incidentTickets
Authorizations:
Token
path Parameters
uniqueId
required
integer <int64>

Responses

Response samples

Content type
No sample

Creates an Incident Ticket for the Daily Job with the specified unique Id

Sample request:

POST /api/dailyJobs/111/incidentTickets

{
    "ticketId": "123456",
    "ticketUrl": "https://mycompany.com/tickets/123456"
}
Authorizations:
Token
path Parameters
uniqueId
required
integer <int64>
Request Body schema:
id
integer <int32>
ticketId
string or null
ticketUrl
string or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "ticketId": "string",
  • "ticketUrl": "string"
}

Response samples

Content type
No sample

Updates the Incident Ticket with the specified ticket Id for the Daily Job with the specified unique Id

Sample request:

PUT /api/dailyJobs/111/incidentTickets/1

{
    "id": "1",
    "ticketId": "123456",
    "ticketUrl": "https://mycompany.com/tickets/123456"
}
Authorizations:
Token
path Parameters
uniqueJobId
required
integer <int64>
ticketIdInUrl
required
string
Request Body schema:
id
integer <int32>
ticketId
string or null
ticketUrl
string or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "ticketId": "string",
  • "ticketUrl": "string"
}

Response samples

Content type
No sample

Deletes the Incident Ticket with the specified ticket Id for the Daily Job with the specified unique Id

Sample request:

DELETE /api/dailyJobs/111/incidentTickets/1
Authorizations:
Token
path Parameters
uniqueJobId
required
integer <int64>
ticketId
required
string

Responses

DailyJobsDependencies

Gets a list of Job Dependencies for the Daily Job with the specified Id

Sample request:

GET /api/dailyJobs/20210101|15|1|Job1/dependencies
Authorizations:
Token
path Parameters
jobId
required
string

Responses

Response samples

Content type
No sample

Updates the Job Dependencies for the Daily Job with the specified daily job Id

Sample request:

PUT /api/dailyJobs/20210101|15|1|Job1/dependencies

[
    {
        "type": {
            "name": "After",
            "condition": "Failed",
            "offset": 0
        },
        "predecessor": {
            "schedule": {
                "name": "SimpleSchedule"
            },
            "name": "SimpleJob1"
        }
    }
]
Authorizations:
Token
path Parameters
jobId
required
string
Request Body schema:
Array
scheduleId
integer <int32>
scheduleInstanceNumber
integer <int32>
jobName
string or null
id
integer <int64>

The id of the job dependency

object (OpCon.Api.Data.Entities.Frequency)

A frequency

object (OpCon.Api.Data.Entities.DailyJobDependencyType)

A job dependency type

object (OpCon.Api.Data.JobDependencyPredecessor)

A job dependency predecessor

scheduleDate
integer <int32>
isSatisfied
boolean

The status of the daily job dependency

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
No sample

Creates a new Job Dependency for the Daily Job with the specified daily job Id

Sample request:

POST /api/dailyJobs/20210101|15|1|Job1/dependencies

{
    "type": {
        "name": "After",
        "condition": "Failed",
        "offset": 0
    },
    "predecessor": {
        "schedule": {
            "name": "SimpleSchedule"
        },
        "name": "SimpleJob1"
    }
}
Authorizations:
Token
path Parameters
jobId
required
string
Request Body schema:
scheduleId
integer <int32>
scheduleInstanceNumber
integer <int32>
jobName
string or null
id
integer <int64>

The id of the job dependency

object (OpCon.Api.Data.Entities.Frequency)

A frequency

object (OpCon.Api.Data.Entities.DailyJobDependencyType)

A job dependency type

object (OpCon.Api.Data.JobDependencyPredecessor)

A job dependency predecessor

scheduleDate
integer <int32>
isSatisfied
boolean

The status of the daily job dependency

Responses

Request samples

Content type
{
  • "scheduleId": 0,
  • "scheduleInstanceNumber": 0,
  • "jobName": "string",
  • "id": 0,
  • "frequency": {
    },
  • "type": {
    },
  • "predecessor": {
    },
  • "scheduleDate": 0,
  • "isSatisfied": true
}

Response samples

Content type
No sample

Gets the Job Dependency with the specified Id for the Daily Job with the specified daily job Id

Sample request:

GET /api/dailyJobs/20210101|15|1|Job1/dependencies/2
Authorizations:
Token
path Parameters
jobId
required
string
id
required
integer <int64>

Responses

Response samples

Content type
No sample

Updates the Job Dependency with the specified dependency Id for the Daily Job with the specified daily job Id

Sample request:

PUT /api/dailyjobs/20210101|15|1|Job1/dependencies/2

{
    "type": {
        "name": "Conflict",
        "jobNameLike": "Simple",
        "offset": -1
    },
    "predecessor": {
        "schedule": {
            "name": "SimpleSchedule"
        },
        "name": "SimpleJob1"
}
Authorizations:
Token
path Parameters
jobId
required
string
id
required
integer <int64>
Request Body schema:
scheduleId
integer <int32>
scheduleInstanceNumber
integer <int32>
jobName
string or null
id
integer <int64>

The id of the job dependency

object (OpCon.Api.Data.Entities.Frequency)

A frequency

object (OpCon.Api.Data.Entities.DailyJobDependencyType)

A job dependency type

object (OpCon.Api.Data.JobDependencyPredecessor)

A job dependency predecessor

scheduleDate
integer <int32>
isSatisfied
boolean

The status of the daily job dependency

Responses

Request samples

Content type
{
  • "scheduleId": 0,
  • "scheduleInstanceNumber": 0,
  • "jobName": "string",
  • "id": 0,
  • "frequency": {
    },
  • "type": {
    },
  • "predecessor": {
    },
  • "scheduleDate": 0,
  • "isSatisfied": true
}

Response samples

Content type
No sample

Deletes the Job Dependency with the specified dependency Id for the Daily Job with the specified daily job Id

Sample request:

DELETE /api/dailyJobs/20210101|15|1|Job1/dependencies/2
Authorizations:
Token
path Parameters
jobId
required
string
id
required
integer <int64>

Responses

Response samples

Content type
No sample

DailySchedules

Gets the total count of Daily Schedules based on optional criteria specified

Sample request: 

GET /api/dailySchedules/count_by_status
Authorizations:
Token
query Parameters
IncludeAll
boolean

Flag to include all Schedule details

IncludeProperties
boolean

Flag to include Properties associated with the Daily Schedule

IncludeDetails
boolean

Flag to include details of the Daily Schedule

IncludeEvents
boolean

Flag to include Events associated with the Daily Schedule

uids
string
SortOrders
Array of strings
ScheduleDates
Array of integers <int32> [ items <int32 > ]

Daily Schedule dates to include

ScheduleCategories
Array of strings

Daily Schedule categories to include

Ids
string

Comma-separated list of Daily Schedule Ids

Name
string

The schedule name (Can accept ? and * wildcards)

Status
string

The schedule status

Categories
string
FailedJobs
boolean

Flag to include Daily Schedules with Failed Jobs

Offset
integer <int32>

Retrieves records beginning at this record number

Limit
integer <int32>

Limits the results being fetched

Path
string

Daily Schedule Path (Can accept ? and * wildcards)

SortBy
string

Options to sort Daily Schedule by (Id, Status, Name, Date, Path, Duration, Failed Jobs, StartTime, EndTime)

Dates
string

Comman-separated list of Daily Schedule dates to include

Responses

Response samples

Content type
No sample

Gets a list of dates on which the Daily Schedules built based on optional criteria provided

Sample request: 

GET /api/dailySchedules/dates?name=SMA Utility
Authorizations:
Token
query Parameters
IncludeAll
boolean

Flag to include all Schedule details

IncludeProperties
boolean

Flag to include Properties associated with the Daily Schedule

IncludeDetails
boolean

Flag to include details of the Daily Schedule

IncludeEvents
boolean

Flag to include Events associated with the Daily Schedule

uids
string
SortOrders
Array of strings
ScheduleDates
Array of integers <int32> [ items <int32 > ]

Daily Schedule dates to include

ScheduleCategories
Array of strings

Daily Schedule categories to include

Ids
string

Comma-separated list of Daily Schedule Ids

Name
string

The schedule name (Can accept ? and * wildcards)

Status
string

The schedule status

Categories
string
FailedJobs
boolean

Flag to include Daily Schedules with Failed Jobs

Offset
integer <int32>

Retrieves records beginning at this record number

Limit
integer <int32>

Limits the results being fetched

Path
string

Daily Schedule Path (Can accept ? and * wildcards)

SortBy
string

Options to sort Daily Schedule by (Id, Status, Name, Date, Path, Duration, Failed Jobs, StartTime, EndTime)

Dates
string

Comman-separated list of Daily Schedule dates to include

Responses

Response samples

Content type
No sample

Gets the details for the Daily Schedules with the specified Id

Sample request: 

GET /api/dailySchedules/20221228|1|1/details
Authorizations:
Token
path Parameters
id
required
string

Responses

Response samples

Content type
No sample

Gets the Daily Schedule with the specified Id

Sample request: 

GET /api/dailySchedules/20221228|1|1
Authorizations:
Token
path Parameters
id
required
string

Responses

Response samples

Content type
No sample

Updates the Daily Schedule with the specified Id

Sample request:

PUT /api/dailySchedules/20221228|1|1

[
  {
    "id": "20221228|1|1",
    "definedStartTime": "2022-12-28T00:00:00.0000000-06:00",
    "name": "SMAUtility",
    "instance": 1,
    "date": "2022-12-28T00:00:00.0000000-06:00",
    "path": "SMAUtility",
    "workWeek": 5
  }
]
Authorizations:
Token
path Parameters
id
required
string
Request Body schema:
uid
integer or null <int64>

The unique id

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

List of instance properties

dateAsInteger
integer <int32>
id
string or null

The daily schedule id

masterId
integer <int32>

The schedule id

object (OpCon.Api.Data.Entities.DailyScheduleDetails)
object (OpCon.Api.Data.Entities.Jobs.ComputedTime)
definedStartTime
string or null

The defined start time

endTime
string or null

The end time

name
string or null

The schedule name

object (OpCon.Api.Data.Entities.ScheduleStatus)
instance
integer or null <int32>

The schedule instance number

duration
integer or null <int64>

The duration in seconds

date
string or null

The schedule build date

path
string or null

The schedule path

containerJobId
string or null
workWeek
integer <int32>

The number of workweek days

Array of objects or null (OpCon.Api.Data.Services.DailyJobEvents.Models.ScheduleJobEventModel)

The daily schedule events

Responses

Request samples

Content type
{
  • "uid": 0,
  • "instanceProperties": [
    ],
  • "dateAsInteger": 0,
  • "id": "string",
  • "masterId": 0,
  • "details": {
    },
  • "computedStartTime": {
    },
  • "definedStartTime": "string",
  • "endTime": "string",
  • "name": "string",
  • "status": {
    },
  • "instance": 0,
  • "duration": 0,
  • "date": "string",
  • "path": "string",
  • "containerJobId": "string",
  • "workWeek": 0,
  • "events": [
    ]
}

Response samples

Content type
No sample

Gets the Daily Schedules based on optional criteria provided

Sample request: 

GET /api/dailyschedules?name=SMA Utility
Authorizations:
Token
query Parameters
IncludeAll
boolean

Flag to include all Schedule details

IncludeProperties
boolean

Flag to include Properties associated with the Daily Schedule

IncludeDetails
boolean

Flag to include details of the Daily Schedule

IncludeEvents
boolean

Flag to include Events associated with the Daily Schedule

uids
string
SortOrders
Array of strings
ScheduleDates
Array of integers <int32> [ items <int32 > ]

Daily Schedule dates to include

ScheduleCategories
Array of strings

Daily Schedule categories to include

Ids
string

Comma-separated list of Daily Schedule Ids

Name
string

The schedule name (Can accept ? and * wildcards)

Status
string

The schedule status

Categories
string
FailedJobs
boolean

Flag to include Daily Schedules with Failed Jobs

Offset
integer <int32>

Retrieves records beginning at this record number

Limit
integer <int32>

Limits the results being fetched

Path
string

Daily Schedule Path (Can accept ? and * wildcards)

SortBy
string

Options to sort Daily Schedule by (Id, Status, Name, Date, Path, Duration, Failed Jobs, StartTime, EndTime)

Dates
string

Comman-separated list of Daily Schedule dates to include

Responses

Response samples

Content type
No sample

Gets the Instance Properties for the Daily Schedule with the specified Id

Sample request: 

GET /api/dailySchedules/20221228|1|1/properties
Authorizations:
Token
path Parameters
scheduleId
required
string

Responses

Response samples

Content type
No sample

Gets the Instance Property with the specified property Id for the Daily Schedule with the specified daily schedule Id

Sample request:

GET /api/dailySchedules/20221228|1|1/properties/prop1
Authorizations:
Token
path Parameters
scheduleId
required
string
propertyKey
required
string

Responses

Response samples

Content type
No sample

Deletes the Instance Property with the specified Name for the Daily Schedule with the specified Id

Sample request:

DELETE /api/dailySchedules/20221228|1|1/properties/prop1
Authorizations:
Token
path Parameters
scheduleId
required
string
propertyKey
required
string

Responses

Creates a new Instance Property for the Daily Schedule with the specified Id

Sample request:

POST /api/dailySchedules/20221228|1|1/properties

{  
    "key": "NewProperty",  
    "value": "NewValue"  
}
Authorizations:
Token
path Parameters
id
required
string
Request Body schema:
key
string or null
value
string or null

Responses

Request samples

Content type
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
No sample

Updates the Instance Property with the specified Name for the Daily Schedule with the specified Id

Sample request:

PUT /api/dailySchedules/20221228|1|1/properties/prop1

{  
    "key": "prop1",  
    "value": "updatedValue"  
}
Authorizations:
Token
path Parameters
id
required
string
name
required
string
Request Body schema:
key
string or null
value
string or null

Responses

Request samples

Content type
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
No sample

DailyVisionWorkspaces

Gets the Daily Vision Workspaces based on optional criteria specified

Sample request: 

GET /api/dailyVisionWorkspaces
Authorizations:
Token
query Parameters
DayOffset
integer <int32>

Offset in days from today

IncludeCardsWithoutStatus
boolean

Flag to include cards without status

Responses

Response samples

Content type
No sample

Gets the Daily Vision Workspace with the specified Id. Currently, Id must be 1.

Sample request: 

GET /api/dailyVisionWorkspaces/1
Authorizations:
Token
path Parameters
id
required
integer <int32>
query Parameters
DayOffset
integer <int32>

Offset in days from today

IncludeCardsWithoutStatus
boolean

Flag to include cards without status

Responses

Response samples

Content type
No sample

DeleteActions

Deletes a collection of Jobs based on a given job Id, schedule Id, or date range.

Sample request:

POST /api/deleteActions
Authorizations:
Token
Request Body schema:

The request containing one or more request items.

required
Array of objects (OpCon.Api.Data.Services.QueuedDelete.QueuedDeleteRequestItem)

Responses

Request samples

Content type
{
  • "items": [
    ]
}

Response samples

Content type
No sample

Departments

Gets the Department with the specified Id

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

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

Responses

Response samples

Content type
No sample

Updates the Department with the specified Id

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

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

The name of the department

documentation
string or null
object (OpCon.Api.Data.Services.Departments.Models.DepartmentAssociations)
scheduleId
integer or null <int32>
scheduleName
string or null
jobName
string or null
dailyScheduleId
integer <int32>
dailyScheduleName
string or null
dailyJobName
string or null
dailyJobDate
integer <int32>
role
string or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "documentation": "string",
  • "associations": {
    },
  • "scheduleId": 0,
  • "scheduleName": "string",
  • "jobName": "string",
  • "dailyScheduleId": 0,
  • "dailyScheduleName": "string",
  • "dailyJobName": "string",
  • "dailyJobDate": 0,
  • "role": "string"
}

Response samples

Content type
No sample

Deletes the Department with the specified Id

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

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

Responses

Gets a list of Departments based on optional criteria specified

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

GET /api/departments?sortBy=name:desc
Authorizations:
Token
query Parameters
Name
string

The Department Name (Can accept ? and * wildcards)

Limit
integer <int32>

Limits the results being fetched

Offset
integer <int32>

Retrieves records beginning at this record number

Ids
string

Comma-separated list of Department Ids

SortOrders
Array of strings
BasicDetails
boolean

Flag to indicate to only return name and id data for the departments

AccessibleDepartments
Array of integers <int32> [ items <int32 > ]
SortBy
string

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

Responses

Response samples

Content type
No sample

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

Sample request:

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

The name of the department

documentation
string or null
object (OpCon.Api.Data.Services.Departments.Models.DepartmentAssociations)
scheduleId
integer or null <int32>
scheduleName
string or null
jobName
string or null
dailyScheduleId
integer <int32>
dailyScheduleName
string or null
dailyJobName
string or null
dailyJobDate
integer <int32>
role
string or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "documentation": "string",
  • "associations": {
    },
  • "scheduleId": 0,
  • "scheduleName": "string",
  • "jobName": "string",
  • "dailyScheduleId": 0,
  • "dailyScheduleName": "string",
  • "dailyJobName": "string",
  • "dailyJobDate": 0,
  • "role": "string"
}

Response samples

Content type
No sample

Escalation

Gets a list of Escalations tied to the current user

Sample request:

GET /api/escalations
Authorizations:
Token
path Parameters
userId
required
integer <int32>

Responses

Response samples

Content type
No sample

Acknowledges Escalations in bulk

Sample request:

PUT /api/users/0/escalations/

[
    {  
        "escalationId": 1,  
        "acknowledged": true
    },
    {  
        "escalationId": 2,  
        "acknowledged": true
    }
]
Authorizations:
Token
path Parameters
userId
required
integer <int32>
Request Body schema:
Array
escalationId
integer <int32>

The unique identifier of the escalation

escalationRuleId
integer <int32>

The unique rule identifier

escalationSequence
integer <int32>

The escalation sequence level

status
string or null

The status assigned to the escalation

escalationStatus
integer <int32>
attempts
integer or null <int32>

The amont of attempts

timeMessageSent
string or null

Time stamp for last message sent

lastMessageSent
string or null <date-time>
actionMessage
string or null
object (OpCon.Api.Data.Entities.EscalationNotification)
triggerName
string or null
acknowledgedBy
string or null

User who acknowledged the escalation

acknowledgeTime
string or null <date-time>

The time the escalation was acknowledged

acknowledgeHostName
string or null

The host name that acknowledged the notification

acknowledged
boolean

Flag describing whether the notification was acknowledged

actionIncludeId
string or null
scheduleDate
string or null
scheduleName
string or null
instanceNumber
integer <int32>
jobName
string or null
machineName
string or null
actionId
integer <int32>
actionName
string or null
groupOfId
integer <int32>
notifyDelimiter
string or null
actionType
integer or null <int32>
matchEscalation
object (OpCon.Api.Data.Entities.Escalation) Recursive

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
No sample

Gets an Escalation with the specified escalation Id for the user with the specified user Id

Sample request (this returns the Escalation with Id = 1 for the User with Id = 0):

GET /api/users/0/escalation/1
Authorizations:
Token
path Parameters
userId
required
integer <int32>
escalationId
required
integer <int32>

Responses

Response samples

Content type
No sample

Acknowledges the Escalation with the specified Id

Sample request:

PUT /api/users/0/escalations/1

{  
    "escalationId": 1,  
    "acknowledged": true
}
Authorizations:
Token
path Parameters
userId
required
integer <int32>
escalationId
required
integer <int32>
Request Body schema:
escalationId
integer <int32>

The unique identifier of the escalation

escalationRuleId
integer <int32>

The unique rule identifier

escalationSequence
integer <int32>

The escalation sequence level

status
string or null

The status assigned to the escalation

escalationStatus
integer <int32>
attempts
integer or null <int32>

The amont of attempts

timeMessageSent
string or null

Time stamp for last message sent

lastMessageSent
string or null <date-time>
actionMessage
string or null
object (OpCon.Api.Data.Entities.EscalationNotification)
triggerName
string or null
acknowledgedBy
string or null

User who acknowledged the escalation

acknowledgeTime
string or null <date-time>

The time the escalation was acknowledged

acknowledgeHostName
string or null

The host name that acknowledged the notification

acknowledged
boolean

Flag describing whether the notification was acknowledged

actionIncludeId
string or null
scheduleDate
string or null
scheduleName
string or null
instanceNumber
integer <int32>
jobName
string or null
machineName
string or null
actionId
integer <int32>
actionName
string or null
groupOfId
integer <int32>
notifyDelimiter
string or null
actionType
integer or null <int32>
matchEscalation
object (OpCon.Api.Data.Entities.Escalation) Recursive

Responses

Request samples

Content type
{
  • "escalationId": 0,
  • "escalationRuleId": 0,
  • "escalationSequence": 0,
  • "status": "string",
  • "escalationStatus": 0,
  • "attempts": 0,
  • "timeMessageSent": "string",
  • "lastMessageSent": "2019-08-24T14:15:22Z",
  • "actionMessage": "string",
  • "notification": {
    },
  • "triggerName": "string",
  • "acknowledgedBy": "string",
  • "acknowledgeTime": "2019-08-24T14:15:22Z",
  • "acknowledgeHostName": "string",
  • "acknowledged": true,
  • "actionIncludeId": "string",
  • "scheduleDate": "string",
  • "scheduleName": "string",
  • "instanceNumber": 0,
  • "jobName": "string",
  • "machineName": "string",
  • "actionId": 0,
  • "actionName": "string",
  • "groupOfId": 0,
  • "notifyDelimiter": "string",
  • "actionType": 0,
  • "matchEscalation": { }
}

Response samples

Content type
No sample

EscalationGroups

Gets a list of Escalation Groups based on optional criteria specified

Sample request:

GET /api/escalationGroups?name=*Test?
Authorizations:
Token
query Parameters
Name
string
Ids
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
No sample

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

Sample request:

POST /api/escalationGroups

{ "Name": "Testing", "Users": [ { "UserId": 0, "UserSignon": "ocadm" }, { "UserId": -1, "UserSignon": "[[Token]]" } ] }

Authorizations:
Token
Request Body schema:
name
required
string non-empty
required
Array of objects (SMAOpConRestApi.Controllers.Models.Escalation.EscalationGroupUserModel) non-empty

Responses

Request samples

Content type
{
  • "name": "string",
  • "users": [
    ]
}

Response samples

Content type
No sample

Gets the Escalation Group with the specified Id

Sample request:

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

Responses

Response samples

Content type
No sample

Deletes the Escalation Group with the specified Id

Sample request:

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

Responses

Gets a list of available Users that can be assigned to an Escalation Group

Sample request:

GET /api/escalationGroups/users
Authorizations:
Token

Responses

Response samples

Content type
No sample

Updates the Escalation Group with the specified Id

Sample request:

PUT /api/escalationGroups/1

{ "Name": "Testing", "Users": [ { "UserId": 0, "UserSignon": "ocadm" }, { "UserId": -1, "UserSignon": "[[UserToken]]" } ] }

Authorizations:
Token
path Parameters
groupId
required
integer <int32>
Request Body schema:
name
required
string non-empty
required
Array of objects (SMAOpConRestApi.Controllers.Models.Escalation.EscalationGroupUserModel) non-empty

Responses

Request samples

Content type
{
  • "name": "string",
  • "users": [
    ]
}

Response samples

Content type
No sample

EscalationRules

Gets a list of Escalation Rules based on optional criteria specified

Sample request:

    GET /api/escalationRules?name=*Test?
Authorizations:
Token
query Parameters
Name
string
Ids
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
No sample

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

Sample request:

POST: api/escalationRules

{
    "name": "escrule", // name is required
    "sequences": [ // at least one sequence is required
        {
            "sequence": 1, // all fields are required for a sequence
            "attempts": 1,
            "interval": 1,
            "group": {
            "id": 1 // group name is not required but an id is
            }
        }
}
Authorizations:
Token
Request Body schema:
name
required
string non-empty
required
Array of objects (SMAOpConRestApi.Controllers.Models.Escalation.EscalationSequenceModel) non-empty

Responses

Request samples

Content type
{
  • "name": "string",
  • "sequences": [
    ]
}

Response samples

Content type
No sample

Gets an Escalation Rule with the specified Id

Sample request:

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

Responses

Response samples

Content type
No sample

Deletes the Escalation Rule with the specified Id

Sample request:

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

Responses

Updates the Escalation Rule with the specified Id

Sample request:

PUT /api/escalationRules/1

{
    "id": 3,
    "name": "escrule", 
    "sequences": [
        {
            "sequence": 1,
            "attempts": 1,
            "interval": 1,
            "group": {
            "id": 1,
            "name": "group1"
            }
        }
    ]   
}
Authorizations:
Token
path Parameters
ruleId
required
integer <int32>
Request Body schema:
name
required
string non-empty
required
Array of objects (SMAOpConRestApi.Controllers.Models.Escalation.EscalationSequenceModel) non-empty

Responses

Request samples

Content type
{
  • "name": "string",
  • "sequences": [
    ]
}

Response samples

Content type
No sample

ExternalToken

Creates an External Token for use by the user submitting the request

The token is stored encrypted in the database and must be copied for use by the user. When length is provided, the generated token can only be used for external events. When length is not provided, the generated token can be used to interact with the API and for external events. To receive the token in the response, the user's isExternalTokenDisabled property must be false.

Sample request (this creates a new External Token with 20 characters):

POST /api/externaltoken

{  
    "length": 20  
}
Authorizations:
Token
Request Body schema:
token
string or null
length
integer or null <int32>

Responses

Request samples

Content type
{
  • "token": "string",
  • "length": 0
}

Response samples

Content type
No sample

Features

Gets a list of Features based on the optional criteria specified

Sample request:

GET /api/features
Authorizations:
Token
query Parameters
object (OpCon.Api.Data.Criteria.FeatureCriteria)

Responses

Response samples

Content type
No sample

Feedback

Gets a list of Feedback values based on optional criteria specified

Sample request (this returns a list of Feedback values with a JobType = 6):

 GET /api/feedback?jobType=6
Authorizations:
Token
query Parameters
JobTypeId
integer <int32>
Name
string

Responses

Response samples

Content type
No sample

Frequencies

Gets a list of Frequencies based on optional criteria specified

Sample request: 

GET /api/frequencies
Authorizations:
Token
query Parameters
Name
string

The Frequency Name

Skdid
integer <int32>

The Schedule Id

Limit
integer <int32>

Limits the results being fetched

Offset
integer <int32>

Retrieves records beginning at this record number

SortOrders
Array of strings

Option to sort Frequencies by Name, AOBN, CalendarName and InUse in ascending (default) or descending (:desc) order

Aobn
string

The Frequency AOBN (AfterDate, BeforeDate, OnDate, NotSchedule)

Calendar
string

The Frequency Calendar Name

InUse
integer <int32>

The number of times the Frequency is used

IgnoreCase
boolean

Flag for case insensitive search

IncludeAssociations
boolean

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

DuplicateFrequencyCodes
boolean

Flag to return only Frequencies having duplicate settings

BasicDetails
boolean

Flag to return basic Frequency details only

SortBy
string

Option to sort Frequencies by Name, Calendar, AOBN or InUse in ascending (default) or descending (:desc) order

Responses

Response samples

Content type
No sample

Creates a new Frequency

Sample request: 

POST /api/frequencies

{
    "name": "",
    "settings": {
        "dayOffset": 0,
        "aobn": "OnDate",
        "frequencyType": "BegOfPeriod",
        "period": "Week",
        "dayType": "Working",
        "calendar": "<None>"
    }
}
Authorizations:
Token
Request Body schema:
name
string or null

The name of the frequency

frequencyCode
integer <int32>

The frequency code

jobBuildStatus
string or null

The job build status of the frequency will always be "Unknown" as this property is not used

inUse
integer or null <int32>

The quantity of schedules and/or jobs using the frequency

object (OpCon.Api.Data.Entities.FrequencySettings)

Frequency settings

Responses

Request samples

Content type
{
  • "name": "string",
  • "frequencyCode": 0,
  • "jobBuildStatus": "string",
  • "inUse": 0,
  • "settings": {
    }
}

Response samples

Content type
No sample

Gets a Frequency by Name

Sample request:

GET /api/frequencies/frequencyName
Authorizations:
Token
path Parameters
name
required
string

Responses

Response samples

Content type
No sample

Updates the Frequency with the specified Name

Sample request: 

PUT /api/frequencies/frequencyName/settings
        
{
    "name": "frequencyName",
    "settings": {
        "dayOffset": 0,
        "aobn": "OnDate",
        "frequencyType": "AnnualPlan",
        "calendar": {
          "name": "Master Holiday"
        }
    }
}
Authorizations:
Token
path Parameters
name
required
string
Request Body schema:
name
string or null

The name of the frequency

frequencyCode
integer <int32>

The frequency code

jobBuildStatus
string or null

The job build status of the frequency will always be "Unknown" as this property is not used

inUse
integer or null <int32>

The quantity of schedules and/or jobs using the frequency

object (OpCon.Api.Data.Entities.FrequencySettings)

Frequency settings

Responses

Request samples

Content type
{
  • "name": "string",
  • "frequencyCode": 0,
  • "jobBuildStatus": "string",
  • "inUse": 0,
  • "settings": {
    }
}

Response samples

Content type
No sample

Gets a Frequency Forecast based on the request provided

Sample request: 

POST /api/frequencies/forecast

{
    "year": 2023,
    "scheduleId": 1,
    "forecastType": "Job",
    "frequencies": [
    {
        "frequencyName": "",
        "frequencyType": "OnOccurrence",
        "priority": 0,
        "settings": {
            "dayOffset": 0,
            "aobn": "OnDate",
            "frequencyType": "BegOfPeriod",
            "period": "Week",
            "dayType": "Working",
            "calendar": "<None>"
        },
        "advancedFrequencySettings": {
            "includeInScheduleOn": "03-16-2023"
        }
    }]
}
Authorizations:
Token
Request Body schema:
year
required
integer <int32>

The year to forecast.

scheduleId
integer <int32>

The schedule id to forecast. Required when forecast type is 'Schedule' or 'Job'.

forecastType
required
integer <int32> (OpCon.Api.Data.Entities.ForecastTypes)
Enum: 0 1 2 3
required
Array of objects (OpCon.Api.Data.Entities.ForecastRequestFrequency)

The list of frequencies to include in the forecast.

Responses

Request samples

Content type
{
  • "year": 0,
  • "scheduleId": 0,
  • "forecastType": 0,
  • "frequencies": [
    ]
}

Response samples

Content type
No sample

FrequencyNames

Gets a list of Frequency Names

Sample request: 

GET /api/frequencyNames
Authorizations:
Token
query Parameters
Name
string

The Frequency Name

Skdid
integer <int32>

The Schedule Id

Limit
integer <int32>

Limits the results being fetched

Offset
integer <int32>

Retrieves records beginning at this record number

SortOrders
Array of strings

Option to sort Frequencies by Name, AOBN, CalendarName and InUse in ascending (default) or descending (:desc) order

Aobn
string

The Frequency AOBN (AfterDate, BeforeDate, OnDate, NotSchedule)

Calendar
string

The Frequency Calendar Name

InUse
integer <int32>

The number of times the Frequency is used

IgnoreCase
boolean

Flag for case insensitive search

IncludeAssociations
boolean

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

DuplicateFrequencyCodes
boolean

Flag to return only Frequencies having duplicate settings

BasicDetails
boolean

Flag to return basic Frequency details only

SortBy
string

Option to sort Frequencies by Name, Calendar, AOBN or InUse in ascending (default) or descending (:desc) order

Responses

Response samples

Content type
No sample

GlobalProperties

Gets a list of Global Properties based on optional criteria specified

Sample request (this returns a list of Global Properties by Name in descending order):

GET /api/globalProperties?sortBy=name:desc
Authorizations:
Token
query Parameters
Limit
integer <int32>

Limits the results being fetched

Offset
integer <int32>

Retrieves records beginning at this record number

Name
string

The Global Property Name (Can accept ? and * wildcards)

Encrypted
string

Include encrypted Global Properties only (true or false (default))

Ids
string

Comma-separated list of Global Property Ids

Value
string

The Global Property Value (Can accept ? and * wildcards)

NameOrValue
string

The Global Property Name or Value (Can accept ? and * wildcards)

NoPatternValue
boolean

Flag to include Global Properties without pattern Values

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 Global Properties by Id, Name or Value

Responses

Response samples

Content type
No sample

Creates a new Global Property and return it with its Id, if successful

Sample request:

POST /api/globalProperties

{
    "name": "GP1",
    "value": "GP Value"
}
Authorizations:
Token
Request Body schema:
id
integer or null <int32>

Id for the global property

name
string or null

Name for the global property

value
string or null

Text value for the global property

documentation
string or null

Documentation for the global property

encrypted
boolean

Specifies if the global property is encrypted

fullName
string or null

Full Name of the global property

category
string or null

Category for the global property (GI, MI, SI, JI)

isPatternValue
boolean

Specifies whether the global property's values is a pattern

type
string or null

Global property type (System, User)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "value": "string",
  • "documentation": "string",
  • "encrypted": true,
  • "fullName": "string",
  • "category": "string",
  • "isPatternValue": true,
  • "type": "string"
}

Response samples

Content type
No sample

Gets the Global Property with specified Id

Sample request:

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

Responses

Response samples

Content type
No sample

Updates of the Global Property with the specified Id

Sample request:

POST /api/globalProperties/1

{
    "id": 1,
    "name": "GP1",
    "value": "GP Value"
}
Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer or null <int32>

Id for the global property

name
string or null

Name for the global property

value
string or null

Text value for the global property

documentation
string or null

Documentation for the global property

encrypted
boolean

Specifies if the global property is encrypted

fullName
string or null

Full Name of the global property

category
string or null

Category for the global property (GI, MI, SI, JI)

isPatternValue
boolean

Specifies whether the global property's values is a pattern

type
string or null

Global property type (System, User)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "value": "string",
  • "documentation": "string",
  • "encrypted": true,
  • "fullName": "string",
  • "category": "string",
  • "isPatternValue": true,
  • "type": "string"
}

Response samples

Content type
No sample

Deletes the Global Property with the specified Id

Sample request:

DELETE /api/globalProperties/22
Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

HistoryJob

Gets a list of Job Histories based on optional criteria specified

Sample request:

GET /api/jobHistories?from=03-15-2021&to=03-17-2021
Authorizations:
Token
query Parameters
From
string

The date to start the search from

To
string

The date to end the search

JobName
string

The Job Name

Duration
integer <int32>

The Job Duration

JobStatusIds
string

The Job Status Ids

RunDate
string

The Job Run Date

MachineName
string

The Machine Name

Offset
integer <int32>

Retrieves records beginning at this record number

Limit
integer <int32>

Limits the results being fetched

IncludeSummary
boolean

Flag to include Job Summary

PermissionIds
string

Comma-separated list of Permission Ids

UniqueId
string

The Job Unique Id

JobInstanceNumber
integer <int32>

The Job Instance Number

ScheduleId
integer <int32>

The Schedule Id

UniqueJobIds
string

Responses

Response samples

Content type
No sample

Gets a list of Job Histories for a job with the given master job id

Sample request:

GET /api/jobHistories/scheduleName|JobName?from=03-15-2021&to=03-17-2021
Authorizations:
Token
path Parameters
id
required
string
query Parameters
From
string

The date to start the search from

To
string

The date to end the search

JobName
string

The Job Name

Duration
integer <int32>

The Job Duration

JobStatusIds
string

The Job Status Ids

RunDate
string

The Job Run Date

MachineName
string

The Machine Name

Offset
integer <int32>

Retrieves records beginning at this record number

Limit
integer <int32>

Limits the results being fetched

IncludeSummary
boolean

Flag to include Job Summary

PermissionIds
string

Comma-separated list of Permission Ids

UniqueId
string

The Job Unique Id

JobInstanceNumber
integer <int32>

The Job Instance Number

ScheduleId
integer <int32>

The Schedule Id

UniqueJobIds
string

Responses

Response samples

Content type
No sample

Gets a list of Job History Notes for the given daily job Id

Sample request:

GET /api/jobHistories/2021|03|16|someJob/notes
Authorizations:
Token
path Parameters
id
required
string

Responses

Response samples

Content type
No sample

Updates a list of Job History Notes for the given daily job Id

Sample request:

PUT /api/jobHistories/2021|03|16|jobName/notes
Authorizations:
Token
path Parameters
id
required
string
Request Body schema:
jobId
string or null
Array of objects or null (OpCon.Api.Data.Entities.Note)

Responses

Request samples

Content type
{
  • "jobId": "string",
  • "notes": [
    ]
}

Response samples

Content type
No sample

Hostname

Gets the Hostname for the API Host Machine

Sample request:

GET /api/hostname
Authorizations:
Token

Responses

Response samples

Content type
No sample

ImpEx

Gets a list of Master Schedules based on optional criteria specified

Sample request (this returns a list of Master Schedules by Name in descending order):

GET /api/impEx/schedules?sortBy=name:desc
Authorizations:
Token
query Parameters
Ids
Array of integers <int32> [ items <int32 > ]
Name
string
Offset
integer <int32>

Retrieves records beginning at this record number

Limit
integer <int32>

Limits the results being fetched

AutoBuild
boolean

Flag to include AutoBuild Schedules only

MultiInstance
boolean

Flag to include Multi-Instance Schedules only

SubSchedule
boolean

Flag to include Sub-Schedules only

SortBy
string

Option to sort Schedules Name in ascending (default) or descending (:desc) order

IncludeDetails
boolean

Flag to include Schedule details

IncludeScheduleHierachy
boolean

Flag to include Schedule hierachy

CaseSensitive
boolean

Flag to use case sensitive search

BasicDetails
boolean

Flag to return only the basic details of the Schedule

IncludeDailySchedules
boolean

Flag to include Daily Schedules

IncludeMasterJobDetails
boolean

Flag to include Master Job details

Responses

Response samples

Content type
No sample

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

Sample request:

POST /api/impEx/schedules
        
{
    "name":"NewSchedule",
    "isMultiInstance":false,
    "isSubSchedule":false,
    "weekDays": {
        "monday":true,
        "tuesday":true,
        "wednesday":true,
        "thursday":true,
        "friday":true,
        "saturday":false,
        "sunday":false
    },
    "useMasterHoliday":true,
}
Authorizations:
Token
Request Body schema:
id
integer <int32>
name
string or null
documentation
string or null
isMultiInstance
boolean
isSubSchedule
boolean
containSubSchedule
boolean
Array of objects or null (OpCon.Api.Data.Entities.ImpEx.ImpExSubSchedule)
hasJobLevelFrequencies
boolean
object (OpCon.Api.Data.Entities.ImpEx.WeekDays)
object (OpCon.Api.Data.Entities.ImpEx.StartOffset)
useMasterHoliday
boolean
object (OpCon.Api.Data.Services.Calendars.Calendar)

A calendar with id, type, Schedule, Dates and name fields

conflictsWithOtherDays
boolean
object (OpCon.Api.Data.Entities.ImpEx.AutoBuildSettings)
object (OpCon.Api.Data.Entities.ImpEx.SingleInstanceProperties)
object (OpCon.Api.Data.Entities.ImpEx.MultiInstanceProperties)
object (OpCon.Api.Data.Entities.ImpEx.CrossReference)
object (OpCon.Api.Data.Services.ImpEx.ImpExScheduleDeployInformation)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "documentation": "string",
  • "isMultiInstance": true,
  • "isSubSchedule": true,
  • "containSubSchedule": true,
  • "parent": [
    ],
  • "hasJobLevelFrequencies": true,
  • "weekDays": {
    },
  • "startOffset": {
    },
  • "useMasterHoliday": true,
  • "additionalHolidays": {
    },
  • "conflictsWithOtherDays": true,
  • "autoBuildSettings": {
    },
  • "singleInstanceProperties": {
    },
  • "multiInstanceProperties": {
    },
  • "associations": {
    },
  • "deployInformation": {
    }
}

Response samples

Content type
No sample

Gets the Master Schedule with the specified Id

Sample request:

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

Responses

Response samples

Content type
No sample

Updates the Master Schedule with the specified Id

Sample request:

PUT /api/impEx/schedules/10
        
{
    "id":10,
    "name":"UpdatedSchedule",
    "isMultiInstance":false,
    "isSubSchedule":false,
    "weekDays": {
        "monday":true,
        "tuesday":true,
        "wednesday":true,
        "thursday":true,
        "friday":true,
        "saturday":false,
        "sunday":false
    },
    "useMasterHoliday":true,
}
Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer <int32>
name
string or null
documentation
string or null
isMultiInstance
boolean
isSubSchedule
boolean
containSubSchedule
boolean
Array of objects or null (OpCon.Api.Data.Entities.ImpEx.ImpExSubSchedule)
hasJobLevelFrequencies
boolean
object (OpCon.Api.Data.Entities.ImpEx.WeekDays)
object (OpCon.Api.Data.Entities.ImpEx.StartOffset)
useMasterHoliday
boolean
object (OpCon.Api.Data.Services.Calendars.Calendar)

A calendar with id, type, Schedule, Dates and name fields

conflictsWithOtherDays
boolean
object (OpCon.Api.Data.Entities.ImpEx.AutoBuildSettings)
object (OpCon.Api.Data.Entities.ImpEx.SingleInstanceProperties)
object (OpCon.Api.Data.Entities.ImpEx.MultiInstanceProperties)
object (OpCon.Api.Data.Entities.ImpEx.CrossReference)
object (OpCon.Api.Data.Services.ImpEx.ImpExScheduleDeployInformation)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "documentation": "string",
  • "isMultiInstance": true,
  • "isSubSchedule": true,
  • "containSubSchedule": true,
  • "parent": [
    ],
  • "hasJobLevelFrequencies": true,
  • "weekDays": {
    },
  • "startOffset": {
    },
  • "useMasterHoliday": true,
  • "additionalHolidays": {
    },
  • "conflictsWithOtherDays": true,
  • "autoBuildSettings": {
    },
  • "singleInstanceProperties": {
    },
  • "multiInstanceProperties": {
    },
  • "associations": {
    },
  • "deployInformation": {
    }
}

Response samples

Content type
No sample

Deletes the Master Schedule with the specified Id

Sample request:

DELETE /api/impEx/schedules/1
Authorizations:
Token
path Parameters
id
required
integer <int32>
query Parameters
forceDelete
boolean

Responses

Gets a list of Daily Schedules, Daily Jobs, and Master Jobs referenced by the Master Schedules with the specified Id

Sample request:

GET /api/impEx/schedules/1/crossReferences
Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
No sample

ImpExCopy

Copies a Master Schedule. If copyJobs is false, the jobs will not be copied. If copySchedulePrivileges is false, only OCADM and All Function Privilege users will be added.

Sample request:

POST /api/impex/schedules/copy/1

{
    "name": "SMAUtility2",
    "copyJobs": true,
    "copySchedulePrivileges": false
}
Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
name
string or null
copyJobs
boolean
copySchedulePrivileges
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "copyJobs": true,
  • "copySchedulePrivileges": true
}

Response samples

Content type
No sample

JobActions

Gets a list of responses for the Job Action with the specified Id

Sample request:

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

Responses

Response samples

Content type
No sample

Submits a new Job Action and returns it with its Id, if successful

Sample request:

POST /api/jobActions
        
{
    "action": "restart",
    "jobs":[
        {
            "id":"20231127|1|1|Utility Folder Log Cleanup",
            "rebuildOnRestartIfContainer":false
        }
    ]
}
Authorizations:
Token
Request Body schema:
id
integer <int32>
action
string or null
reason
string or null
result
string or null
Array of objects or null (OpCon.Api.Data.Entities.JobStatusItem)
expiryTime
string <date-time>

Responses

Request samples

Content type
{
  • "id": 0,
  • "action": "string",
  • "reason": "string",
  • "result": "string",
  • "jobs": [
    ],
  • "expiryTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
No sample

JobInstanceActions

Gets the Job Instance Action with the specified Id

Sample request:

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

Responses

Response samples

Content type
No sample

Submits a Job Instance Action and returns it with its Id, if successful

Sample request:

POST /api/jobInstanceActions
Authorizations:
Token
Request Body schema:
id
integer <int32>
action
string or null
actionType
integer <int32> (OpCon.Api.Data.Entities.Actions.ActionType)
Enum: 0 1 2
result
string or null
message
string or null
Array of objects or null (OpCon.Api.Data.Entities.Actions.JobInstanceActionItem)
expiryTime
string <date-time>
requestIds
Array of integers or null <int64> [ items <int64 > ]
userId
integer <int32>

Responses

Request samples

Content type
{
  • "id": 0,
  • "action": "string",
  • "actionType": 0,
  • "result": "string",
  • "message": "string",
  • "jobInstanceActionItems": [
    ],
  • "expiryTime": "2019-08-24T14:15:22Z",
  • "requestIds": [
    ],
  • "userId": 0
}

Response samples

Content type
No sample

JobSubTypes

Gets a list of Job Sub-types

Sample request

GET /api/jobSubTypes
Authorizations:
Token
query Parameters
PlatformId
integer <int32>

OpCon platform id.

Name
string

Job sub type name. (Search will ignore case and apply wildcard)

Responses

Gets the Job Sub-type with the specified Id

Sample request (this returns a single Job Sub-type with Id = 1):

GET /api/jobSubTypes/1
Authorizations:
Token
path Parameters
jobSubTypeId
required
integer <int32>

Responses

JobTags

Gets a list of Tags based on optional criteria specified

Sample request:

GET api/jobTags?sortBy=name:asc&limit=2&offset=2
Authorizations:
Token
query Parameters
RemoteInstance
string
Name
string

The Tag Name (Can accept ? and * wildcards)

Limit
integer <int32>

Limits the results being fetched

Offset
integer <int32>

Retrieves records beginning at this record number

SortOrders
Array of strings
MasterOnly
boolean
SortBy
string

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

Responses

Response samples

Content type
No sample

Creates a new Tag and returns it with its details, if successful

Sample request: 

POST /api/jobTags
        
{
    "Name": "TagName""
    "TagAssociations":
    [
        {
            "ScheduleName": "Schedule Name",
            "JobName":      "Job Name",
            "FrequencyName":"Frequency name"
        }
    ]
}
Authorizations:
Token
Request Body schema:
name
string or null

The tag name.

Array of objects or null (OpCon.Api.Data.Services.Tags.TagAssociation)

A list of jobs and frequencies associated with the tag. This property is returned only at api/jobTags/{tagName}.

Responses

Request samples

Content type
{
  • "name": "string",
  • "tagAssociations": [
    ]
}

Response samples

Content type
No sample

Updates the Tag and returns it with its details, if successful

Sample request: 

PUT /api/jobTags
        
{
    "Name": "TagName""
    "TagAssociations":
    [
        {
            "ScheduleName": "Schedule Name",
            "JobName":      "Job Name",
            "FrequencyName":"Frequency name"
        }
    ]
}
Authorizations:
Token
Request Body schema:
name
string or null

The tag name.

Array of objects or null (OpCon.Api.Data.Services.Tags.TagAssociation)

A list of jobs and frequencies associated with the tag. This property is returned only at api/jobTags/{tagName}.

Responses

Request samples

Content type
{
  • "name": "string",
  • "tagAssociations": [
    ]
}

Response samples

Content type
No sample

Gets a list of Tags based on the specified Name

Sample request:

GET /api/jobTags/?name=testTag
Authorizations:
Token
path Parameters
name
required
string

Responses

Response samples

Content type
No sample

Deletes the Tag with the specified Name

Sample request: 

DELETE /api/jobTags/TagName
Authorizations:
Token
path Parameters
name
required
string

Responses

LicenseSupportInfo

Gets license and support information

Sample request:

GET /api/licenseSupportInfo
Authorizations:
Token

Responses

Response samples

Content type
No sample

LicenseTaskCount

Gets a License Task Count based on optional criteria specified

Sample request:

GET /api/licenseTaskCount
Authorizations:
Token
query Parameters
From
string
To
string
JobTypeIds
string
DepartmentIds
string

Responses

Response samples

Content type
No sample

LinuxPlatform

Gets the platform type - either Windows or UNIX

Sample request:

GET api/platform
Authorizations:
Token
query Parameters
FileName
string

The name of the Log

Application
string

The Application associated with the Log

UserId
integer <int32>

The User Id

SessionId
integer <int64>

The Session Id

Size
string

The size of the Log

Archive
boolean

Flag to include Logs within archive folders only

ScheduleBuild
boolean
StartDate
string <date-time>

The Start Date of date range search

EndDate
string <date-time>

The End Date of date range search

SortBy
string

Option to sort Logs separated by a colon

Offset
integer <int32>

Retrieves records beginning at this record number

Limit
integer <int32>

Limits the results being fetched

Responses

Response samples

Content type
No sample

Logs

Archives a Log file

Sample request:

POST /api/logs
Authorizations:
Token
Request Body schema:
sessionId
integer or null <int64>
application
string or null
message
Array of strings or null
id
string or null
fileDir
string or null
fileName
string or null
object (OpCon.Api.Data.Entities.SessionLogUser)
fileSize
integer or null <int64>
fileAge
string or null <date-time>

Responses

Request samples

Content type
{
  • "sessionId": 0,
  • "application": "string",
  • "message": [
    ],
  • "id": "string",
  • "fileDir": "string",
  • "fileName": "string",
  • "user": {
    },
  • "fileSize": 0,
  • "fileAge": "2019-08-24T14:15:22Z"
}

Response samples

Content type
No sample

/api/logs

Authorizations:
Token
query Parameters
FileName
string

The name of the Log

Application
string

The Application associated with the Log

UserId
integer <int32>

The User Id

SessionId
integer <int64>

The Session Id

Size
string

The size of the Log

Archive
boolean

Flag to include Logs within archive folders only

ScheduleBuild
boolean
StartDate
string <date-time>

The Start Date of date range search

EndDate
string <date-time>

The End Date of date range search

SortBy
string

Option to sort Logs separated by a colon

Offset
integer <int32>

Retrieves records beginning at this record number

Limit
integer <int32>

Limits the results being fetched

Responses

/api/logs/download

Authorizations:
Token
query Parameters
filePaths
Array of strings non-empty

Responses

Gets the Log file at the specified file path

Sample request:

GET /api/logs/{filePath}
Authorizations:
Token
path Parameters
filePath
required
string
query Parameters
From
integer <int32>
To
integer <int32>
Tail
integer <int32>

Responses

MachineActions

Gets the Machine Action result for the specified action Id

Sample request:

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

Responses

Response samples

Content type
No sample

Creates a new Machine Action

Sample request:

POST api/machineActions
Authorizations:
Token
Request Body schema:
id
integer <int32>
action
string or null
result
string or null
message
string or null
expiryTime
string <date-time>
requestIds
Array of integers or null <int64> [ items <int64 > ]
userId
integer <int32>
Array of objects or null (OpCon.Api.Data.Entities.Actions.MachineActionItem)

A list of Machine action items

Responses

Request samples

Content type
{
  • "id": 0,
  • "action": "string",
  • "result": "string",
  • "message": "string",
  • "expiryTime": "2019-08-24T14:15:22Z",
  • "requestIds": [
    ],
  • "userId": 0,
  • "machines": [
    ]
}

Response samples

Content type
No sample

MachineGroups

Gets a list of Machine Groups based on optional criteria specified

Sample request:

GET /api/machineGroups?sortBy=name:desc
Authorizations:
Token
query Parameters
IncludeAssignedMasterJobs
boolean

Flag to include a list of Master Jobs to which the Machine Group is assigned

IncludeAssignedDailyJobs
boolean

Flag to include a list of Daily Jobs to which the Machine Group is assigned

MachineGroupNamesOnly
boolean

Flag to return Machine Group Names only

Offset
integer <int32>

Retrieves records beginning at this record number

Limit
integer <int32>

Limits the results being fetched

Name
string

The Machine Group Name (Can accept ? and * wildcards)

Type
string

The Machine Group Type (Can accept ? and * wildcards)

Ids
string

Comma-separated list of Machine Group Ids

TypeIds
string

Comma-separated list of Machine Group Type Ids

IncludeMachines
boolean

Flag to include Machines assigned to the Machine Group

AccessibleMachineGroups
Array of integers <int32> [ items <int32 > ]
SortBy
string

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

SortOrders
Array of strings

Responses

Response samples

Content type
No sample

Creates a new Machine Group and return it with its Id, if successful

Sample request

POST /api/machineGroups

{
    "name": "Operator"
}
Authorizations:
Token
Request Body schema:
id
integer or null <int32>
documentation
string or null
name
string or null
object (OpCon.Api.Data.Entities.MachineGroupType)
Array of objects or null (OpCon.Api.Data.Entities.Machine)
Array of objects or null (OpCon.Api.Data.Entities.CrossReference.CrossReferenceMasterJob)
Array of objects or null (OpCon.Api.Data.Entities.CrossReference.CrossReferenceDailyJob)
acsApplication
string or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "documentation": "string",
  • "name": "string",
  • "type": {
    },
  • "machines": [
    ],
  • "assignedMasterJobs": [
    ],
  • "assignedDailyJobs": [
    ],
  • "acsApplication": "string"
}

Response samples

Content type
No sample

Gets the Machine Group with the specified Id

Sample request:

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

Responses

Response samples

Content type
No sample

Updates the Machine Group with the specified Id

Sample request:

PUT /api/machineGroups/1

{
    "id": 1,
    "name": "MachineGroupName"
    "type: {
        "id": 6
    }
}
Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer or null <int32>
documentation
string or null
name
string or null
object (OpCon.Api.Data.Entities.MachineGroupType)
Array of objects or null (OpCon.Api.Data.Entities.Machine)
Array of objects or null (OpCon.Api.Data.Entities.CrossReference.CrossReferenceMasterJob)
Array of objects or null (OpCon.Api.Data.Entities.CrossReference.CrossReferenceDailyJob)
acsApplication
string or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "documentation": "string",
  • "name": "string",
  • "type": {
    },
  • "machines": [
    ],
  • "assignedMasterJobs": [
    ],
  • "assignedDailyJobs": [
    ],
  • "acsApplication": "string"
}

Response samples

Content type
No sample

Deletes the Machine Group with the specified Id

Sample request:

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

Responses

Machines

Gets a list of Machines based on optional criteria specified

Sample request:

GET /api/machines?sortBy=name:desc
Authorizations:
Token
query Parameters
ResourceName
string
Offset
integer <int32>

Retrieve records beginning at this record number

Limit
integer <int32>

Limits the results being fetched

includeDocumentation
boolean

Flag to include Documentation

IncludeAssignedMasterJobs
boolean

Flag to include a list of Master Jobs to which the Machine is assigned

IncludeAssignedDailyJobs
boolean

Flag to include a list of Daily Jobs to which the Machine is assigned

Ids
string

Comma-separated list of Machine Ids

Name
string

The Machine Name (Can accept ? and * wildcards)

Type
string

The Machine Type (Operating System)

Typeids
string

A comma-separated list of Machine Type Ids

GroupName
string

The Machine Group Name the Machine belongs to

GroupIds
string

A comma-separated list of Machine Group Ids

States
string

A comma-separated list of Machine States

Version
string

The Machine Version

FileTransferRole
string

The Machine File Transfer Role

Sockets
string
Tls
boolean

Flag to include Machines with (true) or without (false) TLS enabled

SortBy
string

Option to sort Machines by Id, Name, Type, Running Jobs, Last Update, State, Socket, Version, or UseTLS

IncludeDetails
boolean

Flag to include Details associated with the Machine

ExcludeNullMachine
boolean
SortOrders
Array of strings
ExtendedProperties
boolean

Flag to include Extended Properties associated with the Machine

Array of objects (OpCon.Api.Data.Errors.ApiError)
Array of objects (OpCon.Api.Data.Entities.AuxillaryProperty)

Responses

Response samples

Content type
No sample

Creates a new Machine

Sample request:

POST /api/machines

{
    "name": "new-machine",
    "socket": 4100,
    "type": {
        "id": 12,
        "description": "UNIX"
    }
}
Authorizations:
Token
Request Body schema:
_acsApplication
string or null

The ACS Integration Application Name

acsApplication
string or null
_acsConfiguration
string or null

The ACS Integration configuration - serialized JSON

acsConfiguration
string or null
_acsStorage
string or null

Arbitrary data used exclusively by the external ACS integration

acsStorage
string or null
_acsConfigVersion
string or null

The self-reported version of the Integration which produced this machine configuration

acsConfigVersion
string or null
_guidewireAgentType
string or null

The Guidewire Agent application type (Claims Center, Billing Center, Policy Center)

guidewireAgentType
string or null
_guidewireAgentBatchProcesses
string or null

The Guidewire batch processes which the Agent supports

guidewireAgentBatchProcesses
string or null
_guidewireAgentClientSecret
string or null

The OAuth Client Secret used to authenticate against the Guidewire API

guidewireAgentClientSecret
string or null
_guidewireAgentOAuthUrl
string or null

The OAuth Authority Server URL used to authenticate against the Guidewire API

guidewireAgentOAuthUrl
string or null
_guidewireAgentOAuthAppId
string or null

The OAuth Application Id used to authenticate against the Guidewire API

guidewireAgentOAuthAppId
string or null
_guidewireAgentOAuthScopes
string or null

The OAuth scopes to be granted within the Guidewire API

guidewireAgentOAuthScopes
string or null
id
integer or null <int32>
name
string or null
currentJobs
integer or null <int32>
gatewayId
integer or null <int32>
Array of objects or null (OpCon.Api.Data.Entities.MachineGroup)
lastUpdateDateTime
string or null
lastUpdate
number or null <double>
maximumJobs
integer or null <int32>
opConMaximumJobs
integer or null <int32>
socket
integer or null <int32>
object (OpCon.Api.Data.Entities.MachineStatus)
object (OpCon.Api.Data.Entities.LsamType)
Array of objects or null (OpCon.Api.Data.Entities.CrossReference.CrossReferenceMasterJob)
Array of objects or null (OpCon.Api.Data.Entities.CrossReference.CrossReferenceDailyJob)
acceptMessagesfromIp
string or null
agentAuthToken
string or null
agentCheckCrc
boolean or null
agentFileTransferPortNumberForTls
string or null
agentName
string or null
_agentSmaCommunicationsProtocol
string or null
agentSocket
string or null
agentSpecialFeatures
string or null
agentSupportNonTlsForSmaftAgent
string or null
agentSupportNonTlsForSmaftServer
string or null
agentSupportTlsForSmaftAgent
string or null
agentSupportTlsForSmaftServer
string or null
_allowKillJob
boolean or null
allowKillJob
boolean or null
Array of objects or null (OpCon.Api.Data.Entities.InstanceProperty) [ items ]
_checkCertificateRevocationList
boolean or null
checkCertificateRevocationList
boolean or null
checkCrc
string or null
checkMachineStatusInterval
integer or null <int32>
closeSocket
string or null
closeSocketDuringSynchronization
boolean or null
connectionAttemptTimeout
integer or null <int32>
consecutiveSendSleepTimeMilliseconds
integer or null <int32>
cpuCount
string or null
cpuId
string or null
cpuModel
string or null
cpuType
string or null
documentation
string or null
fileTransferFeature
string or null
fileTransferIpAddress
string or null
_fileTransferPortNumberForNonTls
integer or null <int32>
fileTransferPortNumberForNonTls
integer or null <int32>
_fileTransferPortNumberForTls
integer or null <int32>
fileTransferPortNumberForTls
integer or null <int32>
_fileTransferRole
string or null
fileTransferRole
string or null
fullFileTransferSupport
boolean or null
fullyQualifiedDomainName
string or null
gatewayName
string or null
hostname
string or null
jorsFeature
string or null
_jorsPortNumber
integer or null <int32>
jorsPortNumber
integer or null <int32>
jorsSocket
string or null
lsamTime
number or null <double>
lsamTimeDeltafromSam
integer or null <int32>
machineMaximumJobs
string or null
maxBytesReadPerMessage
integer or null <int32>
maxBytesSentPerMessage
integer or null <int32>
maxConsecutiveSendMessages
integer or null <int32>
noBufferRetryCount
integer or null <int32>
noBufferSleepTime
integer or null <int32>
osType
string or null
osVersion
string or null
pollInterval
integer or null <int32>
receiveBufferCount
integer or null <int32>
_requiresXmlEscape
boolean or null
requiresXmlEscape
boolean or null
resourceMonitorFeature
string or null
responseTimeoutInSeconds
integer or null <int32>
sendBufferCount
integer or null <int32>
smaCommunicationsProtocol
string or null
smaftAgentPort
string or null
smaftServerPortForNonTls
string or null
smaNetComIdentifier
string or null
smaNetComSocket
string or null
supportedAgentCapability
Array of strings or null
_supportNonTlsForSmaftAgent
boolean or null
supportNonTLSForSMAFTAgent
boolean or null
_supportNonTlsForSmaftServer
boolean or null
supportNonTLSForSMAFTServer
boolean or null
_supportTLSForSMAFTAgent
boolean or null
supportTLSForSMAFTAgent
boolean or null
_supportTLSForSMAFTServer
boolean or null
supportTLSForSMAFTServer
boolean or null
supportsHandshake
string or null
tcpIpAddress
string or null
timeOffsetfromSamInHours
number or null <double>
timeOffsetfromUtcInHours
number or null <double>
timeSent
string or null
timeZoneName
string or null
tlsCertificateDistinguishedName
string or null
_tlsCertificateSerialNumber
string or null
tlsCertificateSerialNumber
string or null
traceAllMessages
boolean or null
_useTLSforSchedulingCommunications
boolean or null
useTLSforSchedulingCommunications
boolean or null
agentVersion
string or null
hpNonStopIpAddress
string or null
hpNonStopSocketNumber
integer or null <int32>
_opconMftServerEnabled
boolean or null
opConMFTServerEnabled
boolean or null

Whether or not the MFT Agent (if this machine is one) has the Server functionality enabled.

_opconMftServerEventsWebhook
string or null
opConMFTServerEventsWebhook
string or null

The URI for the MFT Server's web hook (if this machine is an MFT Agent with enabled Server functionality).

_sapBwClientId
integer or null <int32>
sapBwClientId
integer or null <int32>
_sapBwGateway
string or null
sapBwGateway
string or null
_sapBwGroup
string or null
sapBwGroup
string or null
_sapBwName
string or null
sapBwName
string or null
_sapBwQueryListenerPort
integer or null <int32>
sapBwQueryListenerPort
integer or null <int32>
_sapBwSystemNumber
integer or null <int32>
sapBwSystemNumber
integer or null <int32>
_sapBwRfcTrace
integer or null <int32>
sapBwRfcTrace
string or null
_sapR3andCrmAuditLevel
integer or null <int32>
sapR3andCrmAuditLevel
string or null
_sapR3andCrmClientId
integer or null <int32>
sapR3andCrmClientId
integer or null <int32>
_sapEvents
Array of strings or null
sapEvents
Array of strings or null
_sapR3andCrmGateway
string or null
sapR3andCrmGateway
string or null
_sapR3andCrmGroup
string or null
sapR3andCrmGroup
string or null
_sapR3andCrmName
string or null
sapR3andCrmName
string or null
_sapR3andCrmQueryListenerPort
integer or null <int32>
sapR3andCrmQueryListenerPort
integer or null <int32>
_sapR3andCrmSystemNumber
integer or null <int32>
sapR3andCrmSystemNumber
integer or null <int32>
_sapR3andCrmRfcTrace
integer or null <int32>
sapR3andCrmRfcTrace
string or null

Responses

Request samples

Content type
{
  • "_acsApplication": "string",
  • "acsApplication": "string",
  • "_acsConfiguration": "string",
  • "acsConfiguration": "string",
  • "_acsStorage": "string",
  • "acsStorage": "string",
  • "_acsConfigVersion": "string",
  • "acsConfigVersion": "string",
  • "_guidewireAgentType": "string",
  • "guidewireAgentType": "string",
  • "_guidewireAgentBatchProcesses": "string",
  • "guidewireAgentBatchProcesses": "string",
  • "_guidewireAgentClientSecret": "string",
  • "guidewireAgentClientSecret": "string",
  • "_guidewireAgentOAuthUrl": "string",
  • "guidewireAgentOAuthUrl": "string",
  • "_guidewireAgentOAuthAppId": "string",
  • "guidewireAgentOAuthAppId": "string",
  • "_guidewireAgentOAuthScopes": "string",
  • "guidewireAgentOAuthScopes": "string",
  • "id": 0,
  • "name": "string",
  • "currentJobs": 0,
  • "gatewayId": 0,
  • "groups": [
    ],
  • "lastUpdateDateTime": "string",
  • "lastUpdate": 0.1,
  • "maximumJobs": 0,
  • "opConMaximumJobs": 0,
  • "socket": 0,
  • "state": {
    },
  • "type": {
    },
  • "assignedMasterJobs": [
    ],
  • "assignedDailyJobs": [
    ],
  • "acceptMessagesfromIp": "string",
  • "agentAuthToken": "string",
  • "agentCheckCrc": true,
  • "agentFileTransferPortNumberForTls": "string",
  • "agentName": "string",
  • "_agentSmaCommunicationsProtocol": "string",
  • "agentSocket": "string",
  • "agentSpecialFeatures": "string",
  • "agentSupportNonTlsForSmaftAgent": "string",
  • "agentSupportNonTlsForSmaftServer": "string",
  • "agentSupportTlsForSmaftAgent": "string",
  • "agentSupportTlsForSmaftServer": "string",
  • "_allowKillJob": true,
  • "allowKillJob": true,
  • "availableProperties": [
    ],
  • "_checkCertificateRevocationList": true,
  • "checkCertificateRevocationList": true,
  • "checkCrc": "string",
  • "checkMachineStatusInterval": 0,
  • "closeSocket": "string",
  • "closeSocketDuringSynchronization": true,
  • "connectionAttemptTimeout": 0,
  • "consecutiveSendSleepTimeMilliseconds": 0,
  • "cpuCount": "string",
  • "cpuId": "string",
  • "cpuModel": "string",
  • "cpuType": "string",
  • "documentation": "string",
  • "fileTransferFeature": "string",
  • "fileTransferIpAddress": "string",
  • "_fileTransferPortNumberForNonTls": 0,
  • "fileTransferPortNumberForNonTls": 0,
  • "_fileTransferPortNumberForTls": 0,
  • "fileTransferPortNumberForTls": 0,
  • "_fileTransferRole": "string",
  • "fileTransferRole": "string",
  • "fullFileTransferSupport": true,
  • "fullyQualifiedDomainName": "string",
  • "gatewayName": "string",
  • "hostname": "string",
  • "jorsFeature": "string",
  • "_jorsPortNumber": 0,
  • "jorsPortNumber": 0,
  • "jorsSocket": "string",
  • "lsamTime": 0.1,
  • "lsamTimeDeltafromSam": 0,
  • "machineMaximumJobs": "string",
  • "maxBytesReadPerMessage": 0,
  • "maxBytesSentPerMessage": 0,
  • "maxConsecutiveSendMessages": 0,
  • "noBufferRetryCount": 0,
  • "noBufferSleepTime": 0,
  • "osType": "string",
  • "osVersion": "string",
  • "pollInterval": 0,
  • "receiveBufferCount": 0,
  • "_requiresXmlEscape": true,
  • "requiresXmlEscape": true,
  • "resourceMonitorFeature": "string",
  • "responseTimeoutInSeconds": 0,
  • "sendBufferCount": 0,
  • "smaCommunicationsProtocol": "string",
  • "smaftAgentPort": "string",
  • "smaftServerPortForNonTls": "string",
  • "smaNetComIdentifier": "string",
  • "smaNetComSocket": "string",
  • "supportedAgentCapability": [
    ],
  • "_supportNonTlsForSmaftAgent": true,
  • "supportNonTLSForSMAFTAgent": true,
  • "_supportNonTlsForSmaftServer": true,
  • "supportNonTLSForSMAFTServer": true,
  • "_supportTLSForSMAFTAgent": true,
  • "supportTLSForSMAFTAgent": true,
  • "_supportTLSForSMAFTServer": true,
  • "supportTLSForSMAFTServer": true,
  • "supportsHandshake": "string",
  • "tcpIpAddress": "string",
  • "timeOffsetfromSamInHours": 0.1,
  • "timeOffsetfromUtcInHours": 0.1,
  • "timeSent": "string",
  • "timeZoneName": "string",
  • "tlsCertificateDistinguishedName": "string",
  • "_tlsCertificateSerialNumber": "string",
  • "tlsCertificateSerialNumber": "string",
  • "traceAllMessages": true,
  • "_useTLSforSchedulingCommunications": true,
  • "useTLSforSchedulingCommunications": true,
  • "agentVersion": "string",
  • "hpNonStopIpAddress": "string",
  • "hpNonStopSocketNumber": 0,
  • "_opconMftServerEnabled": true,
  • "opConMFTServerEnabled": true,
  • "_opconMftServerEventsWebhook": "string",
  • "opConMFTServerEventsWebhook": "string",
  • "_sapBwClientId": 0,
  • "sapBwClientId": 0,
  • "_sapBwGateway": "string",
  • "sapBwGateway": "string",
  • "_sapBwGroup": "string",
  • "sapBwGroup": "string",
  • "_sapBwName": "string",
  • "sapBwName": "string",
  • "_sapBwQueryListenerPort": 0,
  • "sapBwQueryListenerPort": 0,
  • "_sapBwSystemNumber": 0,
  • "sapBwSystemNumber": 0,
  • "_sapBwRfcTrace": 0,
  • "sapBwRfcTrace": "string",
  • "_sapR3andCrmAuditLevel": 0,
  • "sapR3andCrmAuditLevel": "string",
  • "_sapR3andCrmClientId": 0,
  • "sapR3andCrmClientId": 0,
  • "_sapEvents": [
    ],
  • "sapEvents": [
    ],
  • "_sapR3andCrmGateway": "string",
  • "sapR3andCrmGateway": "string",
  • "_sapR3andCrmGroup": "string",
  • "sapR3andCrmGroup": "string",
  • "_sapR3andCrmName": "string",
  • "sapR3andCrmName": "string",
  • "_sapR3andCrmQueryListenerPort": 0,
  • "sapR3andCrmQueryListenerPort": 0,
  • "_sapR3andCrmSystemNumber": 0,
  • "sapR3andCrmSystemNumber": 0,
  • "_sapR3andCrmRfcTrace": 0,
  • "sapR3andCrmRfcTrace": "string"
}

Response samples

Content type
No sample

Gets a count of Machines based on optional criteria specified and grouped by the following statuses: Up, Down, Error, Waiting, Limited

Sample request: GET /api/machines/count_by_status

Authorizations:
Token
query Parameters
ResourceName
string
Offset
integer <int32>

Retrieve records beginning at this record number

Limit
integer <int32>

Limits the results being fetched

includeDocumentation
boolean

Flag to include Documentation

IncludeAssignedMasterJobs
boolean

Flag to include a list of Master Jobs to which the Machine is assigned

IncludeAssignedDailyJobs
boolean

Flag to include a list of Daily Jobs to which the Machine is assigned

Ids
string

Comma-separated list of Machine Ids

Name
string

The Machine Name (Can accept ? and * wildcards)

Type
string

The Machine Type (Operating System)

Typeids
string

A comma-separated list of Machine Type Ids

GroupName
string

The Machine Group Name the Machine belongs to

GroupIds
string

A comma-separated list of Machine Group Ids

States
string

A comma-separated list of Machine States

Version
string

The Machine Version

FileTransferRole
string

The Machine File Transfer Role

Sockets
string
Tls
boolean

Flag to include Machines with (true) or without (false) TLS enabled

SortBy
string

Option to sort Machines by Id, Name, Type, Running Jobs, Last Update, State, Socket, Version, or UseTLS

IncludeDetails
boolean

Flag to include Details associated with the Machine

ExcludeNullMachine
boolean
SortOrders
Array of strings
ExtendedProperties
boolean

Flag to include Extended Properties associated with the Machine

Array of objects (OpCon.Api.Data.Errors.ApiError)
Array of objects (OpCon.Api.Data.Entities.AuxillaryProperty)

Responses

Response samples

Content type
No sample

Gets a list of Machine Types based on optional criteria specified

Sample request:

GET /api/machines/types
Authorizations:
Token
query Parameters
All
boolean

Flag to indicate if all types should be returned

ForScriptRunnerOnly
boolean

Flag to indicate if only types that are available to run scripts should be returned

ResourceName
string
Array of objects (OpCon.Api.Data.Errors.ApiError)
Array of objects (OpCon.Api.Data.Entities.AuxillaryProperty)

Responses

Response samples

Content type
No sample

Gets the Instance Properties for the Machine with the specified machine Id

Sample request: GET /api/machines/1/properties

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
No sample

Creates a new Instance Property for the Machine with the specified Id

Sample request:

POST /api/machines/1/properties

{
    "key": "property2",
    "value": "value2",
}
Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
key
string or null
value
string or null

Responses

Request samples

Content type
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
No sample

Gets the Instance Property with the specified property Name for the Machine with the specified id

Sample request:

GET /api/machines/1/properties/property1
Authorizations:
Token
path Parameters
id
required
integer <int32>
name
required
string

Responses

Response samples

Content type
No sample

Deletes the Instance Property with the specified property Name for the Machine with the specified machine Id

Sample request:

DELETE /api/machines/1/properties/property1
Authorizations:
Token
path Parameters
id
required
integer <int32>
name
required
string

Responses

Updates the Instance Property with the specified property Name for the Machine having the specified machine Id

Sample request:

PUT /api/machines/1/properties/property1

{
    "key": "property21,
    "value": "new-value",
}
Authorizations:
Token
path Parameters
id
required
integer <int32>
name
required
string
Request Body schema:
key
string or null
value
string or null

Responses

Request samples

Content type
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
No sample

Gets the Machine with the specified Id

Sample request:

GET /api/machines/3
Authorizations:
Token
path Parameters
machineId
required
integer <int32>

Responses

Response samples

Content type
No sample

Updates the Machine with the specified Id

Sample request:

PUT /api/machines/1

{
    "id": 1,
    "name": "updated-machine",
    "socket": 4100,
    "type": {
        "id": 12,
        "description": "UNIX"
    }
}
Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
_acsApplication
string or null

The ACS Integration Application Name

acsApplication
string or null
_acsConfiguration
string or null

The ACS Integration configuration - serialized JSON

acsConfiguration
string or null
_acsStorage
string or null

Arbitrary data used exclusively by the external ACS integration

acsStorage
string or null
_acsConfigVersion
string or null

The self-reported version of the Integration which produced this machine configuration

acsConfigVersion
string or null
_guidewireAgentType
string or null

The Guidewire Agent application type (Claims Center, Billing Center, Policy Center)

guidewireAgentType
string or null
_guidewireAgentBatchProcesses
string or null

The Guidewire batch processes which the Agent supports

guidewireAgentBatchProcesses
string or null
_guidewireAgentClientSecret
string or null

The OAuth Client Secret used to authenticate against the Guidewire API

guidewireAgentClientSecret
string or null
_guidewireAgentOAuthUrl
string or null

The OAuth Authority Server URL used to authenticate against the Guidewire API

guidewireAgentOAuthUrl
string or null
_guidewireAgentOAuthAppId
string or null

The OAuth Application Id used to authenticate against the Guidewire API

guidewireAgentOAuthAppId
string or null
_guidewireAgentOAuthScopes
string or null

The OAuth scopes to be granted within the Guidewire API

guidewireAgentOAuthScopes
string or null
id
integer or null <int32>
name
string or null
currentJobs
integer or null <int32>
gatewayId
integer or null <int32>
Array of objects or null (OpCon.Api.Data.Entities.MachineGroup)
lastUpdateDateTime
string or null
lastUpdate
number or null <double>
maximumJobs
integer or null <int32>
opConMaximumJobs
integer or null <int32>
socket
integer or null <int32>
object (OpCon.Api.Data.Entities.MachineStatus)
object (OpCon.Api.Data.Entities.LsamType)
Array of objects or null (OpCon.Api.Data.Entities.CrossReference.CrossReferenceMasterJob)
Array of objects or null (OpCon.Api.Data.Entities.CrossReference.CrossReferenceDailyJob)
acceptMessagesfromIp
string or null
agentAuthToken
string or null
agentCheckCrc
boolean or null
agentFileTransferPortNumberForTls
string or null
agentName
string or null
_agentSmaCommunicationsProtocol
string or null
agentSocket
string or null
agentSpecialFeatures
string or null
agentSupportNonTlsForSmaftAgent
string or null
agentSupportNonTlsForSmaftServer
string or null
agentSupportTlsForSmaftAgent
string or null
agentSupportTlsForSmaftServer
string or null
_allowKillJob
boolean or null
allowKillJob
boolean or null
Array of objects or null (OpCon.Api.Data.Entities.InstanceProperty) [ items ]
_checkCertificateRevocationList
boolean or null
checkCertificateRevocationList
boolean or null
checkCrc
string or null
checkMachineStatusInterval
integer or null <int32>
closeSocket
string or null
closeSocketDuringSynchronization
boolean or null
connectionAttemptTimeout
integer or null <int32>
consecutiveSendSleepTimeMilliseconds
integer or null <int32>
cpuCount
string or null
cpuId
string or null
cpuModel
string or null
cpuType
string or null
documentation
string or null
fileTransferFeature
string or null
fileTransferIpAddress
string or null
_fileTransferPortNumberForNonTls
integer or null <int32>
fileTransferPortNumberForNonTls
integer or null <int32>
_fileTransferPortNumberForTls
integer or null <int32>
fileTransferPortNumberForTls
integer or null <int32>
_fileTransferRole
string or null
fileTransferRole
string or null
fullFileTransferSupport
boolean or null
fullyQualifiedDomainName
string or null
gatewayName
string or null
hostname
string or null
jorsFeature
string or null
_jorsPortNumber
integer or null <int32>
jorsPortNumber
integer or null <int32>
jorsSocket
string or null
lsamTime
number or null <double>
lsamTimeDeltafromSam
integer or null <int32>
machineMaximumJobs
string or null
maxBytesReadPerMessage
integer or null <int32>
maxBytesSentPerMessage
integer or null <int32>
maxConsecutiveSendMessages
integer or null <int32>
noBufferRetryCount
integer or null <int32>
noBufferSleepTime
integer or null <int32>
osType
string or null
osVersion
string or null
pollInterval
integer or null <int32>
receiveBufferCount
integer or null <int32>
_requiresXmlEscape
boolean or null
requiresXmlEscape
boolean or null
resourceMonitorFeature
string or null
responseTimeoutInSeconds
integer or null <int32>
sendBufferCount
integer or null <int32>
smaCommunicationsProtocol
string or null
smaftAgentPort
string or null
smaftServerPortForNonTls
string or null
smaNetComIdentifier
string or null
smaNetComSocket
string or null
supportedAgentCapability
Array of strings or null
_supportNonTlsForSmaftAgent
boolean or null
supportNonTLSForSMAFTAgent
boolean or null
_supportNonTlsForSmaftServer
boolean or null
supportNonTLSForSMAFTServer
boolean or null
_supportTLSForSMAFTAgent
boolean or null
supportTLSForSMAFTAgent
boolean or null
_supportTLSForSMAFTServer
boolean or null
supportTLSForSMAFTServer
boolean or null
supportsHandshake
string or null
tcpIpAddress
string or null
timeOffsetfromSamInHours
number or null <double>
timeOffsetfromUtcInHours
number or null <double>
timeSent
string or null
timeZoneName
string or null