OpCon REST API (22.0.0.0)

Download OpenAPI specification:Download

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

AccessCodes

Get 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
IncludeSecuredDailyJobs
boolean

Flag to show/hide list of daily jobs secured by the access code

IncludeSecuredMasterJobs
boolean

Flag to show/hide list of master jobs secured by the access code

Name
string

Name of the calendar to fetch (Can accept ? and * wildcards)

Ids
string

Comma-separated list of calendar unique identifier values

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

Access code sort order

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

List of accessible codes

HasAdminAccess
boolean

Flag to determine admin access

SortBy
string

Options to sort access code by

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new access code and return it with its id, if successful

Sample request (this creates a new access code): 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 (CrossReferenceDailyJob)
Array of objects or null (CrossReferenceMasterJob)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "securedDailyJobs": [
    ],
  • "securedMasterJobs": [
    ]
}

Response samples

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

Get an access code for the id specified

Sample request (this returns the access code having id = 1): GET /api/accesscodes/1

Authorizations:
Token
path Parameters
id
required
integer <int32>

The unique identifier of the access code to fetch

Responses

Response samples

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

Update all properties of the access code specified by the id

Sample request (this updates the access code): PUT /api/accesscodes/1

{
    "id": 1,
    "name": "Operator"
}
Authorizations:
Token
path Parameters
id
required
integer <int32>

The access code id

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 (CrossReferenceDailyJob)
Array of objects or null (CrossReferenceMasterJob)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "securedDailyJobs": [
    ],
  • "securedMasterJobs": [
    ]
}

Response samples

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

Delete the access code specified by the id

Sample request: DELETE /api/accesscodes/1

Authorizations:
Token
path Parameters
id
required
integer <int32>

The unique identifier of the access code

Responses

BatchUsers

Get 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
Limit
integer <int32>
Offset
integer <int32>
Platform
string
PlatformId
integer <int32>
RoleName
string
LoginName
string
IncludeRoles
boolean
IncludeAssociations
boolean
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

Responses

Response samples

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

Create a new batch user and return it with its id, if successful

Sample request (this creates a new batch user):
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 (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

Array of objects or null (Role)

Roles associated with this batch user optional

Array of objects or null (CrossReferenceDailyJob)

Daily jobs associated with this batch user

Array of objects or null (CrossReferenceMasterJob)

Master jobs associated with this batch user

previousLoginName
string or null

Responses

Request samples

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

Response samples

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

Get a batch user for the id specified

Sample request (this returns the batch user with id = 1):
GET /api/batchusers/1

Authorizations:
Token
path Parameters
id
required
integer <int32>

The id of the batch user you want to get

Responses

Response samples

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

Update all properties of the Batch user specified by the id

Sample request (this updates the batch user):
PUT /api/BatchUsers/1
{
"platform": {
"id": 1,
"name": "Windows"
}
"loginName": "TestUser"
}

Authorizations:
Token
path Parameters
id
required
integer <int32>

The batch user id

Request Body schema:
id
integer or null <int32>

Id of the batch user

object (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

Array of objects or null (Role)

Roles associated with this batch user optional

Array of objects or null (CrossReferenceDailyJob)

Daily jobs associated with this batch user

Array of objects or null (CrossReferenceMasterJob)

Master jobs associated with this batch user

previousLoginName
string or null

Responses

Request samples

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

Response samples

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

Delete the batch user having 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>

The id of the batch user to delete

query Parameters
Ids
string
Limit
integer <int32>
Offset
integer <int32>
Platform
string
PlatformId
integer <int32>
RoleName
string
LoginName
string
IncludeRoles
boolean
IncludeAssociations
boolean
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

Responses

Calendars

Get 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
Type
integer <int32>

The type of the calendars to fetch

Name
string

The name of the calendar to fetch

Description
string

The description of the calendar to fetch

IncludeCrossReferences
boolean

Flag to include cross-references

Ids
string

List of unique identifiers to retrieve

Limit
integer <int32>

Limit the number of records to fetch

Offset
integer <int32>

Offset the number of records being fetched

SortOrders
Array of strings

Ordering options

HasAdminAccess
boolean

Flag for admin access

IgnoreCase
boolean

Use case-insensitive search criteria

SortBy
string

Option to sort values by different parameter fields

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new calendar and return 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 (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 (CalendarAssociation)

Responses

Request samples

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

Response samples

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

Get 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
Type
integer <int32>

The type of the calendars to fetch

Name
string

The name of the calendar to fetch

Description
string

The description of the calendar to fetch

IncludeCrossReferences
boolean

Flag to include cross-references

Ids
string

List of unique identifiers to retrieve

Limit
integer <int32>

Limit the number of records to fetch

Offset
integer <int32>

Offset the number of records being fetched

SortOrders
Array of strings

Ordering options

HasAdminAccess
boolean

Flag for admin access

IgnoreCase
boolean

Use case-insensitive search criteria

SortBy
string

Option to sort values by different parameter fields

Responses

Response samples

Content type
application/json
0
0

Get a calendar for the id specified

Sample request (this returns the calendar with id = 1 ): GET /api/calendars/1

Authorizations:
Token
path Parameters
id
required
integer <int32>

Id of the calendar to fetch.

Responses

Response samples

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

Update all properties of the calendar specified by the id

Sample request (this updates the calendar): PUT /api/calendar/1 { "id": 1, "name": "CalendarName", "dates": [ "03/16/2021", "06/02/2021" ] }

Authorizations:
Token
path Parameters
id
required
integer <int32>

The calendar id

Request Body schema:
id
integer or null <int32>

The id of the calendar

object (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 (CalendarAssociation)

Responses

Request samples

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

Response samples

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

Delete the calendar having the specified id

Sample request (This deletes a calendar with id = 11): DELETE /api/calendars/11

Authorizations:
Token
path Parameters
id
required
integer <int32>

The id of the calendar to delete

Responses

Delete calendar dates older than 30 days for the calendar having the provided id, and return the updated calendar, if successful

Sample request (this deletes dates older than 30 days for the calendar having the provided id): POST /api/calendars/10/deleteOldDates { "calendar": { "id": 10, // required, must match id in URL } }

Authorizations:
Token
path Parameters
id
required
integer <int32>

The id of the calendar

Request Body schema:

The calendar

id
integer or null <int32>

The id of the calendar

object (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 (CalendarAssociation)

Responses

Request samples

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

Response samples

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

Delete calendar dates older than 30 days from all calendars

Sample request (this deletes dates older than 30 days from all calendars): POST /api/calendars/deleteOldDates

Authorizations:
Token

Responses

DailyGraphEdges

Get a list of daily graph edges based on optional criteria specified

Sample request (this returns a list of all daily graph edges): GET /api/dailygraphedges?level=-1

Authorizations:
Token
query Parameters
ScheduleIds
string

Schedule ids to include

Level
integer <int32>

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

JobIds
string

Job ids to include

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

Schedule dates to include

Dates
string
PredecessorLevel
integer <int32>

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

SuccessorLevel
integer <int32>

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of daily graph edges by job id

Sample request (this returns a list of daily graph edges for the daily schedule having the id '20221229|1|1'): GET /api/dailygraphedges/20221229|1|1

Authorizations:
Token
path Parameters
id
required
string
query Parameters
ScheduleIds
string

Schedule ids to include

Level
integer <int32>

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

JobIds
string

Job ids to include

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

Schedule dates to include

Dates
string
PredecessorLevel
integer <int32>

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

SuccessorLevel
integer <int32>

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DailyJobEvent

Get 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
ScheduleId
required
integer <int32>
Instance
required
integer <int32>
ScheduleDate
required
string <date-time>
JobName
required
string
Id
required
string
jobId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Post a new daily job event

Sample request(this creates a single** daily job event**):
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
ScheduleId
required
integer <int32>
Instance
required
integer <int32>
ScheduleDate
required
string <date-time>
JobName
required
string
Id
required
string
jobId
required
string
Request Body schema:
required
object (DailyJobId)
required
object (SmaUserModel)
required
object
required
object (JobEventDetailsModel)
required
object (JobEventFrequencyModel)
id
integer <int32>

Responses

Request samples

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

Response samples

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

Put a daily job event

Sample request(this updates a single** daily job event**):
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": "********" } } To support legacy architecture, this returns the object as well.

Authorizations:
Token
path Parameters
ScheduleId
required
integer <int32>
Instance
required
integer <int32>
ScheduleDate
required
string <date-time>
JobName
required
string
Id
required
string
jobId
required
string
Request Body schema:
required
object (DailyJobId)
required
object (SmaUserModel)
required
object
required
object (JobEventDetailsModel)
required
object (JobEventFrequencyModel)
id
integer <int32>

Responses

Request samples

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

Response samples

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

Deletes daily job event

Sample request (this deletes a single daily job event):
DELETE /api/dailyJobs/{jobId}/events/{eventId}

Authorizations:
Token
path Parameters
ScheduleId
required
integer <int32>
Instance
required
integer <int32>
ScheduleDate
required
string <date-time>
JobName
required
string
Id
required
string
eventId
required
integer <int32>
jobId
required
string

Responses

DailyJobs

/api/dailyjobs

Authorizations:
Token
query Parameters
Uids
string
IncludeDocumentation
boolean
IncludeThresholdResourceDependencies
boolean
IncludeThresholdResourceUpdates
boolean
IncludeExpressionDependencies
boolean
IncludeDependencies
boolean
IncludeCount
boolean
IncludeDetails
boolean
IncludeEvents
boolean
TerminationDescription
string
JobName
string
Machine
string
StartMachine
string
PrimaryMachine
string
AlternateMachine
string
AlternateMachine2
string
AlternateMachine3
string
Reason
string
ScheduleDates
Array of integers <int32> [ items <int32 > ]
SortOrders
Array of strings
JobStatus
string
JobStatusCategories
Array of strings
JobType
string
PriorityValue
integer <int32>
ScheduleStatus
string
ScheduleName
string
Path
string
TagList
Array of strings
LimitValue
integer <int32>
OffsetValue
integer <int32>
DepartmentList
Array of integers <int32> [ items <int32 > ]
AccessCodeList
Array of integers <int32> [ items <int32 > ]
JobNumber
integer <int32>
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

Responses

/api/dailyjobs/{rawId}

Authorizations:
Token
path Parameters
rawId
required
string

Responses

/api/dailyjobs/{rawId}

Authorizations:
Token
path Parameters
rawId
required
string
Request Body schema:
uid
integer or null <int64>
uniqueJobId
string or null
object (DailyJobDetails)
object (DailyJobFeedback)
object (Department)
Array of objects or null (InstanceProperty)
steps
Array of strings or null
id
string or null
priority
integer <int32>
jobName
string or null
object (Frequency)

A frequency

jobNumber
integer <int32>
jorsRequestParameters
string or null
incidentTicketId
string or null
incidentTicketURL
string or null
object (LsamType)
object (AccessCode)

An access code with id and name fields

object (Machine)
object (Machine)
object (Machine)
object (Machine)
object (MachineGroup)
object (Machine)
tags
Array of strings or null
object (JobStatus)
object (DailySchedule)
terminationDescription
string or null
object (ComputedTime)
object (ComputedTime)
object (ComputedDuration)
object (DailyJobDocumentation)
Array of objects or null (DailyJobThresholdDependency)
Array of objects or null (DailyJobResourceDependency)
Array of objects or null (DailyJobThresholdResourceUpdate)
Array of objects or null (DailyJobThresholdResourceUpdate)
Array of objects or null (DailyJobDependency)
Array of objects or null (DailyJobEventModel)
object (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": [
    ],
  • "expressionDependencies": {
    },
  • "detailMessages": [
    ],
  • "isRecurrent": true,
  • "features": [
    ],
  • "currentStep": "string",
  • "jobGroup": 0,
  • "startMachineId": 0,
  • "startOffset": 0,
  • "startAbsoluteRelative": "string",
  • "lateToStartTime": 0,
  • "lateToStartAbsoluteRelative": "string",
  • "start": 0,
  • "termination": 0,
  • "estimatedRunTime": 0,
  • "lastUpdate": 0,
  • "maxMinutes": 0,
  • "originalJobName": "string",
  • "shortName": "string",
  • "calculatedStartTime": 0,
  • "startTimeIsEstimated": true,
  • "calculatedEndTime": 0,
  • "endTimeIsEstimated": true,
  • "calculatedDuration": 0,
  • "durationIsEstimated": true,
  • "subScheduleDailyName": "string",
  • "subScheduleDailyPath": "string",
  • "subScheduleDailyInstance": 0,
  • "subScheduleDailyId": 0,
  • "subScheduleDailyDate": 0,
  • "subScheduleMasterName": "string",
  • "subScheduleMasterId": 0
}

/api/dailyjobs/count

Authorizations:
Token
query Parameters
Uids
string
IncludeDocumentation
boolean
IncludeThresholdResourceDependencies
boolean
IncludeThresholdResourceUpdates
boolean
IncludeExpressionDependencies
boolean
IncludeDependencies
boolean
IncludeCount
boolean
IncludeDetails
boolean
IncludeEvents
boolean
TerminationDescription
string
JobName
string
Machine
string
StartMachine
string
PrimaryMachine
string
AlternateMachine
string
AlternateMachine2
string
AlternateMachine3
string
Reason
string
ScheduleDates
Array of integers <int32> [ items <int32 > ]
SortOrders
Array of strings
JobStatus
string
JobStatusCategories
Array of strings
JobType
string
PriorityValue
integer <int32>
ScheduleStatus
string
ScheduleName
string
Path
string
TagList
Array of strings
LimitValue
integer <int32>
OffsetValue
integer <int32>
DepartmentList
Array of integers <int32> [ items <int32 > ]
AccessCodeList
Array of integers <int32> [ items <int32 > ]
JobNumber
integer <int32>
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

Responses

/api/dailyjobs/count_by_status

Authorizations:
Token
query Parameters
Uids
string
IncludeDocumentation
boolean
IncludeThresholdResourceDependencies
boolean
IncludeThresholdResourceUpdates
boolean
IncludeExpressionDependencies
boolean
IncludeDependencies
boolean
IncludeCount
boolean
IncludeDetails
boolean
IncludeEvents
boolean
TerminationDescription
string
JobName
string
Machine
string
StartMachine
string
PrimaryMachine
string
AlternateMachine
string
AlternateMachine2
string
AlternateMachine3
string
Reason
string
ScheduleDates
Array of integers <int32> [ items <int32 > ]
SortOrders
Array of strings
JobStatus
string
JobStatusCategories
Array of strings
JobType
string
PriorityValue
integer <int32>
ScheduleStatus
string
ScheduleName
string
Path
string
TagList
Array of strings
LimitValue
integer <int32>
OffsetValue
integer <int32>
DepartmentList
Array of integers <int32> [ items <int32 > ]
AccessCodeList
Array of integers <int32> [ items <int32 > ]
JobNumber
integer <int32>
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

Responses

/api/dailyjobs/{rawId}/documentation

Authorizations:
Token
path Parameters
rawId
required
string

Responses

/api/dailyjobs/{rawId}/documentation

Authorizations:
Token
path Parameters
rawId
required
string
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"
}

/api/dailyjobs/{rawId}/documentation/{documentationId}

Authorizations:
Token
path Parameters
rawId
required
string
documentationId
required
integer <int32>

Responses

/api/dailyjobs/{rawId}/documentation/{documentationId}

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"
}

/api/dailyjobs/{rawId}/documentation/{documentationId}

Authorizations:
Token
path Parameters
rawId
required
string
documentationId
required
integer <int32>

Responses

/api/dailyjobs/{uid}/incidentTickets

Authorizations:
Token
path Parameters
uid
required
integer <int64>

Responses

/api/dailyjobs/{uid}/incidentTickets

Authorizations:
Token
path Parameters
uid
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"
}

/api/dailyjobs/{jId}/status

Authorizations:
Token
path Parameters
jId
required
string

Responses

/api/dailyjobs/{rawId}/properties

Authorizations:
Token
path Parameters
rawId
required
string

Responses

/api/dailyjobs/{rawId}/properties

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"
}

/api/dailyjobs/{rawId}/properties/{name}

Authorizations:
Token
path Parameters
rawId
required
string
name
required
string

Responses

/api/dailyjobs/{rawId}/properties/{name}

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"
}

/api/dailyjobs/{rawId}/properties/{name}

Authorizations:
Token
path Parameters
rawId
required
string
name
required
string

Responses

/api/dailyjobs/{uid}/incidentTickets/{id}

Authorizations:
Token
path Parameters
uid
required
integer <int64>
id
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"
}

/api/dailyjobs/{uid}/incidentTickets/{id}

Authorizations:
Token
path Parameters
uid
required
integer <int64>
id
required
string

Responses

/api/dailyjobs/{rawId}/events

Authorizations:
Token
path Parameters
rawId
required
string

Responses

/api/dailyjobs/{rawId}/events

Authorizations:
Token
path Parameters
rawId
required
string
Request Body schema:

Responses

Request samples

Content type
{ }

/api/dailyjobs/{rawId}/events/{eventId}

Authorizations:
Token
path Parameters
rawId
required
string
eventId
required
integer <int32>

Responses

/api/dailyjobs/{rawId}/Eventcollections/{eventId}

Authorizations:
Token
path Parameters
rawId
required
string
eventId
required
integer <int32>
Request Body schema:

Responses

Request samples

Content type
{ }

/api/dailyjobs/{rawId}/Eventcollections/{EventGroupId}

Authorizations:
Token
path Parameters
rawId
required
string
eventId
required
integer <int32>
EventGroupId
required
string

Responses

Get a list of daily job expression dependencies

Sample request (this returns a list of expression dependencies in ascending order):
GET /api/dailyJobs/{dailyJobId}/expressionDependencies

Authorizations:
Token
path Parameters
rawId
required
string

The daily job unique identifier

Responses

Post a single expression dependencies

Sample request (this creates a single expression dependency):
POST /api/dailyJobs/{dailyJobId}/expressionDependencies/ { "expression1": "someExpression", "expression2": "expressionTwo" }

Authorizations:
Token
path Parameters
rawId
required
string

The daily job indentifier

Request Body schema:

The expression dependency object with new values

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"
}

Get a daily job expression dependency for the id specified

Sample request (this returns a expression dependency in ascending order):
GET /api/dailyJobs/{dailyJobId}/expressionDependencies/{expressionId}

Authorizations:
Token
path Parameters
rawId
required
string

The daily job identifier

expressionId
required
integer <int32>

The expression dependency identifier

Responses

Put a single expression dependencies

Sample request (this updates a single expression dependency):
PUT /api/dailyJobs/{dailyJobId}/expressionDependencies/{expressionId} { "id": 1, "expression1": "someExpression", "expression2": "expressionTwo" }

Authorizations:
Token
path Parameters
rawId
required
string

The daily job indentifier

expressionId
required
integer <int32>

The expression dependency identifier

Request Body schema:

The expression dependency object with update values

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"
}

Deletes a single expression dependencies

Sample request (this deletes a single expression dependency):
DELETE /api/dailyJobs/{dailyJobId}/expressionDependencies/{expressionId}

Authorizations:
Token
path Parameters
rawId
required
string

The daily job indentifier

expressionId
required
integer <int32>

The expression dependency identifier

Request Body schema:

The expression dependency object with values to delete

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"
}

/api/dailyjobs/{rawId}/resourceDependencies

Authorizations:
Token
path Parameters
rawId
required
string

Responses

/api/dailyjobs/{rawId}/resourceDependencies

Authorizations:
Token
path Parameters
rawId
required
string
Request Body schema:
id
integer or null <int32>
object (Resource)
requires
integer or null <int32>
requiresAll
boolean or null
object (Frequency)

A frequency

Responses

Request samples

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

/api/dailyjobs/{rawId}/resourceDependencies/{resourceId}

Authorizations:
Token
path Parameters
rawId
required
string
resourceId
required
integer <int32>

Responses

/api/dailyjobs/{rawId}/resourceDependencies/{resourceId}

Authorizations:
Token
path Parameters
rawId
required
string
resourceId
required
integer <int32>
Request Body schema:
id
integer or null <int32>
object (Resource)
requires
integer or null <int32>
requiresAll
boolean or null
object (Frequency)

A frequency

Responses

Request samples

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

/api/dailyjobs/{rawId}/resourceDependencies/{resourceId}

Authorizations:
Token
path Parameters
rawId
required
string
resourceId
required
integer <int32>

Responses

/api/dailyjobs/{rawId}/thresholdDependencies

Authorizations:
Token
path Parameters
rawId
required
string

Responses

/api/dailyjobs/{rawId}/thresholdDependencies

Authorizations:
Token
path Parameters
rawId
required
string
Request Body schema:
id
integer or null <int32>
object (Threshold)
value
integer <int32>
operator
string or null
object (Frequency)

A frequency

Responses

Request samples

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

/api/dailyjobs/{rawId}/thresholdDependencies/{thresholdId}

Authorizations:
Token
path Parameters
rawId
required
string
thresholdId
required
integer <int32>

Responses

/api/dailyjobs/{rawId}/thresholdDependencies/{thresholdId}

Authorizations:
Token
path Parameters
rawId
required
string
thresholdId
required
integer <int32>
Request Body schema:
id
integer or null <int32>
object (Threshold)
value
integer <int32>
operator
string or null
object (Frequency)

A frequency

Responses

Request samples

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

/api/dailyjobs/{rawId}/thresholdDependencies/{thresholdId}

Authorizations:
Token
path Parameters
rawId
required
string
thresholdId
required
integer <int32>

Responses

DailyJobsDependencies

Get a list of job dependencies for the daily job specified

Sample request (this returns a list of job dependencies for a daily job with id '20210101|15|1|Job1'):
GET /api/dailyjobs/20210101|15|1|Job1/dependencies

Authorizations:
Token
path Parameters
jobId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update the job dependencies for the daily job specified

Sample request (this updates the job dependencies for a daily job with id '20210101|15|1|Job1'):
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 (Frequency)

A frequency

object (DailyJobDependencyType)

A job dependency type

object (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
application/json
[
  • {
    }
]

Add a job dependency for the daily job specified

Sample request (this adds a job dependency for a daily job with id '20210101|15|1|Job1'):
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 (Frequency)

A frequency

object (DailyJobDependencyType)

A job dependency type

object (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
application/json
{
  • "scheduleId": 0,
  • "scheduleInstanceNumber": 0,
  • "jobName": "string",
  • "id": 0,
  • "frequency": {
    },
  • "type": {
    },
  • "predecessor": {
    },
  • "scheduleDate": 0,
  • "isSatisfied": true
}

Get a job dependency for the daily job and job dependency id specified

Sample request (this returns a job dependency with id '2' for a daily job with id '20210101|15|1|Job1'):
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
application/json
{
  • "scheduleId": 0,
  • "scheduleInstanceNumber": 0,
  • "jobName": "string",
  • "id": 0,
  • "frequency": {
    },
  • "type": {
    },
  • "predecessor": {