API docs by Redocly

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": {
    },
  • "scheduleDate": 0,
  • "isSatisfied": true
}

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

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

Delete a job dependency with the daily job and job dependency id specified

Sample request (this deletes a job dependency with id '2' for a daily job with id '20210101|15|1|Job1'):
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
application/json
[
  • {
    }
]

DailySchedules

Get the total count of daily schedules based on optional criteria specified.

Sample request (this returns the total count of daily schedules):

GET /api/dailyschedules/count_by_status

Authorizations:
Token
query Parameters
IncludeAll
boolean

Flag to include schedule properties, details, and events

IncludeProperties
boolean

Flag to include schedule properties

IncludeDetails
boolean

Flag to include schedule details

IncludeEvents
boolean

Flag to include schedule events

uids
string
SortOrders
Array of strings

Daily schedule sort order

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

Daily schedule dates to include

ScheduleCategories
Array of strings

Daily schedule categories to include

Ids
string
Name
string

The schedule name (Can accept ? and * wildcards)

Status
string

The schedule status

Categories
string
FailedJobs
boolean
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

Dates
string

Responses

Response samples

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

Get a list of dates on which the daily schedules built based on optional criteria provided.

Sample request (this returns a list of dates on which the SMA Utility schedule was built):

GET /api/dailyschedules/dates?name=SMA Utility

Authorizations:
Token
query Parameters
IncludeAll
boolean

Flag to include schedule properties, details, and events

IncludeProperties
boolean

Flag to include schedule properties

IncludeDetails
boolean

Flag to include schedule details

IncludeEvents
boolean

Flag to include schedule events

uids
string
SortOrders
Array of strings

Daily schedule sort order

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

Daily schedule dates to include

ScheduleCategories
Array of strings

Daily schedule categories to include

Ids
string
Name
string

The schedule name (Can accept ? and * wildcards)

Status
string

The schedule status

Categories
string
FailedJobs
boolean
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

Dates
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get the details for the daily schedules based on schedule id.

Sample request (this returns the details for daily schedules having id '20221228|1|1'):

GET /api/dailyschedules/20221228|1|1/details

Authorizations:
Token
path Parameters
id
required
string

The daily schedule id

Responses

Response samples

Content type
application/json
{
  • "documentation": "string",
  • "deployInformation": {
    }
}

Get the details for the daily schedules based on optional criteria provided.

Sample request (this returns the daily schedule having id '20221228|1|1'):

GET /api/dailyschedules/20221228|1|1

Authorizations:
Token
path Parameters
id
required
string

The daily schedule id

Responses

Response samples

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

Update the daily schedules based on optional criteria provided.

Sample request (Updates the daily schedule having id '20221228|1|1'):

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

The daily schedule id

Request Body schema:

The daily schedule to update

uid
integer or null <int64>

The unique id

Array of objects or null (InstanceProperty)

List of instance properties

dateAsInteger
integer <int32>
id
string or null

The daily schedule id

masterId
integer <int32>

The schedule id

object (DailyScheduleDetails)
object (ComputedTime)
definedStartTime
string or null

The defined start time

endTime
string or null

The end time

name
string or null

The schedule name

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

Get the daily schedules based on optional criteria provided.

Sample request (this returns the details for daily schedules having name 'SMA Utility'):

GET /api/dailyschedules?name=SMA Utility

Authorizations:
Token
query Parameters
IncludeAll
boolean

Flag to include schedule properties, details, and events

IncludeProperties
boolean

Flag to include schedule properties

IncludeDetails
boolean

Flag to include schedule details

IncludeEvents
boolean

Flag to include schedule events

uids
string
SortOrders
Array of strings

Daily schedule sort order

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

Daily schedule dates to include

ScheduleCategories
Array of strings

Daily schedule categories to include

Ids
string
Name
string

The schedule name (Can accept ? and * wildcards)

Status
string

The schedule status

Categories
string
FailedJobs
boolean
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

Dates
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all properties for the specified daily schedule.

Sample request (this returns the properties for daily schedules having id '20221228|1|1'):

GET /api/dailyschedules/20221228|1|1/properties/

Authorizations:
Token
path Parameters
id
required
string

The daily schedule id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a property to the daily schedule with the provided id.

Sample request (Adds a property to the daily schedule having id '20221228|1|1'):

POST /api/dailyschedules/20221228|1|1/properties

{
    "key": "prop1",
    "value": "updatedValue"
}
Authorizations:
Token
path Parameters
id
required
string

The daily schedule id

Request Body schema:

The instance properties to add

key
string or null
value
string or null

Responses

Request samples

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

Response samples

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

Get the specified property on the specified daily schedule.

Sample request (Gets the property having key 'prop1' on the daily schedule having id '20221228|1|1'):

GET /api/dailyschedules/20221228|1|1/properties/prop1

Authorizations:
Token
path Parameters
id
required
string

The daily schedule id

name
required
string

The name of the property

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Update the specified property for the daily schedule having the id provided.

Sample request (Updates the property having key 'prop1' from the daily schedule having id '20221228|1|1'):

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

{
    "key": "prop1",
    "value": "updatedValue"
}
Authorizations:
Token
path Parameters
id
required
string

The daily schedule id

name
required
string

The name of the instance property to update

Request Body schema:

The instance property to update

key
string or null
value
string or null

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Delete the specified instance property from daily schedule having the specified id.

Sample request (Deletes the property having key 'prop1' from the daily schedule having id '20221228|1|1'):

DELETE /api/dailyschedules/20221228|1|1/properties/prop1

Authorizations:
Token
path Parameters
id
required
string

The daily schedule id

name
required
string

The name of the property to delete

Responses

DailyVisionWorkspaces

Get 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

Get the daily vision workspace with the specified id.

Sample request:

GET /api/dailyvisionworkspaces/1

Authorizations:
Token
path Parameters
id
required
integer <int32>

Workspace id - must be 1.

query Parameters
DayOffset
integer <int32>

Offset in days from today

IncludeCardsWithoutStatus
boolean

Flag to include cards without status

Responses

DeleteActions

/api/DeleteActions/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Deletes a collection of jobs based on a given jobId, scheduleId, or date range.

Authorizations:
Token
Request Body schema:

The OpCon.Api.Data.Services.QueuedDelete.QueuedDeleteRequest request containing one or more request items.

required
Array of objects (QueuedDeleteRequestItem)

Responses

Request samples

Content type
{
  • "items": [
    ]
}

Departments

Get a department for the id specified

Sample request (this returns the department with id = 1):
GET /api/departments/1

Authorizations:
Token
path Parameters
id
required
integer <int32>

The id of the department you want to get

Responses

Response samples

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

Update all properties of the department specified by the id

Sample request (this updates the department): PUT /api/calendar/1

{
    "id": 1,
    "name": "updatedDepartment",
    "documentation": "updated documentation"

}
Authorizations:
Token
path Parameters
id
required
integer <int32>

The department id

Request Body schema:
id
integer <int32>
name
string or null

The name of the department

documentation
string or null
object (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
application/json
{
  • "id": 0,
  • "name": "string",
  • "documentation": "string",
  • "associations": {
    },
  • "scheduleId": 0,
  • "scheduleName": "string",
  • "jobName": "string",
  • "dailyScheduleId": 0,
  • "dailyScheduleName": "string",
  • "dailyJobName": "string",
  • "dailyJobDate": 0,
  • "role": "string"
}

Delete the department having the specified id

Sample request (This deletes a department with id = 11): DELETE /api/departments/11

Authorizations:
Token
path Parameters
id
required
integer <int32>

The id of the department to delete

Responses

Get 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 name of the department to fetch

Limit
integer <int32>

Limit the number of records to fetch

Offset
integer <int32>

Offset the number of records being fetched

Ids
string

List of unique identifiers to retrieve

SortOrders
Array of strings

Ordering options

BasicDetails
boolean

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

HasAdminAccess
boolean

Flag for admin access

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

Option to sort values by different parameter fields

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Sample request (this creates a new department): POST /api/departments { "name": "deptName", "documentation": "about this department" }

Authorizations:
Token
Request Body schema:
id
integer <int32>
name
string or null

The name of the department

documentation
string or null
object (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
application/json
{
  • "id": 0,
  • "name": "string",
  • "documentation": "string",
  • "associations": {
    },
  • "scheduleId": 0,
  • "scheduleName": "string",
  • "jobName": "string",
  • "dailyScheduleId": 0,
  • "dailyScheduleName": "string",
  • "dailyJobName": "string",
  • "dailyJobDate": 0,
  • "role": "string"
}

Escalation

Get a list of escalations tied to a user.

Sample request (this returns a list of escalations tied to a user in descending order):
GET /api/escalations

Authorizations:
Token
path Parameters
userId
required
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Acknowledge escalations by bulk

Sample request (this updates the escalation):
PUT /api/users/0/escalations/
[ {
"escalationId": 1,
"acknowledged": true }, {
"escalationId": 2,
"acknowledged": true } ]

Authorizations:
Token
path Parameters
userId
required
integer <int32>

The user unique identifier

Request Body schema:

Collection of escalations

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 (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 (Escalation) Recursive

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "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": { }
}

Get an escalation for the unique identifier specified tied to the user

Sample request (this returns the escalation with id = 1 for user id = 0):
GET /api/users/0/escalation/1

Authorizations:
Token
path Parameters
userId
required
integer <int32>
escalationId
required
integer <int32>

The unique identifier of escalation to retrieve

Responses

Response samples

Content type
application/json
{
  • "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": { }
}

Acknowledge escalation specified by the id

Sample request (this updates the escalation):
PUT /api/users/0/escalations/1
{
"escalationId": 1,
"acknowledged": true }

Authorizations:
Token
path Parameters
userId
required
integer <int32>

The user unique identifier

escalationId
required
integer <int32>

The escalation unique identifier

Request Body schema:

The escalation

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 (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 (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
application/json
{
  • "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": { }
}

EscalationGroups

/api/EscalationGroups

Authorizations:
Token
query Parameters
Name
string
Ids
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new escalation group and return it with its id, if successful.

Sample request (this creates a new escalation group):
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 (EscalationGroupUserModel) non-empty

Responses

Request samples

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

Response samples

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

/api/EscalationGroups/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Response samples

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

Delete the escalation group specified by the id

Sample request (this deletes the escalation group):
DELETE /api/escalationGroups/1

Authorizations:
Token
path Parameters
id
required
integer <int32>

The unique identifier of the escalation group

Responses

Response samples

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

/api/EscalationGroups/users

Authorizations:
Token

Responses

Response samples

Content type
application/json
{
  • "userId": 0,
  • "userSignon": "string"
}

Update all properties of the escalation group specified by the id

Sample request (this updates the escalation group):
PUT /api/escalationgroups/1
{ "Name": "Testing", "Users": [ { "UserId": 0, "UserSignon": "ocadm" }, { "UserId": -1, "UserSignon": "[[UserToken]]" } ] }

Authorizations:
Token
path Parameters
groupId
required
integer <int32>

The escalation group id

Request Body schema:
name
required
string non-empty
required
Array of objects (EscalationGroupUserModel) non-empty

Responses

Request samples

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

Response samples

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

EscalationRules

/api/EscalationRules

Authorizations:
Token
query Parameters
Name
string
Ids
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new escalation rule and return it with its id, if successful.

Sample request (this creates a new escalation rule):
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 (EscalationSequenceModel) non-empty

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "hasActiveEscalation": true,
  • "name": "string",
  • "sequences": [
    ],
  • "crossReferences": [
    ]
}

/api/EscalationRules/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "hasActiveEscalation": true,
  • "name": "string",
  • "sequences": [
    ],
  • "crossReferences": [
    ]
}

Delete the escalation rule specified by the id

Sample request (this deletes the escalation rule with id = 1):
DELETE /api/escalationRules/1

Authorizations:
Token
path Parameters
id
required
integer <int32>

The unique identifier of the escalation rule

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "hasActiveEscalation": true,
  • "name": "string",
  • "sequences": [
    ],
  • "crossReferences": [
    ]
}

Update all properties of the escalation rule specified by the id

Sample request (this updates the escalation rule):
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>

The escalation rule id

Request Body schema:
name
required
string non-empty
required
Array of objects (EscalationSequenceModel) non-empty

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "hasActiveEscalation": true,
  • "name": "string",
  • "sequences": [
    ],
  • "crossReferences": [
    ]
}

EventsMetadata

/api/metadata/events

Authorizations:
Token

Responses

ExternalToken

Create a 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 having 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
application/json
{
  • "token": "string",
  • "length": 0
}

Features

/api/features

Authorizations:
Token
query Parameters
object (FeatureCriteria)

Responses

Feedback

Get a list of feeback values based on optional criteria specified

Sample request (this returns a list of feedback values by jobType):
GET /api/feedback?jobType=6

Authorizations:
Token
query Parameters
JobTypeId
integer <int32>
Name
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Frequencies

Get a list of frequencies based on optional criteria specified.

Sample request:

GET /api/frequencies

Authorizations:
Token
query Parameters
Name
string

The name of the frequency to fetch

Skdid
integer <int32>

The Schedule ID to fetch frequencies for

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

Aobn
string

The aobn of the frequencies to fetch

Calendar
string

The Calendar Name of the frequencies to fetch

InUse
integer <int32>
HasAdminAccess
boolean

Flag for admin access

IgnoreCase
boolean

Flag for case insensitive search

IncludeAssociations
boolean

Flag to specify if associations will be included in the frequencies fetched

DuplicateFrequencyCodes
boolean

Flag to specify frequencies returned will be only those with duplicate settings.

BasicDetails
boolean

Flag to specify frequencies will be returned only with basic details.

SortBy
string

Option to sort values by different parameter fields

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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:

The frequency to add.

name
string or null

The name of the frequency

frequencyCode
integer <int32>

The frequency code

inUse
integer or null <int32>

The quantity of schedules and/or jobs using the frequency

object (FrequencySettings)

Frequency settings

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "scheduleId": 0,
  • "jobName": "string",
  • "frequencyCode": 0,
  • "calendarId": 0,
  • "aobn": 0,
  • "frequencyPriority": 0,
  • "name": "string",
  • "finishOkBehavior": {
    },
  • "startTimeEstimation": {
    },
  • "jobExecution": {
    },
  • "retryBehavior": {
    },
  • "jobTimesEstimation": {
    },
  • "overlapAction": "string",
  • "maximumAttempts": 0,
  • "minutesBetweenAttempts": 0,
  • "startTimeEstimationSource": "string",
  • "predictedStartTimeOffset": "string",
  • "recurringInstanceTimes": [
    ],
  • "lateToFinishOffset": "string",
  • "lateToStartOffset": "string",
  • "minutesFromStartToStart": 0,
  • "minutesFromEndToStart": 0,
  • "latestRunTime": "string",
  • "numberOfRuns": 0,
  • "parentDoubleScheduleTime": 0,
  • "parentDoubleScheduleDate": 0,
  • "startOffset": "string",
  • "startOffsetTimeFormat": "string",
  • "latestStartOffset": "string",
  • "latestStartOffsetTimeFormat": "string",
  • "estimatedRunTime": 0,
  • "samPriority": 0,
  • "maxRunTime": 0,
  • "startStatus": {
    }
}

Get a frequency by name.

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

GET /api/frequencies/frequencyName?name:desc

Authorizations:
Token
path Parameters
name
required
string

The name of the frequency

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "frequencyCode": 0,
  • "inUse": 0,
  • "settings": {
    }
}

Update the frequency specified by the 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

The name of the frequency to update

Request Body schema:

The frequency to update

name
string or null

The name of the frequency

frequencyCode
integer <int32>

The frequency code

inUse
integer or null <int32>

The quantity of schedules and/or jobs using the frequency

object (FrequencySettings)

Frequency settings

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "scheduleId": 0,
  • "jobName": "string",
  • "frequencyCode": 0,
  • "calendarId": 0,
  • "aobn": 0,
  • "frequencyPriority": 0,
  • "name": "string",
  • "finishOkBehavior": {
    },
  • "startTimeEstimation": {
    },
  • "jobExecution": {
    },
  • "retryBehavior": {
    },
  • "jobTimesEstimation": {
    },
  • "overlapAction": "string",
  • "maximumAttempts": 0,
  • "minutesBetweenAttempts": 0,
  • "startTimeEstimationSource": "string",
  • "predictedStartTimeOffset": "string",
  • "recurringInstanceTimes": [
    ],
  • "lateToFinishOffset": "string",
  • "lateToStartOffset": "string",
  • "minutesFromStartToStart": 0,
  • "minutesFromEndToStart": 0,
  • "latestRunTime": "string",
  • "numberOfRuns": 0,
  • "parentDoubleScheduleTime": 0,
  • "parentDoubleScheduleDate": 0,
  • "startOffset": "string",
  • "startOffsetTimeFormat": "string",
  • "latestStartOffset": "string",
  • "latestStartOffsetTimeFormat": "string",
  • "estimatedRunTime": 0,
  • "samPriority": 0,
  • "maxRunTime": 0,
  • "startStatus": {
    }
}

Gets a frequency forecast based on the request provided.

Sample request:

POST /api/frequencies/frequencyName/settings

{
    "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:

The frequency forecast request

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> (ForecastTypes)
Enum: 0 1 2 3
required
Array of objects (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
application/json
[
  • {
    }
]

FrequencyNames

Get a list of frequencies names

Sample request:

GET /api/frequencyNames

Authorizations:
Token
query Parameters
Name
string

The name of the frequency to fetch

Skdid
integer <int32>

The Schedule ID to fetch frequencies for

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

Aobn
string

The aobn of the frequencies to fetch

Calendar
string

The Calendar Name of the frequencies to fetch

InUse
integer <int32>
HasAdminAccess
boolean

Flag for admin access

IgnoreCase
boolean

Flag for case insensitive search

IncludeAssociations
boolean

Flag to specify if associations will be included in the frequencies fetched

DuplicateFrequencyCodes
boolean

Flag to specify frequencies returned will be only those with duplicate settings.

BasicDetails
boolean

Flag to specify frequencies will be returned only with basic details.

SortBy
string

Option to sort values by different parameter fields

Responses

Response samples

Content type
application/json
[
  • "string"
]

GlobalProperties

Get 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>
Offset
integer <int32>
Name
string
Encrypted
string
Ids
string
Value
string
NameOrValue
string
NoPatternValue
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,
  • "name": "string",
  • "value": "string",
  • "documentation": "string",
  • "encrypted": true,
  • "fullName": "string",
  • "category": "string",
  • "isPatternValue": true,
  • "type": "string",
  • "isEncrypted": "string"
}

Create a new global property and return it with its id, if successful

Sample request (This creates a new global property): POST /api/globalproperties { "name": "GP1", "value": "GP Value" }

Authorizations:
Token
Request Body schema:

The global property

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)

isEncrypted
string or null

Responses

Request samples

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

Response samples

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

Get a global property with the id specified

Sample request (this returns a global property with id = 1): GET /api/globalproperties/1

Authorizations:
Token
path Parameters
id
required
integer <int32>

The id of the global property you want to get

Responses

Response samples

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

Update all properties of the global property specified by the id

Sample request (this updates the global property): POST /api/globalproperties/1 { "id": 1, "name": "GP1", "value": "GP Value" }

Authorizations:
Token
path Parameters
id
required
integer <int32>

The global property id

Request Body schema:

The global property

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)

isEncrypted
string or null

Responses

Request samples

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

Response samples

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

Delete the global property having the specified ed

Sample request (This deletes a global property with id = 22): DELETE /api/globalproperties/22

Authorizations:
Token
path Parameters
id
required
integer <int32>

The id of the global property to delete

Responses

HistoryJob

Get a list of job histories based on optional criteria specified

Sample request (this returns a list of job histories from 03-16-2021 to 03-17-2021):

GET /api/jobhistories?from=03-16-2021&to=03-17-2021

Authorizations:
Token
query Parameters
From
string
To
string
ScheduleName
string
JobName
string
Duration
integer <int32>
JobStatusIds
string
RunDate
string
SchedulePath
string
MachineName
string
Offset
integer <int32>
Limit
integer <int32>
IncludeSummary
boolean
PermissionIds
string
UniqueId
string
JobInstanceNumber
integer <int32>
UniqueJobIds
string

Responses

Response samples

Content type
application/json
{
  • "exitDescription": "string",
  • "jobTerminationDouble": 0,
  • "jobStartDouble": 0,
  • "parentJobName": "string",
  • "frequencyName": "string",
  • "departmentId": 0,
  • "scheduleDate": 0,
  • "scheduleId": 0,
  • "schedulePath": "string",
  • "scheduleName": "string",
  • "uid": 0,
  • "fcMaxValues": 0,
  • "id": "string",
  • "jobName": "string",
  • "jobNumber": 0,
  • "jobType": {
    },
  • "scheduleHistory": {
    },
  • "jobStartTime": "string",
  • "jobStatus": {
    },
  • "jobTermination": "string",
  • "duration": 0,
  • "machine": {
    },
  • "exitCode": "string",
  • "department": {
    },
  • "frequency": {
    },
  • "tokenReplacementValues": [
    ],
  • "jobStatusDescriptions": [
    ],
  • "jorsRequestParameters": "string",
  • "tags": [
    ],
  • "agentStartCommand": "string",
  • "detailMessages": [
    ],
  • "jobHistoryNotes": [
    ],
  • "tokenValues": [
    ],
  • "fileTransferJobStatusDescriptions": [
    ],
  • "windowsJobStatusDescriptions": [
    ],
  • "openVMSJobStatusDescriptions": [
    ],
  • "ibMiJobStatusDescriptions": [
    ],
  • "unixJobStatusDescriptions": [
    ],
  • "oS2200JobStatusDescriptions": [
    ],
  • "vseJobStatusDescriptions": [
    ],
  • "mcpJobStatusDescriptions": [
    ],
  • "bisJobStatusDescriptions": [
    ],
  • "zOSJobStatusDescriptions": [
    ],
  • "sapR3_CRMJobStatusDescriptions": [
    ],
  • "sapbwJobStatusDescriptions": [
    ],
  • "containerJobStatusDescriptions": [
    ],
  • "jeeJobStatusDescriptions": [
    ],
  • "javaJobStatusDescriptions": [
    ],
  • "tuxedoARTJobStatusDescriptions": [
    ],
  • "easeJobStatusDescriptions": [
    ],
  • "asyscoAMTJobStatusDescriptions": [
    ],
  • "sqlJobStatusDescriptions": [
    ]
}

Get a list of job history notes for the given job id

Sample request (returns a list of notes for the job history with the specified job id):

GET /api/jobhistories/2021|03|16|someJob/notes

Authorizations:
Token
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "exitDescription": "string",
  • "jobTerminationDouble": 0,
  • "jobStartDouble": 0,
  • "parentJobName": "string",
  • "frequencyName": "string",
  • "departmentId": 0,
  • "scheduleDate": 0,
  • "scheduleId": 0,
  • "schedulePath": "string",
  • "scheduleName": "string",
  • "uid": 0,
  • "fcMaxValues": 0,
  • "id": "string",
  • "jobName": "string",
  • "jobNumber": 0,
  • "jobType": {
    },
  • "scheduleHistory": {
    },
  • "jobStartTime": "string",
  • "jobStatus": {
    },
  • "jobTermination": "string",
  • "duration": 0,
  • "machine": {
    },
  • "exitCode": "string",
  • "department": {
    },
  • "frequency": {
    },
  • "tokenReplacementValues": [
    ],
  • "jobStatusDescriptions": [
    ],
  • "jorsRequestParameters": "string",
  • "tags": [
    ],
  • "agentStartCommand": "string",
  • "detailMessages": [
    ],
  • "jobHistoryNotes": [
    ],
  • "tokenValues": [
    ],
  • "fileTransferJobStatusDescriptions": [
    ],
  • "windowsJobStatusDescriptions": [
    ],
  • "openVMSJobStatusDescriptions": [
    ],
  • "ibMiJobStatusDescriptions": [
    ],
  • "unixJobStatusDescriptions": [
    ],
  • "oS2200JobStatusDescriptions": [
    ],
  • "vseJobStatusDescriptions": [
    ],
  • "mcpJobStatusDescriptions": [
    ],
  • "bisJobStatusDescriptions": [
    ],
  • "zOSJobStatusDescriptions": [
    ],
  • "sapR3_CRMJobStatusDescriptions": [
    ],
  • "sapbwJobStatusDescriptions": [
    ],
  • "containerJobStatusDescriptions": [
    ],
  • "jeeJobStatusDescriptions": [
    ],
  • "javaJobStatusDescriptions": [
    ],
  • "tuxedoARTJobStatusDescriptions": [
    ],
  • "easeJobStatusDescriptions": [
    ],
  • "asyscoAMTJobStatusDescriptions": [
    ],
  • "sqlJobStatusDescriptions": [
    ]
}

Update a list of job history notes for the given job id

Sample request (updates the history job note for the job with the specified id):

PUT /api/jobhistories/2021|03|16|jobName/notes

Authorizations:
Token
path Parameters
id
required
string

The job id

Request Body schema:

The job history note to update

jobId
string or null
Array of objects or null (Note)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "exitDescription": "string",
  • "jobTerminationDouble": 0,
  • "jobStartDouble": 0,
  • "parentJobName": "string",
  • "frequencyName": "string",
  • "departmentId": 0,
  • "scheduleDate": 0,
  • "scheduleId": 0,
  • "schedulePath": "string",
  • "scheduleName": "string",
  • "uid": 0,
  • "fcMaxValues": 0,
  • "id": "string",
  • "jobName": "string",
  • "jobNumber": 0,
  • "jobType": {
    },
  • "scheduleHistory": {
    },
  • "jobStartTime": "string",
  • "jobStatus": {
    },
  • "jobTermination": "string",
  • "duration": 0,
  • "machine": {
    },
  • "exitCode": "string",
  • "department": {
    },
  • "frequency": {
    },
  • "tokenReplacementValues": [
    ],
  • "jobStatusDescriptions": [
    ],
  • "jorsRequestParameters": "string",
  • "tags": [
    ],
  • "agentStartCommand": "string",
  • "detailMessages": [
    ],
  • "jobHistoryNotes": [
    ],
  • "tokenValues": [
    ],
  • "fileTransferJobStatusDescriptions": [
    ],
  • "windowsJobStatusDescriptions": [
    ],
  • "openVMSJobStatusDescriptions": [
    ],
  • "ibMiJobStatusDescriptions": [
    ],
  • "unixJobStatusDescriptions": [
    ],
  • "oS2200JobStatusDescriptions": [
    ],
  • "vseJobStatusDescriptions": [
    ],
  • "mcpJobStatusDescriptions": [
    ],
  • "bisJobStatusDescriptions": [
    ],
  • "zOSJobStatusDescriptions": [
    ],
  • "sapR3_CRMJobStatusDescriptions": [
    ],
  • "sapbwJobStatusDescriptions": [
    ],
  • "containerJobStatusDescriptions": [
    ],
  • "jeeJobStatusDescriptions": [
    ],
  • "javaJobStatusDescriptions": [
    ],
  • "tuxedoARTJobStatusDescriptions": [
    ],
  • "easeJobStatusDescriptions": [
    ],
  • "asyscoAMTJobStatusDescriptions": [
    ],
  • "sqlJobStatusDescriptions": [
    ]
}

ImpEx

/api/impex/schedules

Authorizations:
Token
query Parameters
Ids
Array of integers <int32> [ items <int32 > ]
Name
string
Offset
integer <int32>
Limit
integer <int32>
AutoBuild
boolean
MultiInstance
boolean
SubSchedule
boolean
SortBy
string
IncludeDetails
boolean
IncludeScheduleHierachy
boolean
CaseSensitive
boolean

Responses

/api/impex/schedules

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 (ImpExSubSchedule)
hasJobLevelFrequencies
boolean
object (WeekDays)
object (StartOffset)
useMasterHoliday
boolean
object (Calendar)

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

conflictsWithOtherDays
boolean
object (AutoBuildSettings)
object (SingleInstanceProperties)
object (MultiInstanceProperties)
object (CrossReference)

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

/api/impex/schedules/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/impex/schedules/{id}

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 (ImpExSubSchedule)
hasJobLevelFrequencies
boolean
object (WeekDays)
object (StartOffset)
useMasterHoliday
boolean
object (Calendar)

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

conflictsWithOtherDays
boolean
object (AutoBuildSettings)
object (SingleInstanceProperties)
object (MultiInstanceProperties)
object (CrossReference)

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

/api/impex/schedules/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>
query Parameters
forceDelete
boolean

Responses

/api/impex/schedules/{id}/crossreferences

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

JobActions

/api/jobactions/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/jobactions

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

JobInstanceActions

/api/jobinstanceactions/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/jobinstanceactions

Authorizations:
Token
Request Body schema:
id
integer <int32>
action
string or null
actionType
integer <int32> (ActionType)
Enum: 0 1 2
result
string or null
message
string or null
Array of objects or null (JobInstanceActionItem)
expiryTime
string <date-time>
requestIds
Array of integers or null <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
}

/api/jobinstanceactions

Authorizations:
Token
query Parameters
id
integer <int32>
Request Body schema:
id
integer <int32>
action
string or null
actionType
integer <int32> (ActionType)
Enum: 0 1 2
result
string or null
message
string or null
Array of objects or null (JobInstanceActionItem)
expiryTime
string <date-time>
requestIds
Array of integers or null <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
}

/api/jobinstanceactions

Authorizations:
Token
query Parameters
id
integer <int32>

Responses

JobSubTypes

Gets the job sub types.

Sample request (this returns a list of job sub types): 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 by 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>

The job sub type id.

Responses

JobTags

Get a list of tags based on the criteria specified.

Sample request (this returns a list of tags by name in descending order starting with offset 2 and up to limit 2):

GET ?sortby=name:asc&limit=2&offset=2

Authorizations:
Token
query Parameters
RemoteInstance
string
Name
string

The tag name

Limit
integer <int32>

Limits the results being fetched

Offset
integer <int32>

Retrieves records beginning at this record number

SortOrders
Array of strings

Tag sort order

MasterOnly
boolean
SortBy
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new tag and return it with its details, if successful.

Sample request (this creates a new tag):

POST /api/jobtags

{
    "Name": "TagName""
    "TagAssociations":
    [
        {
            "ScheduleName": "Schedule Name",
            "JobName":      "Job Name",
            "FrequencyName":"Frequency name"
        }
    ]
}
Authorizations:
Token
Request Body schema:

Name of tag to be added

name
string or null
tagCount
integer <int32>
Array of objects or null (TagAssociation)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "name": "string",
  • "tagCount": 0,
  • "tagAssociations": [
    ]
}

Update a tag and return 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 of tag to be updated

name
string or null
tagCount
integer <int32>
Array of objects or null (TagAssociation)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "name": "string",
  • "tagCount": 0,
  • "tagAssociations": [
    ]
}

Get a list of tags based on name specified.

Sample request (this returns a list of tags with name like name):

GET /api/jobtags/?name=testtag

Authorizations:
Token
path Parameters
name
required
string

Name of tag

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deletes specified tag.

Sample request (this deletes a specified tag):

DELETE /api/jobtags/TagName

Authorizations:
Token
path Parameters
name
required
string

Name of tag to be deleted

Responses

LicenseTaskCount

/api/licenseTaskCount

Authorizations:
Token
query Parameters
From
string
To
string
JobTypeIds
string
DepartmentIds
string

Responses

LinuxPlatform

/api/platform

Authorizations:
Token
query Parameters
FileName
string
Application
string
UserId
integer <int32>
SessionId
integer <int64>

Responses

Logs

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

/api/logs

Authorizations:
Token
query Parameters
FileName
string
Application
string
UserId
integer <int32>
SessionId
integer <int64>

Responses

/api/logs/{filePath}

Authorizations:
Token
path Parameters
filePath
required
string
query Parameters
From
integer <int32>
To
integer <int32>
Tail
integer <int32>

Responses

MachineActions

/api/MachineActions/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/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>
userId
integer <int32>
Array of objects or null (MachineActionItem)

Responses

Request samples

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

MachineGroups

/api/machinegroups

Authorizations:
Token
query Parameters
IncludeAssignedMasterJobs
boolean
IncludeAssignedDailyJobs
boolean
MachineGroupNamesOnly
boolean
Offset
integer <int32>
Limit
integer <int32>
Name
string
Type
string
Ids
string
TypeIds
string
IncludeMachines
boolean
HasAdminAccess
boolean
AccessibleMachineGroups
Array of integers <int32> [ items <int32 > ]
SortBy
string
SortOrders
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new machine group and return it with its id, if successful.

Sample request (this creates a new machine group):
POST /api/machinegroups {
"name": "Operator""
}

Authorizations:
Token
Request Body schema:
id
integer or null <int32>
documentation
string or null
name
string or null
object (MachineGroupType)
Array of objects or null (Machine)
Array of objects or null (CrossReferenceMasterJob)
Array of objects or null (CrossReferenceDailyJob)

Responses

Request samples

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

Response samples

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

/api/machinegroups/machineGroupNames

Authorizations:
Token
query Parameters
IncludeAssignedMasterJobs
boolean
IncludeAssignedDailyJobs
boolean
MachineGroupNamesOnly
boolean
Offset
integer <int32>
Limit
integer <int32>
Name
string
Type
string
Ids
string
TypeIds
string
IncludeMachines
boolean
HasAdminAccess
boolean
AccessibleMachineGroups
Array of integers <int32> [ items <int32 > ]
SortBy
string
SortOrders
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an machine group for the id specified

Sample request (this returns the machine group with id = 1):
GET /api/machinegroups/1

Authorizations:
Token
path Parameters
id
required
integer <int32>

The id of the machine group you want to get

Responses

Response samples

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

Update all properties of the machine group specified by the id

Sample request (this updates the machine group):
PUT /api/machinegroups/1
{
"id": 1,
"name": "MachineGroupName" "type: { "id": 6,
}

Authorizations:
Token
path Parameters
id
required
integer <int32>

The machine group id

Request Body schema:
id
integer or null <int32>
documentation
string or null
name
string or null
object (MachineGroupType)
Array of objects or null (Machine)
Array of objects or null (CrossReferenceMasterJob)
Array of objects or null (CrossReferenceDailyJob)

Responses

Request samples

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

Response samples

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

Delete the machine group specified by the id

Sample request (this deletes the machine group):
DELETE /api/machinegroups/1

Authorizations:
Token
path Parameters
id
required
integer <int32>

The unique identifier of the machine group

Responses

Response samples

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

Machines

Get a list of machines based on optional criteria specified

Sample request (this returns a list of machines by name in descending order):
GET /api/machines?sortby=name:desc

Authorizations:
Token
query Parameters
ResourceName
string
Offset
integer <int32>
Limit
integer <int32>
includeDocumentation
boolean
IncludeAssignedMasterJobs
boolean
IncludeAssignedDailyJobs
boolean
Ids
string
Name
string
Type
string
Typeids
string
GroupName
string
GroupIds
string
States
string
Version
string
FileTransferRole
string
Sockets
string
Tls
boolean
SortBy
string
IncludeDetails
boolean
ExcludeNullMachine
boolean
SortOrders
Array of strings
ExtendedProperties
boolean
HasAdminAccess
boolean
Array of objects (ApiError)
Array of objects (AuxillaryProperty)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/machines

Authorizations:
Token
Request Body schema:
id
integer or null <int32>
name
string or null
currentJobs
integer or null <int32>
gatewayId
integer or null <int32>
Array of objects or null (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 (MachineStatus)
object (LsamType)
Array of objects or null (CrossReferenceMasterJob)
Array of objects or null (CrossReferenceDailyJob)
acceptMessagesfromIp
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 (InstanceProperty)
_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>
_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
{
  • "id": 0,
  • "name": "string",
  • "currentJobs": 0,
  • "gatewayId": 0,
  • "groups": [
    ],
  • "lastUpdateDateTime": "string",
  • "lastUpdate": 0,
  • "maximumJobs": 0,
  • "opConMaximumJobs": 0,
  • "socket": 0,
  • "state": {
    },
  • "type": {
    },
  • "assignedMasterJobs": [
    ],
  • "assignedDailyJobs": [
    ],
  • "acceptMessagesfromIp": "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,
  • "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,
  • "timeOffsetfromUtcInHours": 0,
  • "timeSent": "string",
  • "timeZoneName": "string",
  • "tlsCertificateDistinguishedName": "string",
  • "_tlsCertificateSerialNumber": "string",
  • "tlsCertificateSerialNumber": "string",
  • "traceAllMessages": true,
  • "_useTLSforSchedulingCommunications": true,
  • "useTLSforSchedulingCommunications": true,
  • "agentVersion": "string",
  • "hpNonStopIpAddress": "string",
  • "hpNonStopSocketNumber": 0,
  • "_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"
}

/api/machines/count_by_status

Authorizations:
Token
query Parameters
ResourceName
string
Offset
integer <int32>
Limit
integer <int32>
includeDocumentation
boolean
IncludeAssignedMasterJobs
boolean
IncludeAssignedDailyJobs
boolean
Ids
string
Name
string
Type
string
Typeids
string
GroupName
string
GroupIds
string
States
string
Version
string
FileTransferRole
string
Sockets
string
Tls
boolean
SortBy
string
IncludeDetails
boolean
ExcludeNullMachine
boolean
SortOrders
Array of strings
ExtendedProperties
boolean
HasAdminAccess
boolean
Array of objects (ApiError)
Array of objects (AuxillaryProperty)

Responses

/api/machines/types

Authorizations:
Token
query Parameters
All
boolean
ForScriptRunnerOnly
boolean
ResourceName
string
Array of objects (ApiError)
Array of objects (AuxillaryProperty)

Responses

/api/machines/machinenames

Authorizations:
Token
query Parameters
ResourceName
string
Offset
integer <int32>
Limit
integer <int32>
includeDocumentation
boolean
IncludeAssignedMasterJobs
boolean
IncludeAssignedDailyJobs
boolean
Ids
string
Name
string
Type
string
Typeids
string
GroupName
string
GroupIds
string
States
string
Version
string
FileTransferRole
string
Sockets
string
Tls
boolean
SortBy
string
IncludeDetails
boolean
ExcludeNullMachine
boolean
SortOrders
Array of strings
ExtendedProperties
boolean
HasAdminAccess
boolean
Array of objects (ApiError)
Array of objects (AuxillaryProperty)

Responses

/api/machines/{id}/properties

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/machines/{id}/properties

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

/api/machines/{id}/properties/{name}

Authorizations:
Token
path Parameters
id
required
integer <int32>
name
required
string

Responses

/api/machines/{id}/properties/{name}

Authorizations:
Token
path Parameters
id
required
integer <int32>
name
required
string

Responses

/api/machines/{id}/properties/{name}

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

Get a machine by id

Sample request (this returns the machine having id '3'):
GET /api/machines/3

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Edit a machine by id

Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer or null <int32>
name
string or null
currentJobs
integer or null <int32>
gatewayId
integer or null <int32>
Array of objects or null (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 (MachineStatus)
object (LsamType)
Array of objects or null (CrossReferenceMasterJob)
Array of objects or null (CrossReferenceDailyJob)
acceptMessagesfromIp
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 (InstanceProperty)
_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>
_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
{
  • "id": 0,
  • "name": "string",
  • "currentJobs": 0,
  • "gatewayId": 0,
  • "groups": [
    ],
  • "lastUpdateDateTime": "string",
  • "lastUpdate": 0,
  • "maximumJobs": 0,
  • "opConMaximumJobs": 0,
  • "socket": 0,
  • "state": {
    },
  • "type": {
    },
  • "assignedMasterJobs": [
    ],
  • "assignedDailyJobs": [
    ],
  • "acceptMessagesfromIp": "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,
  • "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,
  • "timeOffsetfromUtcInHours": 0,
  • "timeSent": "string",
  • "timeZoneName": "string",
  • "tlsCertificateDistinguishedName": "string",
  • "_tlsCertificateSerialNumber": "string",
  • "tlsCertificateSerialNumber": "string",
  • "traceAllMessages": true,
  • "_useTLSforSchedulingCommunications": true,
  • "useTLSforSchedulingCommunications": true,
  • "agentVersion": "string",
  • "hpNonStopIpAddress": "string",
  • "hpNonStopSocketNumber": 0,
  • "_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"
}

Delete the machine having the specified id

Sample request (This deletes a machine with id = 11): DELETE /api/machines/11

Authorizations:
Token
path Parameters
id
required
integer <int32>

The id of the machine to delete

Responses

Re-synchronizes running jobs on machine having id '1'

Sample request:
POST /api/syncRunningJobs {
"machine": {
"id": 1
}

Authorizations:
Token
Request Body schema:
object (MachineToSync)
runningJobsCount
integer <int32>

Responses

Request samples

Content type
{
  • "machine": {
    },
  • "runningJobsCount": 0
}

Response samples

Content type
application/json
{
  • "machine": {
    },
  • "runningJobsCount": 0
}

Maintenance

/api/servicestatus

Authorizations:
Token

Responses

MasterInstances

/api/masterinstances

Authorizations:
Token
query Parameters
Ids
string

Responses

/api/masterinstances

Authorizations:
Token
Request Body schema:
id
integer <int32>
tags
Array of strings or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "tags": [
    ]
}

/api/masterinstances/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/masterinstances/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer <int32>
tags
Array of strings or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "tags": [
    ]
}

MasterJobs

Get a list of master jobs based on optional criteria specified

Sample request (this returns a list of master jobs sorted by name): GET /api/masterJobs/v2?sortby=jobName

Authorizations:
Token
query Parameters
Key.JobName
string
Key.ScheduleId
integer <int32>
SelectedIds
string

List of job ids (1|job, etc)

ScheduleId
integer <int32>

Schedule id

ScheduleName
string

Schedule name

JobName
string

Job name

JobTypeId
integer <int32>

Job type id (-1, 3, 6, etc.)

JobTypeName
string

Job type name

IncludeDetails
boolean

Flag to include job details

IncludeCount
boolean

Flag to include total count of accessible jobs

IncludeCrossReferences
boolean

Flag to include cross references

Limit
integer <int32> [ 0 .. 2147483647 ]

Limits the results being fetched

Offset
integer <int32> [ 0 .. 2147483647 ]

Retrieves records beginning at this record number

SortBy
string

Sort by (schedule name, job name, job type id, job id). Default is job id.

IgnoreCase
boolean

Use case-insensitive search criteria.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new master job and return it with its id, if successful

Sample request (this creates a new master job): POST /api/masterJobs/v2 { "name": "job", "jobType": { "id": -1, }, "schedule: { "id": 1 }, "accessCode": { "id": 1 }, "department": { "id": 1 }, "machineSelection": { "machineSelectionType": "None", "machineGroupId": 0, "machineIds": { "primary": 1, "alt1": 0, "alt2": 0, "alt3": 0 }, "isMultiInstance": false, "disableBuild": false }

Authorizations:
Token
Request Body schema:
id
string or null
name
required
string [ 1 .. 64 ] characters [^!%'|;&<>()\[\]{},=\\"]*
required
object (AddMasterJobJobType)
required
object (AddMasterJobMasterSchedule)
required
object (AddMasterJobAccessCode)
required
object (AddMasterJobDepartment)
required
object (MasterJobsMachineSelection)
isMultiInstance
required
boolean
disableBuild
required
boolean
Array of objects or null (UpdateMasterJobFrequencyModel)
details
any or null

Responses

Request samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "jobType": {
    },
  • "schedule": {
    },
  • "accessCode": {
    },
  • "department": {
    },
  • "machineSelection": {
    },
  • "isMultiInstance": true,
  • "disableBuild": true,
  • "frequencies": [
    ],
  • "details": null
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "jobType": {
    },
  • "schedule": {
    },
  • "accessCode": {
    },
  • "department": {
    },
  • "machineSelection": {
    },
  • "isMultiInstance": true,
  • "disableBuild": true,
  • "frequencyType": "Unknown",
  • "dependentMasterJobs": [
    ],
  • "frequencies": [
    ],
  • "jobDependencies": [
    ],
  • "properties": [
    ],
  • "documentation": {
    },
  • "expressionDependencies": {
    },
  • "thresholdResourceDependencies": [
    ],
  • "thresholdResourceUpdates": [
    ],
  • "tags": {
    },
  • "events": [
    ],
  • "details": null
}

Get a master job for the id specified

Sample request (this the master job with id = '1|Audit History Purge'): GET /api/masterJobs/v2/1|Audit History Purge

Authorizations:
Token
path Parameters
JobName
required
string
ScheduleId
required
integer <int32>
masterJobKey
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "jobType": {
    },
  • "schedule": {
    },
  • "accessCode": {
    },
  • "department": {
    },
  • "machineSelection": {
    },
  • "isMultiInstance": true,
  • "disableBuild": true,
  • "frequencyType": "Unknown",
  • "dependentMasterJobs": [
    ],
  • "frequencies": [
    ],
  • "jobDependencies": [
    ],
  • "properties": [
    ],
  • "documentation": {
    },
  • "expressionDependencies": {
    },
  • "thresholdResourceDependencies": [
    ],
  • "thresholdResourceUpdates": [
    ],
  • "tags": {
    },
  • "events": [
    ],
  • "details": null
}

Update the master job specified by the id

Sample request (this updates the master job name): PUT /api/masterJobs/v2/3|job1

{
    "id": "3|job1",
    "name": "job1-updated",
    "jobType": {
    "id": -1
    },
    "schedule": {
    "id": 3,
    "name": "skd",
    "subSchedule": false
    },
    "accessCode": {
    "id": 0
    },
    "department": {
    "id": 1
    },
    "machineSelection": {
    "machineSelectionType": "None",
    "machineGroupId": 0,
    "machineIds": {
        "primary": 0,
        "alt1": 0,
        "alt2": 0,
        "alt3": 0
    }
    },
    "isMultiInstance": false,
    "disableBuild": false
 }
Authorizations:
Token
path Parameters
JobName
required
string
ScheduleId
required
integer <int32>
masterJobKey
required
string
Request Body schema:
id
string or null
Array of objects or null (UpdateMasterJobDependencyModel)
Array of objects or null (UpdateMasterJobInstancePropertyListModel)
object (MasterJobsDocumentation)
object (UpdateMasterJobsExpressionDependencyModel)
Array of objects or null (UpdateMasterJobThresholdResourceDependencyModel)
Array of objects or null (UpdateMasterJobThresholdResourceUpdateModel)
object (UpdateMasterJobTagModel)
name
required
string [ 1 .. 64 ] characters [^!%'|;&<>()\[\]{},=\\"]*
required
object (UpdateMasterJobJobType)
required
object (UpdateMasterJobMasterSchedule)
required
object (UpdateMasterJobAccessCode)
required
object (UpdateMasterJobDepartment)
required
object (MasterJobsMachineSelection)
isMultiInstance
required
boolean
disableBuild
required
boolean
frequencyType
required
string (FrequencyTypes)
Enum: "Unknown" "Inherited" "Defined"
Array of objects or null (MasterJobFrequency)
details
any or null
Array of objects or null (MasterJobsEvent)

Responses

Request samples

Content type
{
  • "id": "string",
  • "jobDependencies": [
    ],
  • "properties": [
    ],
  • "documentation": {
    },
  • "expressionDependencies": {
    },
  • "thresholdResourceDependencies": [
    ],
  • "thresholdResourceUpdates": [
    ],
  • "tags": {
    },
  • "name": "string",
  • "jobType": {
    },
  • "schedule": {
    },
  • "accessCode": {
    },
  • "department": {
    },
  • "machineSelection": {
    },
  • "isMultiInstance": true,
  • "disableBuild": true,
  • "frequencyType": "Unknown",
  • "frequencies": [
    ],
  • "details": null,
  • "events": [
    ]
}

Delete the master job having the specified id

Sample request (This deletes a master job with id = '3|job1'): DELETE /api/masterJobs/v2/3|job1

Authorizations:
Token
path Parameters
JobName
required
string
ScheduleId
required
integer <int32>
masterJobKey
required
string

Responses

Copy an existing master job and all of its additional details (frequencies, events, etc.) to a new master job and return the new master job key, if successful

Sample request: POST /api/masterJobs/v2/copy { "name": "job", "jobType": { "id": -1, }, "schedule: { "id": 1 }, "accessCode": { "id": 1 }, "department": { "id": 1 }, "machineSelection": { "machineSelectionType": "None", "machineGroupId": 0, "machineIds": { "primary": 1, "alt1": 0, "alt2": 0, "alt3": 0 }, "isMultiInstance": false, "disableBuild": false }

Authorizations:
Token
Request Body schema:
id
string or null
Array of objects or null (UpdateMasterJobDependencyModel)
Array of objects or null (UpdateMasterJobInstancePropertyListModel)
object (MasterJobsDocumentation)
object (UpdateMasterJobsExpressionDependencyModel)
Array of objects or null (UpdateMasterJobThresholdResourceDependencyModel)
Array of objects or null (UpdateMasterJobThresholdResourceUpdateModel)
object (UpdateMasterJobTagModel)
name
required
string [ 1 .. 64 ] characters [^!%'|;&<>()\[\]{},=\\"]*
required
object (UpdateMasterJobJobType)
required
object (UpdateMasterJobMasterSchedule)
required
object (UpdateMasterJobAccessCode)
required
object (UpdateMasterJobDepartment)
required
object (MasterJobsMachineSelection)
isMultiInstance
required
boolean
disableBuild
required
boolean
frequencyType
required
string (FrequencyTypes)
Enum: "Unknown" "Inherited" "Defined"
Array of objects or null (MasterJobFrequency)
details
any or null
Array of objects or null (MasterJobsEvent)

Responses

Request samples

Content type
{
  • "id": "string",
  • "jobDependencies": [
    ],
  • "properties": [
    ],
  • "documentation": {
    },
  • "expressionDependencies": {
    },
  • "thresholdResourceDependencies": [
    ],
  • "thresholdResourceUpdates": [
    ],
  • "tags": {
    },
  • "name": "string",
  • "jobType": {
    },
  • "schedule": {
    },
  • "accessCode": {
    },
  • "department": {
    },
  • "machineSelection": {
    },
  • "isMultiInstance": true,
  • "disableBuild": true,
  • "frequencyType": "Unknown",
  • "frequencies": [
    ],
  • "details": null,
  • "events": [
    ]
}

Legacy method, no longer supported

Authorizations:
Token
path Parameters
rawId
required
string

Responses

Legacy method, no longer supported

Authorizations:
Token
query Parameters
Ids
string
ScheduleIds
string
JobIds
string
TagList
Array of strings
LimitValue
integer <int32>
OffsetValue
integer <int32>
ScheduleName
string
JobName
string
FrequencyName
string
SortOrders
Array of strings
JobType
string
DepartmentList
Array of integers <int32> [ items <int32 > ]
AccessCodeList
Array of integers <int32> [ items <int32 > ]
Name
string
SortBy
string
AccessCodes
string
Limit
string
Offset
string
Tags
string
Departments
string

Responses

Legacy method, no longer supported

Authorizations:
Token
query Parameters
Ids
string
ScheduleIds
string
JobIds
string
TagList
Array of strings
LimitValue
integer <int32>
OffsetValue
integer <int32>
ScheduleName
string
JobName
string
FrequencyName
string
SortOrders
Array of strings
JobType
string
DepartmentList
Array of integers <int32> [ items <int32 > ]
AccessCodeList
Array of integers <int32> [ items <int32 > ]
Name
string
SortBy
string
AccessCodes
string
Limit
string
Offset
string
Tags
string
Departments
string

Responses

MasterSchedules

/api/MasterSchedules

Authorizations:
Token
query Parameters
Name
string
Ids
string
Limit
integer <int32>
Offset
integer <int32>
SortOrders
Array of strings
CheckSubSchedule
boolean
SubSchedule
boolean
MultiInstance
boolean
AutoBuild
boolean
IncludeDetails
boolean
IgnoreCase
boolean
BasicDetails
boolean
Sortby
string

Responses

/api/MasterSchedules/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/MasterSchedules/count

Authorizations:
Token
query Parameters
Name
string
Ids
string
Limit
integer <int32>
Offset
integer <int32>
SortOrders
Array of strings
CheckSubSchedule
boolean
SubSchedule
boolean
MultiInstance
boolean
AutoBuild
boolean
IncludeDetails
boolean
IgnoreCase
boolean
BasicDetails
boolean
Sortby
string

Responses

/api/MasterSchedules/{id}/workflow

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

MasterVisionWorkspaces

/api/mastervisionworkspaces

Authorizations:
Token
query Parameters
Ids
string
Name
string

Responses

/api/mastervisionworkspaces

Authorizations:
Token
Request Body schema:
id
integer <int32>
name
string or null
description
string or null
Array of objects or null (MasterVisionCard)

Responses

Request samples

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

/api/mastervisionworkspaces/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/mastervisionworkspaces/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer <int32>
name
string or null
description
string or null
Array of objects or null (MasterVisionCard)

Responses

Request samples

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

MftMachines

/api/machines/mft/{mftId}/endpoints

Authorizations:
Token
path Parameters
mftId
required
integer <int32>

Responses

/api/machines/mft/{mftId}/pgpSigningKeys

Authorizations:
Token
path Parameters
mftId
required
integer <int32>

Responses

/api/machines/mft/{mftId}/pgpEncryptingKeys

Authorizations:
Token
path Parameters
mftId
required
integer <int32>

Responses

/api/machines/mft/{mftId}/refreshBearerAuthToken

Authorizations:
Token
path Parameters
mftId
required
integer <int32>

Responses

Get a list of machines based on optional criteria specified

Sample request (this returns a list of machines by name in descending order):
GET /api/machines?sortby=name:desc

Authorizations:
Token
query Parameters
ResourceName
string
Offset
integer <int32>
Limit
integer <int32>
includeDocumentation
boolean
IncludeAssignedMasterJobs
boolean
IncludeAssignedDailyJobs
boolean
Ids
string
Name
string
Type
string
Typeids
string
GroupName
string
GroupIds
string
States
string
Version
string
FileTransferRole
string
Sockets
string
Tls
boolean
SortBy
string
IncludeDetails
boolean
ExcludeNullMachine
boolean
SortOrders
Array of strings
ExtendedProperties
boolean
HasAdminAccess
boolean
Array of objects (ApiError)
Array of objects (AuxillaryProperty)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/machines/mft

Authorizations:
Token
Request Body schema:
id
integer or null <int32>
name
string or null
currentJobs
integer or null <int32>
gatewayId
integer or null <int32>
Array of objects or null (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 (MachineStatus)
object (LsamType)
Array of objects or null (CrossReferenceMasterJob)
Array of objects or null (CrossReferenceDailyJob)
acceptMessagesfromIp
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 (InstanceProperty)
_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>
_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
{
  • "id": 0,
  • "name": "string",
  • "currentJobs": 0,
  • "gatewayId": 0,
  • "groups": [
    ],
  • "lastUpdateDateTime": "string",
  • "lastUpdate": 0,
  • "maximumJobs": 0,
  • "opConMaximumJobs": 0,
  • "socket": 0,
  • "state": {
    },
  • "type": {
    },
  • "assignedMasterJobs": [
    ],
  • "assignedDailyJobs": [
    ],
  • "acceptMessagesfromIp": "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,
  • "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,
  • "timeOffsetfromUtcInHours": 0,
  • "timeSent": "string",
  • "timeZoneName": "string",
  • "tlsCertificateDistinguishedName": "string",
  • "_tlsCertificateSerialNumber": "string",
  • "tlsCertificateSerialNumber": "string",
  • "traceAllMessages": true,
  • "_useTLSforSchedulingCommunications": true,
  • "useTLSforSchedulingCommunications": true,
  • "agentVersion": "string",
  • "hpNonStopIpAddress": "string",
  • "hpNonStopSocketNumber": 0,
  • "_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"
}

/api/machines/mft/count_by_status

Authorizations:
Token
query Parameters
ResourceName
string
Offset
integer <int32>
Limit
integer <int32>
includeDocumentation
boolean
IncludeAssignedMasterJobs
boolean
IncludeAssignedDailyJobs
boolean
Ids
string
Name
string
Type
string
Typeids
string
GroupName
string
GroupIds
string
States
string
Version
string
FileTransferRole
string
Sockets
string
Tls
boolean
SortBy
string
IncludeDetails
boolean
ExcludeNullMachine
boolean
SortOrders
Array of strings
ExtendedProperties
boolean
HasAdminAccess
boolean
Array of objects (ApiError)
Array of objects (AuxillaryProperty)

Responses

/api/machines/mft/types

Authorizations:
Token
query Parameters
All
boolean
ForScriptRunnerOnly
boolean
ResourceName
string
Array of objects (ApiError)
Array of objects (AuxillaryProperty)

Responses

/api/machines/mft/machinenames

Authorizations:
Token
query Parameters
ResourceName
string
Offset
integer <int32>
Limit
integer <int32>
includeDocumentation
boolean
IncludeAssignedMasterJobs
boolean
IncludeAssignedDailyJobs
boolean
Ids
string
Name
string
Type
string
Typeids
string
GroupName
string
GroupIds
string
States
string
Version
string
FileTransferRole
string
Sockets
string
Tls
boolean
SortBy
string
IncludeDetails
boolean
ExcludeNullMachine
boolean
SortOrders
Array of strings
ExtendedProperties
boolean
HasAdminAccess
boolean
Array of objects (ApiError)
Array of objects (AuxillaryProperty)

Responses

/api/machines/mft/{id}/properties

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/machines/mft/{id}/properties

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

/api/machines/mft/{id}/properties/{name}

Authorizations:
Token
path Parameters
id
required
integer <int32>
name
required
string

Responses

/api/machines/mft/{id}/properties/{name}

Authorizations:
Token
path Parameters
id
required
integer <int32>
name
required
string

Responses

/api/machines/mft/{id}/properties/{name}

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

Get a machine by id

Sample request (this returns the machine having id '3'):
GET /api/machines/3

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Edit a machine by id

Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer or null <int32>
name
string or null
currentJobs
integer or null <int32>
gatewayId
integer or null <int32>
Array of objects or null (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 (MachineStatus)
object (LsamType)
Array of objects or null (CrossReferenceMasterJob)
Array of objects or null (CrossReferenceDailyJob)
acceptMessagesfromIp
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 (InstanceProperty)
_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>
_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
{
  • "id": 0,
  • "name": "string",
  • "currentJobs": 0,
  • "gatewayId": 0,
  • "groups": [
    ],
  • "lastUpdateDateTime": "string",
  • "lastUpdate": 0,
  • "maximumJobs": 0,
  • "opConMaximumJobs": 0,
  • "socket": 0,
  • "state": {
    },
  • "type": {
    },
  • "assignedMasterJobs": [
    ],
  • "assignedDailyJobs": [
    ],
  • "acceptMessagesfromIp": "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,
  • "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,
  • "timeOffsetfromUtcInHours": 0,
  • "timeSent": "string",
  • "timeZoneName": "string",
  • "tlsCertificateDistinguishedName": "string",
  • "_tlsCertificateSerialNumber": "string",
  • "tlsCertificateSerialNumber": "string",
  • "traceAllMessages": true,
  • "_useTLSforSchedulingCommunications": true,
  • "useTLSforSchedulingCommunications": true,
  • "agentVersion": "string",
  • "hpNonStopIpAddress": "string",
  • "hpNonStopSocketNumber": 0,
  • "_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"
}

Delete the machine having the specified id

Sample request (This deletes a machine with id = 11): DELETE /api/machines/11

Authorizations:
Token
path Parameters
id
required
integer <int32>

The id of the machine to delete

Responses

Re-synchronizes running jobs on machine having id '1'

Sample request:
POST /api/syncRunningJobs {
"machine": {
"id": 1
}

Authorizations:
Token
Request Body schema:
object (MachineToSync)
runningJobsCount
integer <int32>

Responses

Request samples

Content type
{
  • "machine": {
    },
  • "runningJobsCount": 0
}

Response samples

Content type
application/json
{
  • "machine": {
    },
  • "runningJobsCount": 0
}

NamedInstances

/api/namedInstances

Authorizations:
Token
query Parameters
Id
integer <int32>
Name
string
ScheduleId
integer <int32>
Limit
integer <int32>
Offset
integer <int32>
SortOrders
Array of strings
SortBy
string

Responses

/api/namedInstances/{instanceId}

Authorizations:
Token
path Parameters
instanceId
required
integer <int32>

Responses

NotificationCategories

Return a list of notification categories.

Sample request:

GET /api/notificationCategories?limit=1&offset=1

 "id":2,
 "category": "Category2",
 "groups": [
    {
        "id": 1,
        "name": "Group1"
    }
 ]

}

Authorizations:
Token
query Parameters
Id
integer <int32>

The id of the category to fetch

Name
string

The name of the category to fetch

Limit
integer <int32>

Limit the number of records to fetch

Offset
integer <int32>

Offset the number of records being fetched

IgnoreCase
boolean

Use case-insensitive search criteria

SortBy
string

Option to sort by name

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "category": "string",
  • "groups": [
    ]
}

Returns the newly created notification category.

Sample request:

POST /api/notificationCategories

{ "category": "newCategory", "groups": [ { "id": 1, "name": "Group1" } ] }

Authorizations:
Token
Request Body schema:
id
integer <int32>
category
required
string [ 1 .. 4000 ] characters
Array of objects or null (NotificationCategoryGroup)

Responses

Request samples

Content type
{
  • "id": 0,
  • "category": "string",
  • "groups": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "category": "string",
  • "groups": [
    ]
}

Returns the updated notification category.

Sample request:

PUT /api/notificationCategories/1

{ "id": 1, "category": "updated Sample Category", "groups": [ { "id": 1, "name": "Group1" } ] }

Authorizations:
Token
path Parameters
notificationCategoryId
required
integer <int32>
Request Body schema:
id
integer <int32>
category
required
string [ 1 .. 4000 ] characters
Array of objects or null (NotificationCategoryGroup)

Responses

Request samples

Content type
{
  • "id": 0,
  • "category": "string",
  • "groups": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "category": "string",
  • "groups": [
    ]
}

Deletes a notification category.

Sample request:

DELETE /api/notificationCategories/1

Authorizations:
Token
path Parameters
notificationCategoryId
required
integer <int32>

Responses

NotificationGroups

Get a list of schedules for notification groups usage

Sample request (this returns a list of Schedules): GET /api/notificationGroups/schedules?Name=testScheduleName

Authorizations:
Token
query Parameters
Name
string

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

Type
string

Type of the object of interest to fetch (Can accept ? and * wildcards)

MachineTypes
string

Comma-separeted list of type of the machines to fetch

Ids
string

Comma-separated list of the object of interest 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

IgnoreCase
boolean

Use case-insensitive search criteria

SortBy
string

Option to sort values by different parameter fields

BasicDetails
boolean

Flag to retrieve basic details only

HasAdminAccess
boolean

Flag to determine admin access

Show
integer <int32> (NotificationGroupShow)
Enum: 0 1 2

Retrieve All ids, Selected ids, or NotSelected ids. Used by notificationGroups/{groupType} endpoints only. Default is All.

GroupId
integer <int32>

Limits the results of Show to the specified group id. Used by notificationGroups/{groupType} endpoints only.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of jobs for notification groups usage

Sample request (this returns a list of Schedules): GET /api/notificationGroups/jobs?Name=sampleJobName

Authorizations:
Token
query Parameters
Name
string

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

Type
string

Type of the object of interest to fetch (Can accept ? and * wildcards)

MachineTypes
string

Comma-separeted list of type of the machines to fetch

Ids
string

Comma-separated list of the object of interest 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

IgnoreCase
boolean

Use case-insensitive search criteria

SortBy
string

Option to sort values by different parameter fields

BasicDetails
boolean

Flag to retrieve basic details only

HasAdminAccess
boolean

Flag to determine admin access

Show
integer <int32> (NotificationGroupShow)
Enum: 0 1 2

Retrieve All ids, Selected ids, or NotSelected ids. Used by notificationGroups/{groupType} endpoints only. Default is All.

GroupId
integer <int32>

Limits the results of Show to the specified group id. Used by notificationGroups/{groupType} endpoints only.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of machines for notification groups usage

Sample request (this returns a list of Schedules): GET /api/notificationGroups/machines?Name=sampleMachineName

Authorizations:
Token
query Parameters
Name
string

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

Type
string

Type of the object of interest to fetch (Can accept ? and * wildcards)

MachineTypes
string

Comma-separeted list of type of the machines to fetch

Ids
string

Comma-separated list of the object of interest 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

IgnoreCase
boolean

Use case-insensitive search criteria

SortBy
string

Option to sort values by different parameter fields

BasicDetails
boolean

Flag to retrieve basic details only

HasAdminAccess
boolean

Flag to determine admin access

Show
integer <int32> (NotificationGroupShow)
Enum: 0 1 2

Retrieve All ids, Selected ids, or NotSelected ids. Used by notificationGroups/{groupType} endpoints only. Default is All.

GroupId
integer <int32>

Limits the results of Show to the specified group id. Used by notificationGroups/{groupType} endpoints only.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of NotificationGroups based on optional criteria specified

Sample request (this returns a list of NotificationGroups): GET /api/NotificationGroups

Authorizations:
Token
query Parameters
Name
string

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

Type
string

Type of the object of interest to fetch (Can accept ? and * wildcards)

MachineTypes
string

Comma-separeted list of type of the machines to fetch

Ids
string

Comma-separated list of the object of interest 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

IgnoreCase
boolean

Use case-insensitive search criteria

SortBy
string

Option to sort values by different parameter fields

BasicDetails
boolean

Flag to retrieve basic details only

HasAdminAccess
boolean

Flag to determine admin access

Show
integer <int32> (NotificationGroupShow)
Enum: 0 1 2

Retrieve All ids, Selected ids, or NotSelected ids. Used by notificationGroups/{groupType} endpoints only. Default is All.

GroupId
integer <int32>

Limits the results of Show to the specified group id. Used by notificationGroups/{groupType} endpoints only.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new notification group object

Sample request (this creates a new notification group):
POST /api/notificationgroups/1 

{
    "name": "NotificationGroup",
    "excludeSelected": false,
    "selected": [
        {
            "id":2,
            "name": "UnixMachine"
        }
    ],
    "categories":[
        "Tag1"
    ],
    "type": "J"
}
Authorizations:
Token
Request Body schema:
id
integer or null <int32>

Id for the notification group

name
string or null

Name for the notification group

excludeSelected
boolean or null

Boolean to specify if selected items will be included or excluded

Array of objects or null (NotificationGroupSelectedItem)

Jobs, Schedules or Machines associated with the notification group

categories
Array of strings or null

Categories associated with the notification group

type
string or null

Notification group type (System, User) Valid values = machine, schedule or job

parentGroupId
integer or null <int32>

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "excludeSelected": true,
  • "selected": [
    ],
  • "categories": [
    ],
  • "type": "string",
  • "parentGroupId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "excludeSelected": true,
  • "selected": [
    ],
  • "categories": [
    ],
  • "type": "string",
  • "parentGroupId": 0
}

Update all properties of the notification group specified by the id

Sample request (this updates the notification group):
PUT /api/notificationgroups/1 

{
    "id": 1,
    "name": "NotificationGroup",
    "excludeSelected": false,
    "selected": [
        {
            "id":2,
            "name": "UnixMachine"
        }
    ],
    "categories":[
        "Tag1"
    ],
    "type": "J"
}
Authorizations:
Token
path Parameters
id
required
integer <int32>

The unique identifier of the notification group

Request Body schema:

The notification group object to update

id
integer or null <int32>

Id for the notification group

name
string or null

Name for the notification group

excludeSelected
boolean or null

Boolean to specify if selected items will be included or excluded

Array of objects or null (NotificationGroupSelectedItem)

Jobs, Schedules or Machines associated with the notification group

categories
Array of strings or null

Categories associated with the notification group

type
string or null

Notification group type (System, User) Valid values = machine, schedule or job

parentGroupId
integer or null <int32>

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "excludeSelected": true,
  • "selected": [
    ],
  • "categories": [
    ],
  • "type": "string",
  • "parentGroupId": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "excludeSelected": true,
  • "selected": [
    ],
  • "categories": [
    ],
  • "type": "string",
  • "parentGroupId": 0
}

Delete the notification group specified by the id

Sample request (this deletes the notification group):
DELETE /api/notificationgroup/1

Authorizations:
Token
path Parameters
id
required
integer <int32>

The unique identifier of the notification group

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "excludeSelected": true,
  • "selected": [
    ],
  • "categories": [
    ],
  • "type": "string",
  • "parentGroupId": 0
}

Notifications

/api/notifications/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "string",
  • "trigger": {
    },
  • "group": {
    }
}

NotificationTriggers

Get a list of notification triggers for the job having the specified job id.

Sample request:

GET /api/notificationtriggers/1|Audit History Purge

Authorizations:
Token
path Parameters
jobId
required
string

The job id.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of notification triggers based on optional criteria specified

Sample request (this returns a of notification trigger with the specified name ):
GET /api/notificationtriggers?name=NTName

Authorizations:
Token
query Parameters
Name
string

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

Description
string

Descriptyion of the trigger to fetch (Can accept ? and * wildcards)

GroupType
string

Group type of the trigger to fetch: Job, Machine, or Schedule

Categories
string

Categories of the group for the trigger to fetch (Can accept ? and * wildcards)

Notifications
string

Notifications of the group for the trigger to fetch (Can accept ? and * wildcards)

Contents
string

Content of the trigger message (Can accept ? and * wildcards)

GroupId
integer <int32>

Unique identifier value of the notification group to be associated with the triggers to fetch

Group
string

Name of the notification group to be associated with the triggers to fetch (Can accept ? and * wildcards)

Ids
string

Comma-separated list of triggers unique identifier values

HasAdminAccess
boolean

Flag to determine admin access

Limit
integer <int32> [ 0 .. 2147483647 ]

Limits the results being fetched

Offset
integer <int32> [ 0 .. 2147483647 ]

Retrieves records beginning at this record number

SortBy
string

Sort by (group, groupType, name, description

IgnoreCase
boolean

Use case-insensitive search criteria.

IncludeDetails
boolean

Flag to return essages and group categories. Default is true.

GroupIds
string

Comma-separated list of group ids.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new notification trigger for a given group and trigger type

Sample request (this creates a new notification trigger):
POST /api/notificationtriggers 

{
 "name": "Job Finished Ok",
 "description": "",
 "includeInternalJobNumber": true,
 "group": {
    "id": 1, "name": "someJobTriggersGroup",
    "categories": ["critical","daily"]
    },
  "notifications": [

  ]
}
Authorizations:
Token
Request Body schema:
id
integer or null <int32>

The id of the notification trigger

name
required
string non-empty

The name of the notification trigger

description
string or null

The description of the notification trigger

includeInternalJobNumber
boolean or null

Specifies whether the internal job number will be included in the job name or not.

object (NotificationGroup)
Array of objects or null (NotificationMessage)

List of messages associated with the notification trigger

object (EscalationRule)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "includeInternalJobNumber": true,
  • "group": {
    },
  • "messages": [
    ],
  • "escalationRule": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "includeInternalJobNumber": true,
  • "group": {
    },
  • "messages": [
    ],
  • "escalationRule": {
    }
}

Update all properties of the notification trigger specified by the id

Sample request (this updates the notification trigger):
PUT /api/notificationtriggers/1 

{
    "id": 1,
    "name": "Job Failed",
    "description": "Description",
    "includeInternalJobNumber": false,
    "group":
        {
            "id":2,
            "name": "UnixMachine",
    "categories":[
        "Category1"
    ]
    },
    "messages": []
}
Authorizations:
Token
path Parameters
id
required
integer <int32>

The unique identifier of the notification trigger

Request Body schema:

The notification trigger object to update

id
integer or null <int32>

The id of the notification trigger

name
required
string non-empty

The name of the notification trigger

description
string or null

The description of the notification trigger

includeInternalJobNumber
boolean or null

Specifies whether the internal job number will be included in the job name or not.

object (NotificationGroup)
Array of objects or null (NotificationMessage)

List of messages associated with the notification trigger

object (EscalationRule)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "includeInternalJobNumber": true,
  • "group": {
    },
  • "messages": [
    ],
  • "escalationRule": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "includeInternalJobNumber": true,
  • "group": {
    },
  • "messages": [
    ],
  • "escalationRule": {
    }
}

Delete the notification trigger specified by the id

Sample request (this deletes the notification trigger):
DELETE /api/notificationtrigger/1

Authorizations:
Token
path Parameters
id
required
integer <int32>

The unique identifier of the notification trigger

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "includeInternalJobNumber": true,
  • "group": {
    },
  • "messages": [
    ],
  • "escalationRule": {
    }
}

Send a test for the message type in the trigger specified.

Sample request (this send a request to test the email message): POST /api/notificationTriggers/test { , "messageType": "Email", //Options are: All, Email, Text, NetworkMessage, OpCon Event, Windows Event Log, RunCommand, SNMPTrap, SPO Event }

Authorizations:
Token
Request Body schema:
messageType
string or null
object (NotificationTrigger)

An notification trigger with id and name fields

Responses

Request samples

Content type
{
  • "messageType": "string",
  • "notificationTrigger": {
    }
}

OpConEvents

/api/opconEventsCollection

Authorizations:
Token
Request Body schema:
loginName
string or null
Array of objects or null (SimpleEvent)

Responses

Request samples

Content type
{
  • "loginName": "string",
  • "events": [
    ]
}

PropertyExpression

/api/propertyexpression

Authorizations:
Token
Request Body schema:
expression
string or null
status
string or null
result
string or null
message
string or null

Responses

Request samples

Content type
{
  • "expression": "string",
  • "status": "string",
  • "result": "string",
  • "message": "string"
}

RefreshScheduleBuildResultsCache

/api/refreshScheduleBuildResultCache

Authorizations:
Token

Responses

RefreshVisionCache

/api/refreshVisionCache

Authorizations:
Token
query Parameters
RefreshStatistics
boolean

Responses

RemoteInstances

/api/remoteinstances

Authorizations:
Token
query Parameters
Ids
string
Name
string

Responses

/api/remoteinstances

Authorizations:
Token
Request Body schema:
status
integer <int32> (RemoteInstanceStatus)
Enum: 1 2
id
integer <int32>

The remote instance id.

name
string or null

Defines the name for the remote instance.

description
string or null

Description of the remote instance.

object (RemoteInstanceDatabaseConnection)
apiBaseUrl
string or null

The remote instance's API URL.

solutionManagerBaseUrl
string or null

The Solution Manager API URL.

object (User)
object (Token)
masterInstanceId
integer or null <int32>
connectionString
string or null
Array of objects or null (User)

List of vision action users.

Responses

Request samples

Content type
{
  • "status": 1,
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "databaseConnection": {
    },
  • "apiBaseUrl": "string",
  • "solutionManagerBaseUrl": "string",
  • "adminUser": {
    },
  • "adminToken": {
    },
  • "masterInstanceId": 0,
  • "connectionString": "string",
  • "visionActionUsers": [
    ]
}

/api/remoteinstances/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/remoteinstances/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
status
integer <int32> (RemoteInstanceStatus)
Enum: 1 2
id
integer <int32>

The remote instance id.

name
string or null

Defines the name for the remote instance.

description
string or null

Description of the remote instance.

object (RemoteInstanceDatabaseConnection)
apiBaseUrl
string or null

The remote instance's API URL.

solutionManagerBaseUrl
string or null

The Solution Manager API URL.

object (User)
object (Token)
masterInstanceId
integer or null <int32>
connectionString
string or null
Array of objects or null (User)

List of vision action users.

Responses

Request samples

Content type
{
  • "status": 1,
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "databaseConnection": {
    },
  • "apiBaseUrl": "string",
  • "solutionManagerBaseUrl": "string",
  • "adminUser": {
    },
  • "adminToken": {
    },
  • "masterInstanceId": 0,
  • "connectionString": "string",
  • "visionActionUsers": [
    ]
}

/api/remoteinstances/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Resources

Update the resource having the provided id

Sample request (this updates the resource having id '1'):
PUT /api/resources/1
{ "id": 1, "name": "R1", "description": "Resource 1", "value": 10 }

Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer or null <int32>

Threshold id

name
string or null

Threshold name

description
string or null

Threshold description

value
integer or null <int32>

Threshold value

Array of objects or null (ThresholdResourceDailyJob)

List of daily jobs that depend on the threshold

Array of objects or null (ThresholdResourceDailyJob)

List of daily jobs that update the threshold

Array of objects or null (ThresholdResourceMasterJob)

List of master jobs that depend on the threshold

Array of objects or null (ThresholdResourceMasterJob)

List of master jobs that update the threshold

used
integer or null <int32>

Number of times the resource is used

locked
boolean or null

Flag to indicate if the resource is locked

object (LockedByDailyJob)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "value": 0,
  • "dependentDailyJobs": [
    ],
  • "updatedByDailyJobs": [
    ],
  • "dependentMasterJobs": [
    ],
  • "updatedByMasterJobs": [
    ],
  • "used": 0,
  • "locked": true,
  • "lockedByDailyJob": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "value": 0,
  • "dependentDailyJobs": [
    ],
  • "updatedByDailyJobs": [
    ],
  • "dependentMasterJobs": [
    ],
  • "updatedByMasterJobs": [
    ],
  • "used": 0,
  • "locked": true,
  • "lockedByDailyJob": {
    }
}

Get a resource by id

Sample request:
GET /api/resources/1

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "value": 0,
  • "dependentDailyJobs": [
    ],
  • "updatedByDailyJobs": [
    ],
  • "dependentMasterJobs": [
    ],
  • "updatedByMasterJobs": [
    ],
  • "used": 0,
  • "locked": true,
  • "lockedByDailyJob": {
    }
}

Delete a resource by id

Sample request:
DELETE /api/resources/1

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Add a new resource

Sample request:
POST /api/resources { "name": "R1", "description": "Resource 1", "value": 10 }

Authorizations:
Token
Request Body schema:
id
integer or null <int32>

Threshold id

name
string or null

Threshold name

description
string or null

Threshold description

value
integer or null <int32>

Threshold value

Array of objects or null (ThresholdResourceDailyJob)

List of daily jobs that depend on the threshold

Array of objects or null (ThresholdResourceDailyJob)

List of daily jobs that update the threshold

Array of objects or null (ThresholdResourceMasterJob)

List of master jobs that depend on the threshold

Array of objects or null (ThresholdResourceMasterJob)

List of master jobs that update the threshold

used
integer or null <int32>

Number of times the resource is used

locked
boolean or null

Flag to indicate if the resource is locked

object (LockedByDailyJob)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "value": 0,
  • "dependentDailyJobs": [
    ],
  • "updatedByDailyJobs": [
    ],
  • "dependentMasterJobs": [
    ],
  • "updatedByMasterJobs": [
    ],
  • "used": 0,
  • "locked": true,
  • "lockedByDailyJob": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "value": 0,
  • "dependentDailyJobs": [
    ],
  • "updatedByDailyJobs": [
    ],
  • "dependentMasterJobs": [
    ],
  • "updatedByMasterJobs": [
    ],
  • "used": 0,
  • "locked": true,
  • "lockedByDailyJob": {
    }
}

Get a list of resources matching the optional provided criteria

Sample request:
GET /api/resources?name=R1

Authorizations:
Token
query Parameters
IncludeDependentDailyJobs
boolean

Flag to include dependent daily jobs

IncludeUpdatedByDailyJobs
boolean

Flag to include thresholds updated by daily jobs

IncludeDependentMasterJobs
boolean

Flag to include dependent master jobs

IncludeUpdatedByMasterJobs
boolean

Flag to include thresholds updated by master jobs

Offset
integer <int32>

Retrieves records beginning at this record number

Limit
integer <int32>

Limits the results being fetched. 0 retrieves just a count

Name
string

Threshold name

Value
integer <int32>

Threshold value

Ids
string

Comma-separated list of threshold ids

Description
string

Threshold description

SortBy
string

Options to sort by

SortOrders
Array of strings

Sort order (id, name, description)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Roles

/api/roles

Authorizations:
Token
query Parameters
Limit
integer <int32>
Offset
integer <int32>
IncludeAccessCodes
boolean
IncludeDepartmentFunctions
boolean
IncludeMachines
boolean
IncludeMachineGroups
boolean
IncludeSchedules
boolean
IncludeServiceRequests
boolean
IncludeBatchUsers
boolean
IncludeUsers
boolean
Name
string
Ids
string
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
IncludeEmbeddedScripts
boolean

Responses

/api/roles

Authorizations:
Token
Request Body schema:
id
integer <int32>

Numeric id of the role. optional

name
string or null

Name of the role.Must be unique. optional

Array of objects or null (User)
inheritAllSchedulePrivileges
boolean or null

When true, this role's privileges will be applied to all schedules. optional

inheritAllMachinePrivileges
boolean or null

When true, this role's privileges will be applied to all machines. optional

inheritAllMachineGroupPrivileges
boolean or null

When true, this role's privileges will be applied to all machine groups. optional

inheritAllEmbeddedScriptPrivileges
boolean or null

When true, this role's privileges will be applied to all embeddedscripts. optional

object (Permissions)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "users": [
    ],
  • "inheritAllSchedulePrivileges": true,
  • "inheritAllMachinePrivileges": true,
  • "inheritAllMachineGroupPrivileges": true,
  • "inheritAllEmbeddedScriptPrivileges": true,
  • "permissions": {
    }
}

/api/roles/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/roles/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer <int32>

Numeric id of the role. optional

name
string or null

Name of the role.Must be unique. optional

Array of objects or null (User)
inheritAllSchedulePrivileges
boolean or null

When true, this role's privileges will be applied to all schedules. optional

inheritAllMachinePrivileges
boolean or null

When true, this role's privileges will be applied to all machines. optional

inheritAllMachineGroupPrivileges
boolean or null

When true, this role's privileges will be applied to all machine groups. optional

inheritAllEmbeddedScriptPrivileges
boolean or null

When true, this role's privileges will be applied to all embeddedscripts. optional

object (Permissions)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "users": [
    ],
  • "inheritAllSchedulePrivileges": true,
  • "inheritAllMachinePrivileges": true,
  • "inheritAllMachineGroupPrivileges": true,
  • "inheritAllEmbeddedScriptPrivileges": true,
  • "permissions": {
    }
}

SapQuery

Sends SAP query

Sample request (this sends a sap query for SAP B/W jobs):
POST /api/sapQueries

{ "type":"chains", "SapMachine":"SAPMACHINENAME", "language":"EN", "Criteria":[ {"name":"","value":""} ], }

Authorizations:
Token
Request Body schema:
id
integer <int32>
status
string or null
type
string or null
sapMachine
string or null
user
string or null
externalUser
string or null
password
string or null
language
string or null
selection
string or null
jobName
string or null
jobCount
string or null
destination
string or null
systemId
string or null
Array of objects or null (Criteria)
object (SapJobDetail)

This is the jobDetail parameter

abapName
string or null

This is the abapName parameter

variantName
string or null

This is the variantName parameter

Array of objects or null (VariantParameter)

This is the parameters parameter Required for creating abap variant

isJobModify
boolean

Specified when running JobCreate query but editing a daily job.

jobStepModified
boolean

Specified when steps have been added, removed or order changed during job editind

action
string or null
message
string or null
requestIds
Array of integers or null <int64>
expiryTime
string <date-time>
userId
integer <int32>
result
string or null
Array of objects or null (SapQueryResponseValues)
errorMessage
string or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "status": "string",
  • "type": "string",
  • "sapMachine": "string",
  • "user": "string",
  • "externalUser": "string",
  • "password": "string",
  • "language": "string",
  • "selection": "string",
  • "jobName": "string",
  • "jobCount": "string",
  • "destination": "string",
  • "systemId": "string",
  • "criteria": [
    ],
  • "jobDetail": {
    },
  • "abapName": "string",
  • "variantName": "string",
  • "parameters": [
    ],
  • "isJobModify": true,
  • "jobStepModified": true,
  • "action": "string",
  • "message": "string",
  • "requestIds": [
    ],
  • "expiryTime": "2019-08-24T14:15:22Z",
  • "userId": 0,
  • "result": "string",
  • "results": [
    ],
  • "errorMessage": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "status": "string",
  • "type": "string",
  • "sapMachine": "string",
  • "user": "string",
  • "externalUser": "string",
  • "password": "string",
  • "language": "string",
  • "selection": "string",
  • "jobName": "string",
  • "jobCount": "string",
  • "destination": "string",
  • "systemId": "string",
  • "criteria": [
    ],
  • "jobDetail": {
    },
  • "abapName": "string",
  • "variantName": "string",
  • "parameters": [
    ],
  • "isJobModify": true,
  • "jobStepModified": true,
  • "action": "string",
  • "message": "string",
  • "requestIds": [
    ],
  • "expiryTime": "2019-08-24T14:15:22Z",
  • "userId": 0,
  • "result": "string",
  • "results": [
    ],
  • "errorMessage": "string"
}

Return the specified SAP query result

Sample request (this creates a new access code):
GET /api/sapquery/id

Authorizations:
Token
path Parameters
id
required
integer <int32>

Unique identifier for the request

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "status": "string",
  • "type": "string",
  • "sapMachine": "string",
  • "user": "string",
  • "externalUser": "string",
  • "password": "string",
  • "language": "string",
  • "selection": "string",
  • "jobName": "string",
  • "jobCount": "string",
  • "destination": "string",
  • "systemId": "string",
  • "criteria": [
    ],
  • "jobDetail": {
    },
  • "abapName": "string",
  • "variantName": "string",
  • "parameters": [
    ],
  • "isJobModify": true,
  • "jobStepModified": true,
  • "action": "string",
  • "message": "string",
  • "requestIds": [
    ],
  • "expiryTime": "2019-08-24T14:15:22Z",
  • "userId": 0,
  • "result": "string",
  • "results": [
    ],
  • "errorMessage": "string"
}

ScheduleActions

/api/scheduleactions/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/scheduleactions

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>
userId
integer <int32>
invalidStates
Array of strings or null
states
Array of strings or null
reason
string or null
Array of objects or null (ScheduleActionItem)

Responses

Request samples

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

ScheduleActionsByDate

/api/scheduleActionsByDate/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/scheduleActionsByDate

Authorizations:
Token
Request Body schema:
action
string or null
invalidStates
Array of strings or null
states
Array of strings or null
requestIds
Array of integers or null <int64>
expiryTime
string <date-time>
userId
integer <int32>
id
integer <int32>
scheduleDates
Array of strings or null
Array of objects or null (ScheduleDateJobItem)
reason
string or null
result
string or null
message
string or null
updated
integer or null <int32>

Responses

Request samples

Content type
{
  • "action": "string",
  • "invalidStates": [
    ],
  • "states": [
    ],
  • "requestIds": [
    ],
  • "expiryTime": "2019-08-24T14:15:22Z",
  • "userId": 0,
  • "id": 0,
  • "scheduleDates": [
    ],
  • "scheduleDateActionItems": [
    ],
  • "reason": "string",
  • "result": "string",
  • "message": "string",
  • "updated": 0
}

ScheduleBuilds

/api/schedulebuilds/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/schedulebuilds

Authorizations:
Token
Request Body schema:
Array of objects or null (ScheduleBuildRequest)
Array of objects or null (ScheduleBuildActionSchedule)
action
string or null
id
integer <int32>
result
string or null
message
string or null
requestIds
Array of integers or null <int64>
expiryTime
string <date-time>
userId
integer <int32>
dates
Array of strings or null
logFile
string or null
overwrite
boolean
namedInstance
string or null
machineName
string or null
hold
boolean

Responses

Request samples

Content type
{
  • "requests": [
    ],
  • "schedules": [
    ],
  • "action": "string",
  • "id": 0,
  • "result": "string",
  • "message": "string",
  • "requestIds": [
    ],
  • "expiryTime": "2019-08-24T14:15:22Z",
  • "userId": 0,
  • "dates": [
    ],
  • "logFile": "string",
  • "overwrite": true,
  • "namedInstance": "string",
  • "machineName": "string",
  • "hold": true
}

ScheduleChecks

/api/scheduleChecks

Authorizations:
Token
Request Body schema:
id
required
string [ 1 .. 50 ] characters
entityType
integer <int32> (ScheduleCheckRequestType)
Enum: 0 1 2
checkType
string (ScheduleCheckType)
Enum: "Unknown" "Slow" "Normal" "Fast"

Responses

Request samples

Content type
{
  • "id": "string",
  • "entityType": 0,
  • "checkType": "Unknown"
}

/api/scheduleChecks/{id}

Authorizations:
Token
path Parameters
id
required
string

Responses

/api/scheduleChecks/logs/{requestId}

Authorizations:
Token
path Parameters
requestId
required
integer <int64>

Responses

ScriptDeployments

/api/ScriptDeployments

Authorizations:
Token
Request Body schema:
masterJobIds
required
Array of strings non-empty
versionSelectionType
required
string non-empty
targetScriptVersionId
integer <int32>

Responses

Request samples

Content type
{
  • "masterJobIds": [
    ],
  • "versionSelectionType": "string",
  • "targetScriptVersionId": 0
}

/api/ScriptDeployments

Authorizations:
Token

Responses

/api/ScriptDeployments

Authorizations:
Token

Responses

ScriptRunners

/api/ScriptRunners

Authorizations:
Token
query Parameters
ScriptTypeId
integer <int32>
PlatformId
integer <int32>
Name
string
ScriptRunnerIds
Array of integers <int32> [ items <int32 > ]
IncludeCrossReferences
boolean

Responses

/api/ScriptRunners

Authorizations:
Token
Request Body schema:
name
required
string [ 1 .. 128 ] characters
required
object (AddScriptType)
required
object (AddLsamType)
command
required
string non-empty

Responses

Request samples

Content type
{
  • "name": "string",
  • "scriptType": {
    },
  • "lsamType": {
    },
  • "command": "string"
}

/api/ScriptRunners/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/ScriptRunners/{scriptRunnerId}

Authorizations:
Token
path Parameters
scriptRunnerId
required
integer <int32>

Responses

/api/ScriptRunners/{scriptRunnerId}

Authorizations:
Token
path Parameters
scriptRunnerId
required
integer <int32>
Request Body schema:
name
required
string [ 1 .. 128 ] characters
command
required
string non-empty

Responses

Request samples

Content type
{
  • "name": "string",
  • "command": "string"
}

Scripts

Get a list of Script based on optional criteria

Authorizations:
Token
query Parameters
ScriptName
string
ScriptTypeName
string
ScriptIds
Array of integers <int32> [ items <int32 > ]
IncludeCrossReferences
boolean
IncludeVersions
boolean
OpConPlatformId
integer <int32>
Limit
integer <int32>
Offset
integer <int32>
SortValue
string (ScriptCriteriaSortColumn)
Enum: "Unknown" "TypeName" "ScriptName" "Description"
SortDescending
boolean

Responses

/api/Scripts

Authorizations:
Token
Request Body schema:
name
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9_-]*$
required
Array of objects (AddInitialScriptVersion) = 1 items
required
object (AddScriptType)
id
integer <int32> [ 0 .. 0 ]
description
string or null <= 4000 characters
required
Array of objects (AddScriptRoleAssignment)

Responses

Request samples

Content type
{
  • "name": "string",
  • "versions": [
    ],
  • "type": {
    },
  • "id": 0,
  • "description": "string",
  • "roles": [
    ]
}

/api/Scripts/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Delete the script with the specified id

Sample request (This deletes the script with id = 2004): DELETE /api/scripts/2004

Authorizations:
Token
path Parameters
id
required
integer <int32>

The id of the script to delete

Responses

/api/Scripts/{scriptId}

Authorizations:
Token
path Parameters
scriptId
required
integer <int32>
Request Body schema:
name
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9_-]*$
required
object (UpdateScriptType)
description
string or null <= 4000 characters

Responses

Request samples

Content type
{
  • "name": "string",
  • "type": {
    },
  • "description": "string"
}

ScriptTypes

/api/ScriptTypes

Authorizations:
Token
query Parameters
Name
string
ScriptTypeIds
Array of integers <int32> [ items <int32 > ]
IncludeCrossReferences
boolean

Responses

/api/ScriptTypes

Authorizations:
Token
Request Body schema:
name
required
string [ 1 .. 128 ] characters
description
string or null <= 4000 characters
fileExtension
string or null <= 12 characters ^[a-zA-Z0-9]*$

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "fileExtension": "string"
}

/api/ScriptTypes/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/ScriptTypes/{scriptTypeId}

Authorizations:
Token
path Parameters
scriptTypeId
required
integer <int32>

Responses

/api/ScriptTypes/{scriptTypeId}

Authorizations:
Token
path Parameters
scriptTypeId
required
integer <int32>
Request Body schema:
name
required
string [ 1 .. 128 ] characters
description
string or null <= 4000 characters
fileExtension
string or null <= 12 characters ^[a-zA-Z0-9]*$

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "fileExtension": "string"
}

ScriptVersions

Delete the script version with the specified id

Sample request (This deletes the script version with id = 6): DELETE /api/scriptVersions/6

Authorizations:
Token
path Parameters
id
required
integer <int32>

The id of the script version to delete

Responses

/api/ScriptVersions

Authorizations:
Token
Request Body schema:
id
integer <int32> [ 0 .. 0 ]
comment
string or null <= 4000 characters
content
required
string [ 1 .. 921600 ] characters ^[^\u001f]*$
scriptId
required
integer <int32> [ 1 .. 2147483647 ]

Responses

Request samples

Content type
{
  • "id": 0,
  • "comment": "string",
  • "content": "string",
  • "scriptId": 1
}

/api/ScriptVersions

Authorizations:
Token

Responses

ServerOptions

/api/serveroptions

Authorizations:
Token

Responses

/api/serveroptions

Authorizations:
Token
Request Body schema:
alternateOddAndEvenWeeks
boolean or null
enableWindowsAuthentication
boolean or null
numberOfDaysToKeepServiceRequestExecutions
integer or null <int32>
object (HtmlDocumentation)
object (PasswordPolicy)
object (VisionSettings)
solutionManagerSettings
string or null
ticketingSystemName
string or null
loginSecureMessage
string or null
Array of objects or null (ServerSetting)

Responses

Request samples

Content type
{
  • "alternateOddAndEvenWeeks": true,
  • "enableWindowsAuthentication": true,
  • "numberOfDaysToKeepServiceRequestExecutions": 0,
  • "htmlDocumentation": {
    },
  • "passwordPolicy": {
    },
  • "visionSettings": {
    },
  • "solutionManagerSettings": "string",
  • "ticketingSystemName": "string",
  • "loginSecureMessage": "string",
  • "settings": [
    ]
}

ServiceRequestCategories

/api/servicerequestcategories

Authorizations:
Token
query Parameters
Limit
integer <int32>
Offset
integer <int32>
IncludeServiceRequests
boolean
Name
string
Color
string
ServiceRequestName
string
Ids
string
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

/api/servicerequestcategories

Authorizations:
Token
Request Body schema:
id
integer <int32>
name
string or null
color
string or null
Array of objects or null (ServiceRequest)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "color": "string",
  • "serviceRequests": [
    ]
}

/api/servicerequestcategories/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/servicerequestcategories/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer <int32>
name
string or null
color
string or null
Array of objects or null (ServiceRequest)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "color": "string",
  • "serviceRequests": [
    ]
}

/api/servicerequestcategories/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

ServiceRequestExecutions

/api/servicerequestexecutions

Authorizations:
Token
query Parameters
Limit
integer <int32>
Offset
integer <int32>
IncludeServiceRequests
boolean
IncludeOpconResponses
boolean
IncludeUsers
boolean
ServiceRequestName
string
LoginName
string
Ids
string
ServiceRequestIds
string
ExecutionStatuses
string
LastUpdateLessThan
string
SortOrder.SortBy
string
SortOrder.IdColumns
Array of strings
SortOrder.ValidSortOrders
Array of strings
SortOrder.ColumnList
Array of strings
SortOrder.SortTypeList
Array of strings
GroupBy
string
SortBy
string

Responses

/api/servicerequestexecutions

Authorizations:
Token
Request Body schema:
id
integer <int32>
executionStatus
string or null
details
string or null
submitAsOcadm
boolean or null
requestTs
string or null <date-time>
requestTimeStamp
string or null
lastUpdateTs
string or null <date-time>
lastUpdateTimeStamp
string or null
object (User)
object (ServiceRequest)
Array of objects or null (OpConRequest)
Array of objects or null (OpConResponse)
Array of objects or null (SelfServiceVariable)
completedCount
integer or null <int32>
totalCount
integer or null <int32>
Array of objects or null (EventExecution)
trackEvent
boolean

Responses

Request samples

Content type
{
  • "id": 0,
  • "executionStatus": "string",
  • "details": "string",
  • "submitAsOcadm": true,
  • "requestTs": "2019-08-24T14:15:22Z",
  • "requestTimeStamp": "string",
  • "lastUpdateTs": "2019-08-24T14:15:22Z",
  • "lastUpdateTimeStamp": "string",
  • "user": {
    },
  • "serviceRequest": {
    },
  • "opconRequests": [
    ],
  • "opconResponses": [
    ],
  • "variables": [
    ],
  • "completedCount": 0,
  • "totalCount": 0,
  • "eventExecutions": [
    ],
  • "trackEvent": true
}

/api/servicerequestexecutions/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/servicerequestexecutions/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer <int32>
executionStatus
string or null
details
string or null
submitAsOcadm
boolean or null
requestTs
string or null <date-time>
requestTimeStamp
string or null
lastUpdateTs
string or null <date-time>
lastUpdateTimeStamp
string or null
object (User)
object (ServiceRequest)
Array of objects or null (OpConRequest)
Array of objects or null (OpConResponse)
Array of objects or null (SelfServiceVariable)
completedCount
integer or null <int32>
totalCount
integer or null <int32>
Array of objects or null (EventExecution)
trackEvent
boolean

Responses

Request samples

Content type
{
  • "id": 0,
  • "executionStatus": "string",
  • "details": "string",
  • "submitAsOcadm": true,
  • "requestTs": "2019-08-24T14:15:22Z",
  • "requestTimeStamp": "string",
  • "lastUpdateTs": "2019-08-24T14:15:22Z",
  • "lastUpdateTimeStamp": "string",
  • "user": {
    },
  • "serviceRequest": {
    },
  • "opconRequests": [
    ],
  • "opconResponses": [
    ],
  • "variables": [
    ],
  • "completedCount": 0,
  • "totalCount": 0,
  • "eventExecutions": [
    ],
  • "trackEvent": true
}

/api/servicerequestexecutions/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/servicerequestexecutions/count_by_{field}

Authorizations:
Token
path Parameters
field
required
string
query Parameters
Limit
integer <int32>
Offset
integer <int32>
IncludeServiceRequests
boolean
IncludeOpconResponses
boolean
IncludeUsers
boolean
ServiceRequestName
string
LoginName
string
Ids
string
ServiceRequestIds
string
ExecutionStatuses
string
LastUpdateLessThan
string
SortOrder.SortBy
string
SortOrder.IdColumns
Array of strings
SortOrder.ValidSortOrders
Array of strings
SortOrder.ColumnList
Array of strings
SortOrder.SortTypeList
Array of strings
GroupBy
string
SortBy
string

Responses

/api/selfServiceRequestExecutions/count_by_{field}

Authorizations:
Token
path Parameters
field
required
string
query Parameters
Limit
integer <int32>
Offset
integer <int32>
IncludeServiceRequests
boolean
IncludeOpconResponses
boolean
IncludeUsers
boolean
ServiceRequestName
string
LoginName
string
Ids
string
ServiceRequestIds
string
ExecutionStatuses
string
LastUpdateLessThan
string
SortOrder.SortBy
string
SortOrder.IdColumns
Array of strings
SortOrder.ValidSortOrders
Array of strings
SortOrder.ColumnList
Array of strings
SortOrder.SortTypeList
Array of strings
GroupBy
string
SortBy
string

Responses

/api/selfServiceRequestExecutions

Authorizations:
Token
query Parameters
Limit
integer <int32>
Offset
integer <int32>
IncludeServiceRequests
boolean
IncludeOpconResponses
boolean
IncludeUsers
boolean
ServiceRequestName
string
LoginName
string
Ids
string
ServiceRequestIds
string
ExecutionStatuses
string
LastUpdateLessThan
string
SortOrder.SortBy
string
SortOrder.IdColumns
Array of strings
SortOrder.ValidSortOrders
Array of strings
SortOrder.ColumnList
Array of strings
SortOrder.SortTypeList
Array of strings
GroupBy
string
SortBy
string

Responses

/api/selfServiceRequestExecutions

Authorizations:
Token
Request Body schema:
id
integer <int32>
executionStatus
string or null
details
string or null
submitAsOcadm
boolean or null
requestTs
string or null <date-time>
requestTimeStamp
string or null
lastUpdateTs
string or null <date-time>
lastUpdateTimeStamp
string or null
object (User)
object (ServiceRequest)
Array of objects or null (OpConRequest)
Array of objects or null (OpConResponse)
Array of objects or null (SelfServiceVariable)
completedCount
integer or null <int32>
totalCount
integer or null <int32>
Array of objects or null (EventExecution)
trackEvent
boolean

Responses

Request samples

Content type
{
  • "id": 0,
  • "executionStatus": "string",
  • "details": "string",
  • "submitAsOcadm": true,
  • "requestTs": "2019-08-24T14:15:22Z",
  • "requestTimeStamp": "string",
  • "lastUpdateTs": "2019-08-24T14:15:22Z",
  • "lastUpdateTimeStamp": "string",
  • "user": {
    },
  • "serviceRequest": {
    },
  • "opconRequests": [
    ],
  • "opconResponses": [
    ],
  • "variables": [
    ],
  • "completedCount": 0,
  • "totalCount": 0,
  • "eventExecutions": [
    ],
  • "trackEvent": true
}

/api/selfServiceRequestExecutions/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

ServiceRequests

/api/servicerequests

Authorizations:
Token
query Parameters
Limit
integer <int32>
Offset
integer <int32>
IncludeRoles
boolean
EvaluateRules
boolean
Name
string
CategoryName
string
RoleName
string
Ids
string
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

/api/servicerequests

Authorizations:
Token
Request Body schema:
id
integer <int32>
name
string or null
documentation
string or null
html
string or null
object (SelfServiceRequest)
details
string or null
object (ServiceRequestControl)
disableRule
string or null
object (ServiceRequestControl)
hideRule
string or null
object (ServiceRequestCategory)
Array of objects or null (Role)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "documentation": "string",
  • "html": "string",
  • "request": {
    },
  • "details": "string",
  • "disabled": {
    },
  • "disableRule": "string",
  • "hidden": {
    },
  • "hideRule": "string",
  • "serviceRequestCategory": {
    },
  • "roles": [
    ]
}

/api/servicerequests/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/servicerequests/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer <int32>
name
string or null
documentation
string or null
html
string or null
object (SelfServiceRequest)
details
string or null
object (ServiceRequestControl)
disableRule
string or null
object (ServiceRequestControl)
hideRule
string or null
object (ServiceRequestCategory)
Array of objects or null (Role)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "documentation": "string",
  • "html": "string",
  • "request": {
    },
  • "details": "string",
  • "disabled": {
    },
  • "disableRule": "string",
  • "hidden": {
    },
  • "hideRule": "string",
  • "serviceRequestCategory": {
    },
  • "roles": [
    ]
}

/api/servicerequests/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/selfServiceRequests/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/selfServiceRequests/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/selfServiceRequests/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer <int32>
name
string or null
documentation
string or null
html
string or null
object (SelfServiceRequest)
details
string or null
object (ServiceRequestControl)
disableRule
string or null
object (ServiceRequestControl)
hideRule
string or null
object (ServiceRequestCategory)
Array of objects or null (Role)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "documentation": "string",
  • "html": "string",
  • "request": {
    },
  • "details": "string",
  • "disabled": {
    },
  • "disableRule": "string",
  • "hidden": {
    },
  • "hideRule": "string",
  • "serviceRequestCategory": {
    },
  • "roles": [
    ]
}

/api/selfServiceRequests

Authorizations:
Token
query Parameters
Limit
integer <int32>
Offset
integer <int32>
IncludeRoles
boolean
EvaluateRules
boolean
Name
string
CategoryName
string
RoleName
string
Ids
string
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

/api/selfServiceRequests

Authorizations:
Token
Request Body schema:
id
integer <int32>
name
string or null
documentation
string or null
html
string or null
object (SelfServiceRequest)
details
string or null
object (ServiceRequestControl)
disableRule
string or null
object (ServiceRequestControl)
hideRule
string or null
object (ServiceRequestCategory)
Array of objects or null (Role)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "documentation": "string",
  • "html": "string",
  • "request": {
    },
  • "details": "string",
  • "disabled": {
    },
  • "disableRule": "string",
  • "hidden": {
    },
  • "hideRule": "string",
  • "serviceRequestCategory": {
    },
  • "roles": [
    ]
}

SolutionManagerSettings

/api/solutionManagerSettings

Authorizations:
Token
query Parameters
Ids
string
Name
string
RoleId
integer <int32>
UserId
integer <int32>
GlobalOnly
boolean
Public
boolean
UserCanWrite
boolean

Responses

/api/solutionManagerSettings

Authorizations:
Token
Request Body schema:
id
integer <int32>
roleId
integer or null <int32>
userId
integer or null <int32>
name
string or null
value
string or null
userCanWrite
boolean or null
isPublic
boolean or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "roleId": 0,
  • "userId": 0,
  • "name": "string",
  • "value": "string",
  • "userCanWrite": true,
  • "isPublic": true
}

/api/solutionManagerSettings/{id}

Authorizations:
Token
path Parameters
id
required
string

Responses

/api/solutionManagerSettings/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer <int32>
roleId
integer or null <int32>
userId
integer or null <int32>
name
string or null
value
string or null
userCanWrite
boolean or null
isPublic
boolean or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "roleId": 0,
  • "userId": 0,
  • "name": "string",
  • "value": "string",
  • "userCanWrite": true,
  • "isPublic": true
}

/api/solutionManagerSettings/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Thresholds

Update the threshold having the provided id

Sample request (this updates the threshold having id '1'):
PUT /api/thresholds/1
{ "id": 1, "name": "T1", "description": "Threshold 1", "value": 10 }

Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer or null <int32>

Threshold id

name
string or null

Threshold name

description
string or null

Threshold description

value
integer or null <int32>

Threshold value

Array of objects or null (ThresholdResourceDailyJob)

List of daily jobs that depend on the threshold

Array of objects or null (ThresholdResourceDailyJob)

List of daily jobs that update the threshold

Array of objects or null (ThresholdResourceMasterJob)

List of master jobs that depend on the threshold

Array of objects or null (ThresholdResourceMasterJob)

List of master jobs that update the threshold

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "value": 0,
  • "dependentDailyJobs": [
    ],
  • "updatedByDailyJobs": [
    ],
  • "dependentMasterJobs": [
    ],
  • "updatedByMasterJobs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "value": 0,
  • "dependentDailyJobs": [
    ],
  • "updatedByDailyJobs": [
    ],
  • "dependentMasterJobs": [
    ],
  • "updatedByMasterJobs": [
    ]
}

Get a threshold by id

Sample request:
GET /api/thresholds/1

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "value": 0,
  • "dependentDailyJobs": [
    ],
  • "updatedByDailyJobs": [
    ],
  • "dependentMasterJobs": [
    ],
  • "updatedByMasterJobs": [
    ]
}

Delete a threshold by id

Sample request:
DELETE /api/thresholds/1

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Add a new threshold

Sample request:
POST /api/thresholds { "name": "T1", "description": "Threshold 1", "value": 10 }

Authorizations:
Token
Request Body schema:
id
integer or null <int32>

Threshold id

name
string or null

Threshold name

description
string or null

Threshold description

value
integer or null <int32>

Threshold value

Array of objects or null (ThresholdResourceDailyJob)

List of daily jobs that depend on the threshold

Array of objects or null (ThresholdResourceDailyJob)

List of daily jobs that update the threshold

Array of objects or null (ThresholdResourceMasterJob)

List of master jobs that depend on the threshold

Array of objects or null (ThresholdResourceMasterJob)

List of master jobs that update the threshold

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "value": 0,
  • "dependentDailyJobs": [
    ],
  • "updatedByDailyJobs": [
    ],
  • "dependentMasterJobs": [
    ],
  • "updatedByMasterJobs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "value": 0,
  • "dependentDailyJobs": [
    ],
  • "updatedByDailyJobs": [
    ],
  • "dependentMasterJobs": [
    ],
  • "updatedByMasterJobs": [
    ]
}

Get a list of thresholds matching the optional provided criteria

Sample request:
GET /api/thresholds?name=T1

Authorizations:
Token
query Parameters
IncludeDependentDailyJobs
boolean

Flag to include dependent daily jobs

IncludeUpdatedByDailyJobs
boolean

Flag to include thresholds updated by daily jobs

IncludeDependentMasterJobs
boolean

Flag to include dependent master jobs

IncludeUpdatedByMasterJobs
boolean

Flag to include thresholds updated by master jobs

Offset
integer <int32>

Retrieves records beginning at this record number

Limit
integer <int32>

Limits the results being fetched. 0 retrieves just a count

Name
string

Threshold name

Value
integer <int32>

Threshold value

Ids
string

Comma-separated list of threshold ids

Description
string

Threshold description

SortBy
string

Options to sort by

SortOrders
Array of strings

Sort order (id, name, description)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tokens

/api/tokens

Authorizations:
Token

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "user": {
    },
  • "tokenType": {
    },
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validUntil": "2019-08-24T14:15:22Z",
  • "passwordExpired": true
}

/api/tokens

Authorizations:
Token
Request Body schema:
id
string or null

The token

object (User)
object (TokenType)
validFrom
string or null <date-time>

Valid start date time of the token

validUntil
string or null <date-time>

Token expiration date time

passwordExpired
boolean

Responses

Request samples

Content type
{
  • "id": "string",
  • "user": {
    },
  • "tokenType": {
    },
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validUntil": "2019-08-24T14:15:22Z",
  • "passwordExpired": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "user": {
    },
  • "tokenType": {
    },
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validUntil": "2019-08-24T14:15:22Z",
  • "passwordExpired": true
}

/api/tokens

Authorizations:
Token

Responses

/api/tokens/windowsauth

Authorizations:
Token

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "user": {
    },
  • "tokenType": {
    },
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validUntil": "2019-08-24T14:15:22Z",
  • "passwordExpired": true
}

TriggersMetadata

/api/metadata/eventTriggers

Authorizations:
Token

Responses

Users

/api/users

Authorizations:
Token
query Parameters
Limit
integer <int32>
Offset
integer <int32>
IncludeDetails
boolean
LoginName
string
UserName
string
RoleName
string
SelfServiceUser
boolean
Ids
string
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

/api/users

Authorizations:
Token
Request Body schema:
id
integer <int32>
loginName
string or null
name
string or null
password
string or null
externalPassword
string or null
externalHashedToken
string or null
details
string or null
moreDetails
string or null
Array of objects or null (Role)
language
string or null
isExternalTokenDisabled
boolean or null
isDisabled
boolean or null
forcePasswordChange
boolean or null
email
string or null
numberOfFailedPasswordAttempts
integer or null <int32>
passwordNeverExpires
boolean or null
lastPasswordChangeDate
string or null
isSelfServiceUser
boolean or null
historicalPasswords
Array of strings or null
solutionManagerSettings
string or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "loginName": "string",
  • "name": "string",
  • "password": "string",
  • "externalPassword": "string",
  • "externalHashedToken": "string",
  • "details": "string",
  • "moreDetails": "string",
  • "roles": [
    ],
  • "language": "string",
  • "isExternalTokenDisabled": true,
  • "isDisabled": true,
  • "forcePasswordChange": true,
  • "email": "string",
  • "numberOfFailedPasswordAttempts": 0,
  • "passwordNeverExpires": true,
  • "lastPasswordChangeDate": "string",
  • "isSelfServiceUser": true,
  • "historicalPasswords": [
    ],
  • "solutionManagerSettings": "string"
}

/api/users/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

/api/users/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer <int32>
loginName
string or null
name
string or null
password
string or null
externalPassword
string or null
externalHashedToken
string or null
details
string or null
moreDetails
string or null
Array of objects or null (Role)
language
string or null
isExternalTokenDisabled
boolean or null
isDisabled
boolean or null
forcePasswordChange
boolean or null
email
string or null
numberOfFailedPasswordAttempts
integer or null <int32>
passwordNeverExpires
boolean or null
lastPasswordChangeDate
string or null
isSelfServiceUser
boolean or null
historicalPasswords
Array of strings or null
solutionManagerSettings
string or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "loginName": "string",
  • "name": "string",
  • "password": "string",
  • "externalPassword": "string",
  • "externalHashedToken": "string",
  • "details": "string",
  • "moreDetails": "string",
  • "roles": [
    ],
  • "language": "string",
  • "isExternalTokenDisabled": true,
  • "isDisabled": true,
  • "forcePasswordChange": true,
  • "email": "string",
  • "numberOfFailedPasswordAttempts": 0,
  • "passwordNeverExpires": true,
  • "lastPasswordChangeDate": "string",
  • "isSelfServiceUser": true,
  • "historicalPasswords": [
    ],
  • "solutionManagerSettings": "string"
}

Version

Get the API version

Sample request: GET /api/version

Authorizations:
Token

Responses

Response samples

Content type
application/json
{
  • "opConRestApiProductVersion": "string"
}

VisionActions

Gets a list of vision actions based on the optional criteria provided.

Authorizations:
Token
query Parameters
Ids
string

A comma-separated list of action ids.

Name
string

The action name.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new vision action.

Authorizations:
Token
Request Body schema:
id
integer <int32>

The action id.

name
string or null

The action name.

Array of objects or null (VisionActionDetail)

A list of action details.

Responses

Request samples

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

Response samples

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

Gets a vision action based on the id provided.

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

Response samples

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

Updates the vision action having the specified id.

Authorizations:
Token
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer <int32>

The action id.

name
string or null

The action name.

Array of objects or null (VisionActionDetail)

A list of action details.

Responses

Request samples

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

Response samples

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

Deletes the vision action having the specified id.

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses

VisionCardAnomalies

Gets vision card anomalies based on the criteria provided.

Authorizations:
Token
query Parameters
Ids
string
From
string

The start date represented in the % QoS Failure(s) and % SLA Failure(s) frames.

To
string

The end date represented in the % QoS Failure(s) and % SLA Failure(s) frames.

CardIds
string

The card ids

ExcludeQos
boolean

Flag to exclude QoS (Quality of Service)

ExcludeSla
boolean

Flag to exclude SLA (Service Level Agreement)

Array of objects (CardTrackId)

List of Vision card track ids

Responses

Response samples

Content type
application/json
[
  • {
    }
]

VisionCards

Gets a vision card by workspace id and card id.

Authorizations:
Token
path Parameters
id
required
integer <int32>
cardId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "version": 0,
  • "trackId": "string",
  • "trackIdInternal": "a286c8f6-fa07-448e-953e-cbd6ca854a46",
  • "name": "string",
  • "description": "string",
  • "tagPattern": "string",
  • "offset": 0,
  • "qosTolerableThreshold": 0,
  • "qosCriticalThreshold": 0,
  • "slaTolerableThreshold": 0,
  • "slaCriticalThreshold": 0,
  • "remoteInstanceId": 0,
  • "remoteInstanceName": "string",
  • "remoteInstance": {
    },
  • "parentMasterVisionCard": { },
  • "parentId": 0,
  • "associatedFrequencies": [
    ],
  • "roleId": 0,
  • "roleName": "string",
  • "associatedRoles": [
    ],
  • "children": [
    ]
}

Updates the vision card having the specifid id and workspace id.

Authorizations:
Token
path Parameters
id
required
integer <int32>

The workspace id. Must be 1.

cardId
required
integer <int32>

The card id to update.

Request Body schema:
id
integer <int32>

The card id.

version
integer <int32>

The card version.

trackId
string or null

The track id in GUID format.

trackIdInternal
string or null <uuid>
name
string or null

The card name.

description
string or null

The card description.

tagPattern
string or null

The tag pattern.

offset
integer <int32>

The offset in days, +/- 5 days, of the schedule date on which Vision has to look for jobs.

qosTolerableThreshold
integer or null <int32>

Defines the value to indicate the QoS tolerable threshold (0 - 100).

qosCriticalThreshold
integer or null <int32>

Defines the value to indicate the QoS critical threshold (0 - 100).

slaTolerableThreshold
integer or null <int32>

Defines the value to indicate the SLA tolerable threshold (0 - 100).

slaCriticalThreshold
integer or null <int32>

Defines the value to indicate the SLA critical threshold (0 - 100).

remoteInstanceId
integer or null <int32>
remoteInstanceName
string or null
object (RemoteInstance)
parentMasterVisionCard
object (MasterVisionCard) Recursive
parentId
integer <int32>
Array of objects or null (MonitoredVisionFrequency)

A list of frequencies associated with the card.

roleId
integer or null <int32>
roleName
string or null
Array of objects or null (Role)

A list of roles assigned to the card.

children
Array of objects or null (MasterVisionCard)

A list of child cards assigned to the card.

Responses

Request samples

Content type
{
  • "id": 0,
  • "version": 0,
  • "trackId": "string",
  • "trackIdInternal": "a286c8f6-fa07-448e-953e-cbd6ca854a46",
  • "name": "string",
  • "description": "string",
  • "tagPattern": "string",
  • "offset": 0,
  • "qosTolerableThreshold": 0,
  • "qosCriticalThreshold": 0,
  • "slaTolerableThreshold": 0,
  • "slaCriticalThreshold": 0,
  • "remoteInstanceId": 0,
  • "remoteInstanceName": "string",
  • "remoteInstance": {
    },
  • "parentMasterVisionCard": { },
  • "parentId": 0,
  • "associatedFrequencies": [
    ],
  • "roleId": 0,
  • "roleName": "string",
  • "associatedRoles": [
    ],
  • "children": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "version": 0,
  • "trackId": "string",
  • "trackIdInternal": "a286c8f6-fa07-448e-953e-cbd6ca854a46",
  • "name": "string",
  • "description": "string",
  • "tagPattern": "string",
  • "offset": 0,
  • "qosTolerableThreshold": 0,
  • "qosCriticalThreshold": 0,
  • "slaTolerableThreshold": 0,
  • "slaCriticalThreshold": 0,
  • "remoteInstanceId": 0,
  • "remoteInstanceName": "string",
  • "remoteInstance": {
    },
  • "parentMasterVisionCard": { },
  • "parentId": 0,
  • "associatedFrequencies": [
    ],
  • "roleId": 0,
  • "roleName": "string",
  • "associatedRoles": [
    ],
  • "children": [
    ]
}

Creates a vision card.

Authorizations:
Token
path Parameters
id
required
integer <int32>

The workspace id. Must be 1.

Request Body schema:
id
integer <int32>

The card id.

version
integer <int32>

The card version.

trackId
string or null

The track id in GUID format.

trackIdInternal
string or null <uuid>
name
string or null

The card name.

description
string or null

The card description.

tagPattern
string or null

The tag pattern.

offset
integer <int32>

The offset in days, +/- 5 days, of the schedule date on which Vision has to look for jobs.

qosTolerableThreshold
integer or null <int32>

Defines the value to indicate the QoS tolerable threshold (0 - 100).

qosCriticalThreshold
integer or null <int32>

Defines the value to indicate the QoS critical threshold (0 - 100).

slaTolerableThreshold
integer or null <int32>

Defines the value to indicate the SLA tolerable threshold (0 - 100).

slaCriticalThreshold
integer or null <int32>

Defines the value to indicate the SLA critical threshold (0 - 100).

remoteInstanceId
integer or null <int32>
remoteInstanceName
string or null
object (RemoteInstance)
parentMasterVisionCard
object (MasterVisionCard) Recursive
parentId
integer <int32>
Array of objects or null (MonitoredVisionFrequency)

A list of frequencies associated with the card.

roleId
integer or null <int32>
roleName
string or null
Array of objects or null (Role)

A list of roles assigned to the card.

children
Array of objects or null (MasterVisionCard)

A list of child cards assigned to the card.

Responses

Request samples

Content type
{
  • "id": 0,
  • "version": 0,
  • "trackId": "string",
  • "trackIdInternal": "a286c8f6-fa07-448e-953e-cbd6ca854a46",
  • "name": "string",
  • "description": "string",
  • "tagPattern": "string",
  • "offset": 0,
  • "qosTolerableThreshold": 0,
  • "qosCriticalThreshold": 0,
  • "slaTolerableThreshold": 0,
  • "slaCriticalThreshold": 0,
  • "remoteInstanceId": 0,
  • "remoteInstanceName": "string",
  • "remoteInstance": {
    },
  • "parentMasterVisionCard": { },
  • "parentId": 0,
  • "associatedFrequencies": [
    ],
  • "roleId": 0,
  • "roleName": "string",
  • "associatedRoles": [
    ],
  • "children": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "version": 0,
  • "trackId": "string",
  • "trackIdInternal": "a286c8f6-fa07-448e-953e-cbd6ca854a46",
  • "name": "string",
  • "description": "string",
  • "tagPattern": "string",
  • "offset": 0,
  • "qosTolerableThreshold": 0,
  • "qosCriticalThreshold": 0,
  • "slaTolerableThreshold": 0,
  • "slaCriticalThreshold": 0,
  • "remoteInstanceId": 0,
  • "remoteInstanceName": "string",
  • "remoteInstance": {
    },
  • "parentMasterVisionCard": { },
  • "parentId": 0,
  • "associatedFrequencies": [
    ],
  • "roleId": 0,
  • "roleName": "string",
  • "associatedRoles": [
    ],
  • "children": [
    ]
}

Deletes the vision card having the specifid id, version, and workspace id.

Authorizations:
Token
path Parameters
id
required
integer <int32>

The workspace id. Must be 1.

cardId
required
integer <int32>

The card id to delete.

version
required
integer <int32>

The card version.

Responses

VisionCardStatistics

Get vision card statistics based on the optional criteria provided.

Authorizations:
Token
query Parameters
Ids
string
From
string

The start date represented in the % QoS Failure(s) and % SLA Failure(s) frames.

To
string

The end date represented in the % QoS Failure(s) and % SLA Failure(s) frames.

CardIds
string

The card ids

ExcludeQos
boolean

Flag to exclude QoS (Quality of Service)

ExcludeSla
boolean

Flag to exclude SLA (Service Level Agreement)

Array of objects (CardTrackId)

List of Vision card track ids

Responses

Response samples

Content type
application/json
[
  • {
    }
]

VisionFrequencies

Gets a list of vision frequencies.

Authorizations:
Token
query Parameters
Ids
string

A comma-separated list of frequency ids.

Name
string

The frequency name.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a vision frequency.

Authorizations:
Token
Request Body schema:
id
integer <int32>

The vision frequency id.

name
string or null

The vision frequency name.

description
string or null

The description.

type
integer or null <int32>

The vision frequency type. 0 = dates included (default); 1 = dates excluded

dates
Array of strings or null

The vision frequency dates.

Responses

Request samples

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

Response samples

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

Gets a vision frequency by id.

Authorizations:
Token
path Parameters
id
required
integer <int32>

The vision frequency id.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates the vision frequency having the id provided and returns the result, if successful.

Authorizations:
Token
path Parameters
id
required
integer <int32>

The vision frequency id.

Request Body schema:
id
integer <int32>

The vision frequency id.

name
string or null

The vision frequency name.

description
string or null

The description.

type
integer or null <int32>

The vision frequency type. 0 = dates included (default); 1 = dates excluded

dates
Array of strings or null

The vision frequency dates.

Responses

Request samples

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

Response samples

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

Deletes the vision frequency having the specified id.

Authorizations:
Token
path Parameters
id
required
integer <int32>

The vision frequency id.

Responses

VisionJobAnomalies

Gets vision job anomalies based on the criteria provided.

Authorizations:
Token
query Parameters
VisionCardAnomalyId
integer <int64>

The anomaly id.

VisionCardAnomalyIds
string

A comma-separated list of anomaly ids.

ScheduleDate
string <date-time>

The schedule date.

TagPattern
string

The tag pattern.

StartedLate
boolean

Flag to include jobs that started late.

EndedLate
boolean

Flag to include jobs that ended late.

ExpectedStartTime
string <date-time>

The expected job start time.

ExpectedEndTime
string <date-time>

The expected job end time.

ActualStartTime
string <date-time>

The actual job start time.

ActualEndTime
string <date-time>

The actual job end time.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

VisionStatistic

Get Vision Statistics

Authorizations:
Token
query Parameters
Ids
string
From
string

The start date represented in the % QoS Failure(s) and % SLA Failure(s) frames.

To
string

The end date represented in the % QoS Failure(s) and % SLA Failure(s) frames.

CardIds
string

The card ids

ExcludeQos
boolean

Flag to exclude QoS (Quality of Service)

ExcludeSla
boolean

Flag to exclude SLA (Service Level Agreement)

Array of objects (CardTrackId)

List of Vision card track ids

Responses

Response samples

Content type
application/json
{
  • "qos": 0,
  • "sla": 0,
  • "qosStatus": {
    },
  • "slaStatus": {
    },
  • "visionDayStatistics": [
    ]
}

VisionStats

/api/visionstats

Authorizations:
Token
query Parameters
Ids
string

Responses

/api/visionstats/{id}

Authorizations:
Token
path Parameters
id
required
integer <int32>

Responses