OPCON REST API (21.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.

Authentication

Token

Enter 'Token [space] {your token}' in the text input below.

Example: Token 1234-5abc-def

Security Scheme Type API Key
Header parameter name: Authorization

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:
query Parameters
Name
string or null

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

Ids
string or null

Comma-separated list of calendar unique identifier values

Limit
integer or null <int32>

Limits the results being fetched. 0 retrieves just a count

Offset
integer or null <int32>

Retrieves records beginning at this record number

SortOrders
Array of strings or null

Access code sort order

AccessibleCodes
Array of integers or null <int32>

List of accessible codes

HasAdminAccess
boolean

Flag to determine admin access

SortBy
string or null

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:
Request Body schema:

The access code object to create

id
integer or null <int32>

The id of the access code

name
string or null

The name of the access code

Responses

Request samples

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

Response samples

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

Get an access code for the id specified

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

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

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:
path Parameters
id
required
integer <int32>

The unique identifier of the access code

Request Body schema:

The access code object to update

id
integer or null <int32>

The id of the access code

name
string or null

The name of the access code

Responses

Request samples

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

Response samples

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

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:
query Parameters
Limit
integer or null <int32>
Offset
integer or null <int32>
LoginName
string or null
RoleName
string or null
IncludeRoles
boolean
Ids
string or null
SortOrder.SortBy
string or null
SortOrder.IdColumns
Array of strings or null
SortOrder.ValidSortOrders
Array of strings or null
SortOrder.ColumnList
Array of strings or null
SortOrder.SortTypeList
Array of strings or null
Platform
string or null
PlatformId
integer or null <int32>
SortBy
string or null

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "platform": {
    },
  • "loginName": "string",
  • "password": "string",
  • "roles": [
    ],
  • "updateJobs": true,
  • "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:
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 filed is null in a PUT request, it gets ignored and the existing value is unchanged. optional

Array of objects or null (Role)

Roles associated with this batch user optional

updateJobs
boolean
previousLoginName
string or null

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "platform": {
    },
  • "loginName": "string",
  • "password": "string",
  • "roles": [
    ],
  • "updateJobs": true,
  • "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:
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": [
    ],
  • "updateJobs": true,
  • "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:
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 filed is null in a PUT request, it gets ignored and the existing value is unchanged. optional

Array of objects or null (Role)

Roles associated with this batch user optional

updateJobs
boolean
previousLoginName
string or null

Responses

Request samples

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

Response samples

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

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:
query Parameters
Name
string or null

The name of the calendar to fetch

Ids
string or null

List of unique identifiers to retrieve

Limit
integer or null <int32>

Limit the number of records to fetch

Offset
integer or null <int32>

Offset the number of records being fetched

SortOrders
Array of strings or null

Ordering options

HasAdminAccess
boolean

Flag for admin access

SortBy
string or null

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

Responses

Request samples

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

Response samples

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

Get a calendar for the id specified

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

Authorizations:
path Parameters
id
required
integer <int32>

Unique identifer of the calendar to fetch.

Responses

Response samples

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

Update all properties of the calendar specified by the id

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

{  
    "id": 1,  
    "name": "CalendarName"

}
Authorizations:
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

Responses

Request samples

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

Response samples

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

DailyGraphEdges

/api/dailygraphedges

Authorizations:
query Parameters
ScheduleIds
string or null
Level
integer or null <int32>
JobIds
string or null
ScheduleDates
Array of integers or null <int32>
Dates
string or null
PredecessorLevel
integer or null <int32>
SuccessorLevel
integer or null <int32>

Responses

/api/dailygraphedges/{id}

Authorizations:
path Parameters
id
required
string or null
query Parameters
ScheduleIds
string or null
Level
integer or null <int32>
JobIds
string or null
ScheduleDates
Array of integers or null <int32>
Dates
string or null
PredecessorLevel
integer or null <int32>
SuccessorLevel
integer or null <int32>

Responses

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:
path Parameters
ScheduleId
required
integer <int32>
Instance
required
integer <int32>
ScheduleDate
required
string <date-time>
JobName
required
string or null
Id
required
string or null
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:
path Parameters
ScheduleId
required
integer <int32>
Instance
required
integer <int32>
ScheduleDate
required
string <date-time>
JobName
required
string or null
Id
required
string or null
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:
path Parameters
ScheduleId
required
integer <int32>
Instance
required
integer <int32>
ScheduleDate
required
string <date-time>
JobName
required
string or null
Id
required
string or null
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:
path Parameters
ScheduleId
required
integer <int32>
Instance
required
integer <int32>
ScheduleDate
required
string <date-time>
JobName
required
string or null
Id
required
string or null
eventId
required
integer <int32>
jobId
required
string

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

DailyJobs

/api/dailyjobs

Authorizations:
query Parameters
Uids
string or null
IncludeDocumentation
boolean
IncludeThresholdResourceDependencies
boolean
IncludeThresholdResourceUpdates
boolean
IncludeExpressionDependencies
boolean
IncludeDependencies
boolean
IncludeCount
boolean
IncludeDetails
boolean
IncludeEvents
boolean
TerminationDescription
string or null
JobName
string or null
Machine
string or null
StartMachine
string or null
PrimaryMachine
string or null
AlternateMachine
string or null
AlternateMachine2
string or null
AlternateMachine3
string or null
Reason
string or null
ScheduleDates
Array of integers or null <int32>
SortOrders
Array of strings or null
JobStatus
string or null
JobStatusCategories
Array of strings or null
JobType
string or null
PriorityValue
integer or null <int32>
ScheduleStatus
string or null
ScheduleName
string or null
Path
string or null
TagList
Array of strings or null
LimitValue
integer or null <int32>
OffsetValue
integer or null <int32>
DepartmentList
Array of integers or null <int32>
AccessCodeList
Array of integers or null <int32>
JobNumber
integer or null <int32>
Ids
string or null
ScheduleIds
string or null
Name
string or null
Dates
string or null
Status
string or null
SortBy
string or null
Priority
string or null
AccessCodeIds
string or null
Limit
string or null
Offset
string or null
Tags
string or null
Categories
string or null
DepartmentIds
string or null

Responses

/api/dailyjobs/{rawId}

Authorizations:
path Parameters
rawId
required
string or null

Responses

/api/dailyjobs/{rawId}

Authorizations:
path Parameters
rawId
required
string or null
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:
query Parameters
Uids
string or null
IncludeDocumentation
boolean
IncludeThresholdResourceDependencies
boolean
IncludeThresholdResourceUpdates
boolean
IncludeExpressionDependencies
boolean
IncludeDependencies
boolean
IncludeCount
boolean
IncludeDetails
boolean
IncludeEvents
boolean
TerminationDescription
string or null
JobName
string or null
Machine
string or null
StartMachine
string or null
PrimaryMachine
string or null
AlternateMachine
string or null
AlternateMachine2
string or null
AlternateMachine3
string or null
Reason
string or null
ScheduleDates
Array of integers or null <int32>
SortOrders
Array of strings or null
JobStatus
string or null
JobStatusCategories
Array of strings or null
JobType
string or null
PriorityValue
integer or null <int32>
ScheduleStatus
string or null
ScheduleName
string or null
Path
string or null
TagList
Array of strings or null
LimitValue
integer or null <int32>
OffsetValue
integer or null <int32>
DepartmentList
Array of integers or null <int32>
AccessCodeList
Array of integers or null <int32>
JobNumber
integer or null <int32>
Ids
string or null
ScheduleIds
string or null
Name
string or null
Dates
string or null
Status
string or null
SortBy
string or null
Priority
string or null
AccessCodeIds
string or null
Limit
string or null
Offset
string or null
Tags
string or null
Categories
string or null
DepartmentIds
string or null

Responses

/api/dailyjobs/count_by_status

Authorizations:
query Parameters
Uids
string or null
IncludeDocumentation
boolean
IncludeThresholdResourceDependencies
boolean
IncludeThresholdResourceUpdates
boolean
IncludeExpressionDependencies
boolean
IncludeDependencies
boolean
IncludeCount
boolean
IncludeDetails
boolean
IncludeEvents
boolean
TerminationDescription
string or null
JobName
string or null
Machine
string or null
StartMachine
string or null
PrimaryMachine
string or null
AlternateMachine
string or null
AlternateMachine2
string or null
AlternateMachine3
string or null
Reason
string or null
ScheduleDates
Array of integers or null <int32>
SortOrders
Array of strings or null
JobStatus
string or null
JobStatusCategories
Array of strings or null
JobType
string or null
PriorityValue
integer or null <int32>
ScheduleStatus
string or null
ScheduleName
string or null
Path
string or null
TagList
Array of strings or null
LimitValue
integer or null <int32>
OffsetValue
integer or null <int32>
DepartmentList
Array of integers or null <int32>
AccessCodeList
Array of integers or null <int32>
JobNumber
integer or null <int32>
Ids
string or null
ScheduleIds
string or null
Name
string or null
Dates
string or null
Status
string or null
SortBy
string or null
Priority
string or null
AccessCodeIds
string or null
Limit
string or null
Offset
string or null
Tags
string or null
Categories
string or null
DepartmentIds
string or null

Responses

/api/dailyjobs/{rawId}/documentation

Authorizations:
path Parameters
rawId
required
string or null

Responses

/api/dailyjobs/{rawId}/documentation

Authorizations:
path Parameters
rawId
required
string or null
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:
path Parameters
rawId
required
string or null
documentationId
required
integer <int32>

Responses

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

Authorizations:
path Parameters
rawId
required
string or null
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:
path Parameters
rawId
required
string or null
documentationId
required
integer <int32>

Responses

/api/dailyjobs/{uid}/incidentTickets

Authorizations:
path Parameters
uid
required
integer <int64>

Responses

/api/dailyjobs/{uid}/incidentTickets

Authorizations:
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:
path Parameters
jId
required
string or null

Responses

/api/dailyjobs/{rawId}/properties

Authorizations:
path Parameters
rawId
required
string or null

Responses

/api/dailyjobs/{rawId}/properties

Authorizations:
path Parameters
rawId
required
string or null
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:
path Parameters
rawId
required
string or null
name
required
string or null

Responses

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

Authorizations:
path Parameters
rawId
required
string or null
name
required
string or null
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:
path Parameters
rawId
required
string or null
name
required
string or null

Responses

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

Authorizations:
path Parameters
uid
required
integer <int64>
id
required
string or null
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:
path Parameters
uid
required
integer <int64>
id
required
string or null

Responses

/api/dailyjobs/{rawId}/events

Authorizations:
path Parameters
rawId
required
string or null

Responses

/api/dailyjobs/{rawId}/events

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

Responses

Request samples

Content type
{ }

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

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

Responses

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

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

Responses

Request samples

Content type
{ }

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

Authorizations:
path Parameters
rawId
required
string or null
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:
path Parameters
rawId
required
string or null

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:
path Parameters
rawId
required
string or null

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:
path Parameters
rawId
required
string or null

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:
path Parameters
rawId
required
string or null

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:
path Parameters
rawId
required
string or null

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:
path Parameters
rawId
required
string or null

Responses

/api/dailyjobs/{rawId}/resourceDependencies

Authorizations:
path Parameters
rawId
required
string or null
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:
path Parameters
rawId
required
string or null
resourceId
required
integer <int32>

Responses

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

Authorizations:
path Parameters
rawId
required
string or null
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:
path Parameters
rawId
required
string or null
resourceId
required
integer <int32>

Responses

/api/dailyjobs/{rawId}/thresholdDependencies

Authorizations:
path Parameters
rawId
required
string or null

Responses

/api/dailyjobs/{rawId}/thresholdDependencies

Authorizations:
path Parameters
rawId
required
string or null
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:
path Parameters
rawId
required
string or null
thresholdId
required
integer <int32>

Responses

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

Authorizations:
path Parameters
rawId
required
string or null
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:
path Parameters
rawId
required
string or null
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:
path Parameters
jobId
required
string or null

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:
path Parameters
jobId
required
string or null
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:
path Parameters
jobId
required
string or null
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:
path Parameters
jobId
required
string or null
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:
path Parameters
jobId
required
string or null
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:
path Parameters
jobId
required
string or null
id
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DailySchedules

/api/dailyschedules/count_by_status

Authorizations:
query Parameters
IncludeAll
boolean
IncludeProperties
boolean
IncludeDetails
boolean
IncludeEvents
boolean
uids
string or null
SortOrders
Array of strings or null
ScheduleDates
Array of integers or null <int32>
ScheduleCategories
Array of strings or null
Ids
string or null
Name
string or null
Status
string or null
Categories
string or null
FailedJobs
boolean or null
Offset
integer or null <int32>
Limit
integer or null <int32>
Path
string or null
SortBy
string or null
Dates
string or null

Responses

/api/dailyschedules/dates

Authorizations:
query Parameters
IncludeAll
boolean
IncludeProperties
boolean
IncludeDetails
boolean
IncludeEvents
boolean
uids
string or null
SortOrders
Array of strings or null
ScheduleDates
Array of integers or null <int32>
ScheduleCategories
Array of strings or null
Ids
string or null
Name
string or null
Status
string or null
Categories
string or null
FailedJobs
boolean or null
Offset
integer or null <int32>
Limit
integer or null <int32>
Path
string or null
SortBy
string or null
Dates
string or null

Responses

/api/dailyschedules/{id}/details

Authorizations:
path Parameters
id
required
string or null

Responses

/api/dailyschedules/{id}

Authorizations:
path Parameters
id
required
string or null

Responses

/api/dailyschedules/{id}

Authorizations:
path Parameters
id
required
string or null
Request Body schema:
uid
integer or null <int64>
Array of objects or null (InstanceProperty)
dateAsInteger
integer <int32>
id
string or null
masterId
integer <int32>
object (DailyScheduleDetails)
object (ComputedTime)
definedStartTime
string or null
endTime
string or null
name
string or null
object (ScheduleStatus)
instance
integer or null <int32>
duration
integer or null <int64>
date
string or null
path
string or null
containerJobId
string or null
workWeek
integer <int32>
Array of objects or null (ScheduleJobEventModel)

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": [
    ]
}

/api/dailyschedules

Authorizations:
query Parameters
IncludeAll
boolean
IncludeProperties
boolean
IncludeDetails
boolean
IncludeEvents
boolean
uids
string or null
SortOrders
Array of strings or null
ScheduleDates
Array of integers or null <int32>
ScheduleCategories
Array of strings or null
Ids
string or null
Name
string or null
Status
string or null
Categories
string or null
FailedJobs
boolean or null
Offset
integer or null <int32>
Limit
integer or null <int32>
Path
string or null
SortBy
string or null
Dates
string or null

Responses

/api/dailyschedules/{id}/properties

Authorizations:
path Parameters
id
required
string or null

Responses

/api/dailyschedules/{id}/properties

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

Responses

Request samples

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

/api/dailyschedules/{id}/properties/{name}

Authorizations:
path Parameters
id
required
string or null
name
required
string or null

Responses

/api/dailyschedules/{id}/properties/{name}

Authorizations:
path Parameters
id
required
string or null
name
required
string or null
Request Body schema:
key
string or null
value
string or null

Responses

Request samples

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

/api/dailyschedules/{id}/properties/{name}

Authorizations:
path Parameters
id
required
string or null
name
required
string or null

Responses

DailyVisionWorkspaces

/api/dailyvisionworkspaces

Authorizations:
query Parameters
DayOffset
integer or null <int32>
IncludeCardsWithoutStatus
boolean or null

Responses

/api/dailyvisionworkspaces/{id}

Authorizations:
path Parameters
id
required
integer <int32>
query Parameters
DayOffset
integer or null <int32>
IncludeCardsWithoutStatus
boolean or null

Responses

Departments

Get a department for the id specified

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

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

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:
query Parameters
Name
string or null
Limit
integer or null <int32>
Offset
integer or null <int32>
Ids
string or null
SortOrders
Array of strings or null
HasAccess
boolean
AccessibleDepartments
Array of integers or null <int32>
SortBy
string or null

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

EventsMetadata

/api/metadata/events

Authorizations:

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:
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:
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:
query Parameters
JobTypeId
integer <int32>
Name
string or null

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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:
query Parameters
Limit
integer or null <int32>
Offset
integer or null <int32>
Name
string or null
Encrypted
string or null
Ids
string or null
Value
string or null
NameOrValue
string or null
NoPatternValue
boolean or null
SortOrder.SortBy
string or null
SortOrder.IdColumns
Array of strings or null
SortOrder.ValidSortOrders
Array of strings or null
SortOrder.ColumnList
Array of strings or null
SortOrder.SortTypeList
Array of strings or null
SortBy
string or null

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:
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:
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:
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:
path Parameters
id
required
integer <int32>

The id of the global property to delete

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

HistoryJob

/api/jobHistories

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

Responses

ImpEx

/api/impex/schedules

Authorizations:
query Parameters
Ids
Array of integers or null <int32>
Name
string or null
Offset
integer or null <int32>
Limit
integer or null <int32>
AutoBuild
boolean or null
MultiInstance
boolean or null
SubSchedule
boolean or null

Responses

/api/impex/schedules

Authorizations:
Request Body schema:
id
integer <int32>
name
string or null
documentation
string or null
type
string or null
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)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "documentation": "string",
  • "type": "string",
  • "weekDays": {
    },
  • "startOffset": {
    },
  • "useMasterHoliday": true,
  • "additionalHolidays": {
    },
  • "conflictsWithOtherDays": true,
  • "autoBuildSettings": {
    },
  • "singleInstanceProperties": {
    },
  • "multiInstanceProperties": {
    }
}

/api/impex/schedules/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

/api/impex/schedules/{id}

Authorizations:
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer <int32>
name
string or null
documentation
string or null
type
string or null
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)

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "documentation": "string",
  • "type": "string",
  • "weekDays": {
    },
  • "startOffset": {
    },
  • "useMasterHoliday": true,
  • "additionalHolidays": {
    },
  • "conflictsWithOtherDays": true,
  • "autoBuildSettings": {
    },
  • "singleInstanceProperties": {
    },
  • "multiInstanceProperties": {
    }
}

/api/impex/schedules/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

JobActions

/api/jobactions/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

/api/jobactions

Authorizations:
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:
path Parameters
id
required
integer <int32>

Responses

/api/jobinstanceactions

Authorizations:
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:
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:
query Parameters
id
integer <int32>

Responses

JobTags

/api/jobtags

Authorizations:
query Parameters
RemoteInstance
string or null
Name
string or null
Limit
integer or null <int32>
Offset
integer or null <int32>
SortOrders
Array of strings or null
SortBy
string or null

Responses

LicenseTaskCount

/api/licenseTaskCount

Authorizations:
query Parameters
From
string or null
To
string or null
JobTypeIds
string or null
DepartmentIds
string or null

Responses

Logs

/api/logs

Authorizations:
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:
query Parameters
FileName
string or null
Application
string or null
UserId
integer or null <int32>
SessionId
integer or null <int64>

Responses

/api/logs/{filePath}

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

Responses

MachineActions

/api/MachineActions/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

/api/MachineActions

Authorizations:
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:
query Parameters
Offset
integer or null <int32>
Limit
integer or null <int32>
Name
string or null
Type
string or null
Ids
string or null
TypeIds
string or null
IncludeMachines
boolean
HasAdminAccess
boolean
AccessibleMachineGroups
Array of integers or null <int32>
SortBy
string or null
SortOrders
Array of strings or null

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:
Request Body schema:
id
integer or null <int32>
documentation
string or null
name
string or null
object (MachineGroupType)
Array of objects or null (Machine)

Responses

Request samples

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

Response samples

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

Get an machine group for the id specified

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

Authorizations:
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": [
    ]
}

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:
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)

Responses

Request samples

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

Response samples

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

Machines

/api/machines

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

Responses

/api/machines

Authorizations:
Request Body schema:
osType
string or null
agentVersion
string or null
osVersion
string or null
useTlSforSchedulingCommunications
boolean or null
name
string or null
id
integer or null <int32>
object (LsamType)
socket
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>
currentJobs
integer or null <int32>
object (MachineStatus)
requiresXmlEscape
boolean or null
agentSmaCommunicationsProtocol
string or null
allowKillJob
boolean or null
tcpIpAddress
string or null
pollInterval
integer or null <int32>
checkMachineStatusInterval
integer or null <int32>
connectionAttemptTimeout
integer or null <int32>
noBufferRetryCount
integer or null <int32>
noBufferSleepTime
integer or null <int32>
maxConsecutiveSendMessages
integer or null <int32>
consecutiveSendSleepTimeMilliseconds
integer or null <int32>
sendBufferCount
integer or null <int32>
receiveBufferCount
integer or null <int32>
maxBytesSentPerMessage
integer or null <int32>
maxBytesReadPerMessage
integer or null <int32>
responseTimeoutInSeconds
integer or null <int32>
agentCheckCrc
boolean or null
closeSocketDuringSynchronization
boolean or null
traceAllMessages
boolean or null
smaNetComIdentifier
string or null
gatewayName
string or null
jorsPortNumber
integer or null <int32>
fileTransferRole
string or null
fileTransferIpAddress
string or null
Array of Array of objects or null (InstanceProperty)
fileTransferPortNumberForNonTls
integer or null <int32>
fileTransferPortNumberForTls
integer or null <int32>
agentFileTransferPortNumberForTls
string or null
lsamTime
number or null <double>
lsamTimeDeltafromSam
integer or null <int32>
fullyQualifiedDomainName
string or null
fullFileTransferSupport
boolean or null
supportsHandshake
string or null
tlsCertificateDistinguishedName
string or null
checkCertificateRevocaionList
boolean or null
supportTlsForSmaftAgent
boolean or null
agentSupportTlsForSmaftAgent
string or null
supportTlsForSmaftServer
boolean or null
agentSupportTlsForSmaftServer
string or null
supportNonTlsForSmaftAgent
boolean or null
agentSupportNonTlsForSmaftAgent
string or null
supportNonTlsForSmaftServer
boolean or null
agentSupportNonTlsForSmaftServer
string or null
timeOffsetfromUtcInHours
number or null <double>
timeZoneName
string or null
timeOffsetfromSamInHours
number or null <double>
timeSent
string or null
hostname
string or null
agentName
string or null
agentSocket
string or null
jorsSocket
string or null
smaftServerPortForNonTls
string or null
smaftAgentPort
string or null
machineMaximumJobs
string or null
smaCommunicationsProtocol
string or null
checkCrc
string or null
closeSocket
string or null
acceptMessagesfromIp
string or null
smaNetComSocket
string or null
cpuid
string or null
cpuType
string or null
cpuModel
string or null
cpuCount
string or null
fileTransferFeature
string or null
jorsFeature
string or null
resourceMonitorFeature
string or null
agentSpecialFeatures
string or null
tlsCertificateSerialNumber
string or null
supportedAgentCapability
Array of strings or null
documentation
string or null
hpNonStopIpAddress
string or null
hpNonStopSocketNumber
integer or null <int32>

Responses

Request samples

Content type
{
  • "osType": "string",
  • "agentVersion": "string",
  • "osVersion": "string",
  • "useTlSforSchedulingCommunications": true,
  • "name": "string",
  • "id": 0,
  • "type": {
    },
  • "socket": 0,
  • "gatewayId": 0,
  • "groups": [
    ],
  • "lastUpdateDateTime": "string",
  • "lastUpdate": 0,
  • "maximumJobs": 0,
  • "opConMaximumJobs": 0,
  • "currentJobs": 0,
  • "state": {
    },
  • "requiresXmlEscape": true,
  • "agentSmaCommunicationsProtocol": "string",
  • "allowKillJob": true,
  • "tcpIpAddress": "string",
  • "pollInterval": 0,
  • "checkMachineStatusInterval": 0,
  • "connectionAttemptTimeout": 0,
  • "noBufferRetryCount": 0,
  • "noBufferSleepTime": 0,
  • "maxConsecutiveSendMessages": 0,
  • "consecutiveSendSleepTimeMilliseconds": 0,
  • "sendBufferCount": 0,
  • "receiveBufferCount": 0,
  • "maxBytesSentPerMessage": 0,
  • "maxBytesReadPerMessage": 0,
  • "responseTimeoutInSeconds": 0,
  • "agentCheckCrc": true,
  • "closeSocketDuringSynchronization": true,
  • "traceAllMessages": true,
  • "smaNetComIdentifier": "string",
  • "gatewayName": "string",
  • "jorsPortNumber": 0,
  • "fileTransferRole": "string",
  • "fileTransferIpAddress": "string",
  • "availableProperties": [
    ],
  • "fileTransferPortNumberForNonTls": 0,
  • "fileTransferPortNumberForTls": 0,
  • "agentFileTransferPortNumberForTls": "string",
  • "lsamTime": 0,
  • "lsamTimeDeltafromSam": 0,
  • "fullyQualifiedDomainName": "string",
  • "fullFileTransferSupport": true,
  • "supportsHandshake": "string",
  • "tlsCertificateDistinguishedName": "string",
  • "checkCertificateRevocaionList": true,
  • "supportTlsForSmaftAgent": true,
  • "agentSupportTlsForSmaftAgent": "string",
  • "supportTlsForSmaftServer": true,
  • "agentSupportTlsForSmaftServer": "string",
  • "supportNonTlsForSmaftAgent": true,
  • "agentSupportNonTlsForSmaftAgent": "string",
  • "supportNonTlsForSmaftServer": true,
  • "agentSupportNonTlsForSmaftServer": "string",
  • "timeOffsetfromUtcInHours": 0,
  • "timeZoneName": "string",
  • "timeOffsetfromSamInHours": 0,
  • "timeSent": "string",
  • "hostname": "string",
  • "agentName": "string",
  • "agentSocket": "string",
  • "jorsSocket": "string",
  • "smaftServerPortForNonTls": "string",
  • "smaftAgentPort": "string",
  • "machineMaximumJobs": "string",
  • "smaCommunicationsProtocol": "string",
  • "checkCrc": "string",
  • "closeSocket": "string",
  • "acceptMessagesfromIp": "string",
  • "smaNetComSocket": "string",
  • "cpuid": "string",
  • "cpuType": "string",
  • "cpuModel": "string",
  • "cpuCount": "string",
  • "fileTransferFeature": "string",
  • "jorsFeature": "string",
  • "resourceMonitorFeature": "string",
  • "agentSpecialFeatures": "string",
  • "tlsCertificateSerialNumber": "string",
  • "supportedAgentCapability": [
    ],
  • "documentation": "string",
  • "hpNonStopIpAddress": "string",
  • "hpNonStopSocketNumber": 0
}

/api/machines/count_by_status

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

Responses

/api/machines/{id}/properties

Authorizations:
path Parameters
id
required
integer <int32>

Responses

/api/machines/{id}/properties

Authorizations:
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:
path Parameters
id
required
integer <int32>
name
required
string or null

Responses

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

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

Responses

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

Authorizations:
path Parameters
id
required
integer <int32>
name
required
string or null
Request Body schema:
key
string or null
value
string or null

Responses

Request samples

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

/api/machines/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

/api/machines/{id}

Authorizations:
path Parameters
id
required
integer <int32>
Request Body schema:
osType
string or null
agentVersion
string or null
osVersion
string or null
useTlSforSchedulingCommunications
boolean or null
name
string or null
id
integer or null <int32>
object (LsamType)
socket
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>
currentJobs
integer or null <int32>
object (MachineStatus)
requiresXmlEscape
boolean or null
agentSmaCommunicationsProtocol
string or null
allowKillJob
boolean or null
tcpIpAddress
string or null
pollInterval
integer or null <int32>
checkMachineStatusInterval
integer or null <int32>
connectionAttemptTimeout
integer or null <int32>
noBufferRetryCount
integer or null <int32>
noBufferSleepTime
integer or null <int32>
maxConsecutiveSendMessages
integer or null <int32>
consecutiveSendSleepTimeMilliseconds
integer or null <int32>
sendBufferCount
integer or null <int32>
receiveBufferCount
integer or null <int32>
maxBytesSentPerMessage
integer or null <int32>
maxBytesReadPerMessage
integer or null <int32>
responseTimeoutInSeconds
integer or null <int32>
agentCheckCrc
boolean or null
closeSocketDuringSynchronization
boolean or null
traceAllMessages
boolean or null
smaNetComIdentifier
string or null
gatewayName
string or null
jorsPortNumber
integer or null <int32>
fileTransferRole
string or null
fileTransferIpAddress
string or null
Array of Array of objects or null (InstanceProperty)
fileTransferPortNumberForNonTls
integer or null <int32>
fileTransferPortNumberForTls
integer or null <int32>
agentFileTransferPortNumberForTls
string or null
lsamTime
number or null <double>
lsamTimeDeltafromSam
integer or null <int32>
fullyQualifiedDomainName
string or null
fullFileTransferSupport
boolean or null
supportsHandshake
string or null
tlsCertificateDistinguishedName
string or null
checkCertificateRevocaionList
boolean or null
supportTlsForSmaftAgent
boolean or null
agentSupportTlsForSmaftAgent
string or null
supportTlsForSmaftServer
boolean or null
agentSupportTlsForSmaftServer
string or null
supportNonTlsForSmaftAgent
boolean or null
agentSupportNonTlsForSmaftAgent
string or null
supportNonTlsForSmaftServer
boolean or null
agentSupportNonTlsForSmaftServer
string or null
timeOffsetfromUtcInHours
number or null <double>
timeZoneName
string or null
timeOffsetfromSamInHours
number or null <double>
timeSent
string or null
hostname
string or null
agentName
string or null
agentSocket
string or null
jorsSocket
string or null
smaftServerPortForNonTls
string or null
smaftAgentPort
string or null
machineMaximumJobs
string or null
smaCommunicationsProtocol
string or null
checkCrc
string or null
closeSocket
string or null
acceptMessagesfromIp
string or null
smaNetComSocket
string or null
cpuid
string or null
cpuType
string or null
cpuModel
string or null
cpuCount
string or null
fileTransferFeature
string or null
jorsFeature
string or null
resourceMonitorFeature
string or null
agentSpecialFeatures
string or null
tlsCertificateSerialNumber
string or null
supportedAgentCapability
Array of strings or null
documentation
string or null
hpNonStopIpAddress
string or null
hpNonStopSocketNumber
integer or null <int32>

Responses

Request samples

Content type
{
  • "osType": "string",
  • "agentVersion": "string",
  • "osVersion": "string",
  • "useTlSforSchedulingCommunications": true,
  • "name": "string",
  • "id": 0,
  • "type": {
    },
  • "socket": 0,
  • "gatewayId": 0,
  • "groups": [
    ],
  • "lastUpdateDateTime": "string",
  • "lastUpdate": 0,
  • "maximumJobs": 0,
  • "opConMaximumJobs": 0,
  • "currentJobs": 0,
  • "state": {
    },
  • "requiresXmlEscape": true,
  • "agentSmaCommunicationsProtocol": "string",
  • "allowKillJob": true,
  • "tcpIpAddress": "string",
  • "pollInterval": 0,
  • "checkMachineStatusInterval": 0,
  • "connectionAttemptTimeout": 0,
  • "noBufferRetryCount": 0,
  • "noBufferSleepTime": 0,
  • "maxConsecutiveSendMessages": 0,
  • "consecutiveSendSleepTimeMilliseconds": 0,
  • "sendBufferCount": 0,
  • "receiveBufferCount": 0,
  • "maxBytesSentPerMessage": 0,
  • "maxBytesReadPerMessage": 0,
  • "responseTimeoutInSeconds": 0,
  • "agentCheckCrc": true,
  • "closeSocketDuringSynchronization": true,
  • "traceAllMessages": true,
  • "smaNetComIdentifier": "string",
  • "gatewayName": "string",
  • "jorsPortNumber": 0,
  • "fileTransferRole": "string",
  • "fileTransferIpAddress": "string",
  • "availableProperties": [
    ],
  • "fileTransferPortNumberForNonTls": 0,
  • "fileTransferPortNumberForTls": 0,
  • "agentFileTransferPortNumberForTls": "string",
  • "lsamTime": 0,
  • "lsamTimeDeltafromSam": 0,
  • "fullyQualifiedDomainName": "string",
  • "fullFileTransferSupport": true,
  • "supportsHandshake": "string",
  • "tlsCertificateDistinguishedName": "string",
  • "checkCertificateRevocaionList": true,
  • "supportTlsForSmaftAgent": true,
  • "agentSupportTlsForSmaftAgent": "string",
  • "supportTlsForSmaftServer": true,
  • "agentSupportTlsForSmaftServer": "string",
  • "supportNonTlsForSmaftAgent": true,
  • "agentSupportNonTlsForSmaftAgent": "string",
  • "supportNonTlsForSmaftServer": true,
  • "agentSupportNonTlsForSmaftServer": "string",
  • "timeOffsetfromUtcInHours": 0,
  • "timeZoneName": "string",
  • "timeOffsetfromSamInHours": 0,
  • "timeSent": "string",
  • "hostname": "string",
  • "agentName": "string",
  • "agentSocket": "string",
  • "jorsSocket": "string",
  • "smaftServerPortForNonTls": "string",
  • "smaftAgentPort": "string",
  • "machineMaximumJobs": "string",
  • "smaCommunicationsProtocol": "string",
  • "checkCrc": "string",
  • "closeSocket": "string",
  • "acceptMessagesfromIp": "string",
  • "smaNetComSocket": "string",
  • "cpuid": "string",
  • "cpuType": "string",
  • "cpuModel": "string",
  • "cpuCount": "string",
  • "fileTransferFeature": "string",
  • "jorsFeature": "string",
  • "resourceMonitorFeature": "string",
  • "agentSpecialFeatures": "string",
  • "tlsCertificateSerialNumber": "string",
  • "supportedAgentCapability": [
    ],
  • "documentation": "string",
  • "hpNonStopIpAddress": "string",
  • "hpNonStopSocketNumber": 0
}

Maintenance

/api/servicestatus

Authorizations:

Responses

MasterInstances

/api/masterinstances

Authorizations:
query Parameters
Ids
string or null

Responses

/api/masterinstances

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

Responses

Request samples

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

/api/masterinstances/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

/api/masterinstances/{id}

Authorizations:
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

/api/masterjobs/{rawId}

Authorizations:
path Parameters
rawId
required
string or null

Responses

/api/masterjobs

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

Responses

/api/masterjobs/count

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

Responses

MasterSchedules

/api/MasterSchedules

Authorizations:
query Parameters
Name
string or null
Ids
string or null
Sortby
string or null
Limit
integer or null <int32>
Offset
integer or null <int32>
SortOrders
Array of strings or null
SubSchedule
boolean or null
MultiInstance
boolean or null
AutoBuild
boolean or null

Responses

/api/MasterSchedules/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

/api/MasterSchedules/count

Authorizations:
query Parameters
Name
string or null
Ids
string or null
Sortby
string or null
Limit
integer or null <int32>
Offset
integer or null <int32>
SortOrders
Array of strings or null
SubSchedule
boolean or null
MultiInstance
boolean or null
AutoBuild
boolean or null

Responses

MasterVisionWorkspaces

/api/mastervisionworkspaces

Authorizations:
query Parameters
Ids
string or null
Name
string or null

Responses

/api/mastervisionworkspaces

Authorizations:
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:
path Parameters
id
required
integer <int32>

Responses

/api/mastervisionworkspaces/{id}

Authorizations:
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": [
    ]
}

NamedInstances

/api/namedInstances

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

Responses

/api/namedInstances/{instanceId}

Authorizations:
path Parameters
instanceId
required
integer <int32>

Responses

OpConEvents

/api/opconEventsCollection

Authorizations:
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:
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:

Responses

RefreshVisionCache

/api/refreshVisionCache

Authorizations:
query Parameters
RefreshStatistics
boolean

Responses

RemoteInstances

/api/remoteinstances

Authorizations:
query Parameters
Ids
string or null
Name
string or null

Responses

/api/remoteinstances

Authorizations:
Request Body schema:
status
integer <int32> (RemoteInstanceStatus)
Enum: 1 2
id
integer <int32>
name
string or null
description
string or null
object (RemoteInstanceDatabaseConnection)
apiBaseUrl
string or null
solutionManagerBaseUrl
string or null
object (User)
object (Token)
masterInstanceId
integer or null <int32>
connectionString
string or null
Array of objects or null (User)

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:
path Parameters
id
required
integer <int32>

Responses

/api/remoteinstances/{id}

Authorizations:
path Parameters
id
required
integer <int32>
Request Body schema:
status
integer <int32> (RemoteInstanceStatus)
Enum: 1 2
id
integer <int32>
name
string or null
description
string or null
object (RemoteInstanceDatabaseConnection)
apiBaseUrl
string or null
solutionManagerBaseUrl
string or null
object (User)
object (Token)
masterInstanceId
integer or null <int32>
connectionString
string or null
Array of objects or null (User)

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:
path Parameters
id
required
integer <int32>

Responses

Resources

/api/resources/{id}

Authorizations:
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer or null <int32>
name
string or null
description
string or null
value
integer or null <int32>
Array of objects or null (ThresholdResourceDailyJob)
Array of objects or null (ThresholdResourceDailyJob)
Array of objects or null (ThresholdResourceMasterJob)
Array of objects or null (ThresholdResourceMasterJob)
used
integer or null <int32>

Responses

Request samples

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

/api/resources/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

/api/resources/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

/api/resources

Authorizations:
Request Body schema:
id
integer or null <int32>
name
string or null
description
string or null
value
integer or null <int32>
Array of objects or null (ThresholdResourceDailyJob)
Array of objects or null (ThresholdResourceDailyJob)
Array of objects or null (ThresholdResourceMasterJob)
Array of objects or null (ThresholdResourceMasterJob)
used
integer or null <int32>

Responses

Request samples

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

/api/resources

Authorizations:
query Parameters
IncludeDependentDailyJobs
boolean
IncludeUpdatedByDailyJobs
boolean
IncludeDependentMasterJobs
boolean
IncludeUpdatedByMasterJobs
boolean
Offset
integer or null <int32>
Limit
integer or null <int32>
Name
string or null
Value
integer or null <int32>
Ids
string or null
Description
string or null
SortBy
string or null
SortOrders
Array of strings or null

Responses

Roles

/api/roles

Authorizations:
query Parameters
Limit
integer or null <int32>
Offset
integer or null <int32>
IncludeAccessCodes
boolean
IncludeDepartmentFunctions
boolean
IncludeMachines
boolean
IncludeMachineGroups
boolean
IncludeSchedules
boolean
IncludeServiceRequests
boolean
IncludeBatchUsers
boolean
IncludeUsers
boolean
Name
string or null
Ids
string or null
SortOrder.SortBy
string or null
SortOrder.IdColumns
Array of strings or null
SortOrder.ValidSortOrders
Array of strings or null
SortOrder.ColumnList
Array of strings or null
SortOrder.SortTypeList
Array of strings or null
SortBy
string or null
IncludeEmbeddedScripts
boolean

Responses

/api/roles

Authorizations:
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:
path Parameters
id
required
integer <int32>

Responses

/api/roles/{id}

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

ScheduleActions

/api/scheduleactions/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

/api/scheduleactions

Authorizations:
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:
path Parameters
id
required
integer <int32>

Responses

/api/scheduleActionsByDate

Authorizations:
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:
path Parameters
id
required
integer <int32>

Responses

/api/schedulebuilds

Authorizations:
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
}

ScriptRunners

/api/scriptRunners

Authorizations:
query Parameters
ScriptTypeId
integer or null <int32>
PlatformId
integer or null <int32>
Name
string or null
Ids
string or null

Responses

/api/scriptRunners/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

Scripts

/api/scripts

Authorizations:
query Parameters
ScriptName
string or null
ScriptTypeName
string or null
ScriptIds
string or null
RunnerOsId
integer <int32>
Limit
integer or null <int32>
Offset
integer or null <int32>
IncludeVersions
boolean

Responses

/api/scripts/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

/api/scripts/{scriptId}/versions/{versionId}

Authorizations:
path Parameters
scriptId
required
integer <int32>
versionId
required
integer <int32>

Responses

/api/scriptVersions/{scriptVersionId}

Authorizations:
path Parameters
scriptVersionId
required
integer <int32>

Responses

ServerOptions

/api/serveroptions

Authorizations:

Responses

/api/serveroptions

Authorizations:
Request Body schema:
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
{
  • "enableWindowsAuthentication": true,
  • "numberOfDaysToKeepServiceRequestExecutions": 0,
  • "htmlDocumentation": {
    },
  • "passwordPolicy": {
    },
  • "visionSettings": {
    },
  • "solutionManagerSettings": "string",
  • "ticketingSystemName": "string",
  • "loginSecureMessage": "string",
  • "settings": [
    ]
}

ServiceRequestCategories

/api/servicerequestcategories

Authorizations:
query Parameters
Limit
integer or null <int32>
Offset
integer or null <int32>
IncludeServiceRequests
boolean
Name
string or null
Color
string or null
ServiceRequestName
string or null
Ids
string or null
SortOrder.SortBy
string or null
SortOrder.IdColumns
Array of strings or null
SortOrder.ValidSortOrders
Array of strings or null
SortOrder.ColumnList
Array of strings or null
SortOrder.SortTypeList
Array of strings or null
SortBy
string or null

Responses

/api/servicerequestcategories

Authorizations:
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:
path Parameters
id
required
integer <int32>

Responses

/api/servicerequestcategories/{id}

Authorizations:
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:
path Parameters
id
required
integer <int32>

Responses

ServiceRequestExecutions

/api/servicerequestexecutions

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

Responses

/api/servicerequestexecutions

Authorizations:
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:
path Parameters
id
required
integer <int32>

Responses

/api/servicerequestexecutions/{id}

Authorizations:
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:
path Parameters
id
required
integer <int32>

Responses

/api/servicerequestexecutions/count_by_{field}

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

Responses

/api/selfServiceRequestExecutions/count_by_{field}

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

Responses

/api/selfServiceRequestExecutions

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

Responses

/api/selfServiceRequestExecutions

Authorizations:
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:
path Parameters
id
required
integer <int32>

Responses

ServiceRequests

/api/servicerequests

Authorizations:
query Parameters
Limit
integer or null <int32>
Offset
integer or null <int32>
IncludeRoles
boolean
EvaluateRules
boolean
Name
string or null
CategoryName
string or null
RoleName
string or null
Ids
string or null
SortOrder.SortBy
string or null
SortOrder.IdColumns
Array of strings or null
SortOrder.ValidSortOrders
Array of strings or null
SortOrder.ColumnList
Array of strings or null
SortOrder.SortTypeList
Array of strings or null
SortBy
string or null

Responses

/api/servicerequests

Authorizations:
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:
path Parameters
id
required
integer <int32>

Responses

/api/servicerequests/{id}

Authorizations:
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:
path Parameters
id
required
integer <int32>

Responses

/api/selfServiceRequests/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

/api/selfServiceRequests/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

/api/selfServiceRequests/{id}

Authorizations:
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:
query Parameters
Limit
integer or null <int32>
Offset
integer or null <int32>
IncludeRoles
boolean
EvaluateRules
boolean
Name
string or null
CategoryName
string or null
RoleName
string or null
Ids
string or null
SortOrder.SortBy
string or null
SortOrder.IdColumns
Array of strings or null
SortOrder.ValidSortOrders
Array of strings or null
SortOrder.ColumnList
Array of strings or null
SortOrder.SortTypeList
Array of strings or null
SortBy
string or null

Responses

/api/selfServiceRequests

Authorizations:
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:
query Parameters
Ids
string or null
Name
string or null
RoleId
integer or null <int32>
UserId
integer or null <int32>
GlobalOnly
boolean or null
Public
boolean or null
UserCanWrite
boolean or null

Responses

/api/solutionManagerSettings

Authorizations:
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:
path Parameters
id
required
string or null

Responses

/api/solutionManagerSettings/{id}

Authorizations:
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:
path Parameters
id
required
integer <int32>

Responses

Thresholds

/api/thresholds/{id}

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

Responses

Request samples

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

/api/thresholds/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

/api/thresholds/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

/api/thresholds

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

Responses

Request samples

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

/api/thresholds

Authorizations:
query Parameters
IncludeDependentDailyJobs
boolean
IncludeUpdatedByDailyJobs
boolean
IncludeDependentMasterJobs
boolean
IncludeUpdatedByMasterJobs
boolean
Offset
integer or null <int32>
Limit
integer or null <int32>
Name
string or null
Value
integer or null <int32>
Ids
string or null
Description
string or null
SortBy
string or null
SortOrders
Array of strings or null

Responses

Tokens

/api/tokens

Authorizations:

Responses

/api/tokens

Authorizations:
Request Body schema:
id
string or null
object (User)
object (TokenType)
validFrom
string or null <date-time>
validUntil
string or null <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
}

/api/tokens

Authorizations:

Responses

/api/tokens/windowsauth

Authorizations:

Responses

/api/tokens/{id}

Authorizations:
path Parameters
id
required
string or null
Request Body schema:
id
string or null
object (User)
object (TokenType)
validFrom
string or null <date-time>
validUntil
string or null <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
}

TriggersMetadata

/api/metadata/eventTriggers

Authorizations:

Responses

Users

/api/users

Authorizations:
query Parameters
Limit
integer or null <int32>
Offset
integer or null <int32>
IncludeDetails
boolean
LoginName
string or null
UserName
string or null
RoleName
string or null
SelfServiceUser
boolean or null
Ids
string or null
SortOrder.SortBy
string or null
SortOrder.IdColumns
Array of strings or null
SortOrder.ValidSortOrders
Array of strings or null
SortOrder.ColumnList
Array of strings or null
SortOrder.SortTypeList
Array of strings or null
SortBy
string or null

Responses

/api/users

Authorizations:
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:
path Parameters
id
required
integer <int32>

Responses

/api/users/{id}

Authorizations:
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

/api/version

Authorizations:

Responses

VisionActions

/api/visionactions

Authorizations:
query Parameters
Ids
string or null
Name
string or null

Responses

/api/visionactions

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

Responses

Request samples

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

/api/visionactions/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

/api/visionactions/{id}

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

Responses

Request samples

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

/api/visionactions/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

VisionCardAnomalies

/api/visioncardanomalies

Authorizations:
query Parameters
Ids
string or null
From
string or null
To
string or null
CardIds
string or null
ExcludeQos
boolean or null
ExcludeSla
boolean or null
Array of objects or null (CardTrackId)

Responses

VisionCards

/api/mastervisionworkspaces/{id}/visioncards/{cardId}

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

Responses

/api/mastervisionworkspaces/{id}/visioncards/{cardId}

Authorizations:
path Parameters
id
required
integer <int32>
cardId
required
integer <int32>
Request Body schema:
id
integer <int32>
version
integer <int32>
trackId
string or null
trackIdInternal
string or null <uuid>
name
string or null
description
string or null
tagPattern
string or null
offset
integer <int32>
qosTolerableThreshold
integer or null <int32>
qosCriticalThreshold
integer or null <int32>
slaTolerableThreshold
integer or null <int32>
slaCriticalThreshold
integer or null <int32>
remoteInstanceId
integer or null <int32>
remoteInstanceName
string or null
object (RemoteInstance)
parentMasterVisionCard
object (MasterVisionCard) Recursive
parentId
integer <int32>
Array of objects or null (MonitoredVisionFrequency)
roleId
integer or null <int32>
roleName
string or null
Array of objects or null (Role)
Array of objects or null (MasterVisionCard)

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": [
    ]
}

/api/mastervisionworkspaces/{id}/visioncards

Authorizations:
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer <int32>
version
integer <int32>
trackId
string or null
trackIdInternal
string or null <uuid>
name
string or null
description
string or null
tagPattern
string or null
offset
integer <int32>
qosTolerableThreshold
integer or null <int32>
qosCriticalThreshold
integer or null <int32>
slaTolerableThreshold
integer or null <int32>
slaCriticalThreshold
integer or null <int32>
remoteInstanceId
integer or null <int32>
remoteInstanceName
string or null
object (RemoteInstance)
parentMasterVisionCard
object (MasterVisionCard) Recursive
parentId
integer <int32>
Array of objects or null (MonitoredVisionFrequency)
roleId
integer or null <int32>
roleName
string or null
Array of objects or null (Role)
Array of objects or null (MasterVisionCard)

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": [
    ]
}

/api/mastervisionworkspaces/{id}/visioncards/{cardId}/{version}

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

Responses

VisionCardStatistics

/api/visioncardstatistics

Authorizations:
query Parameters
Ids
string or null
From
string or null
To
string or null
CardIds
string or null
ExcludeQos
boolean or null
ExcludeSla
boolean or null
Array of objects or null (CardTrackId)

Responses

VisionFrequencies

/api/visionfrequencies

Authorizations:
query Parameters
Ids
string or null
Name
string or null

Responses

/api/visionfrequencies

Authorizations:
Request Body schema:
id
integer <int32>
name
string or null
description
string or null
type
integer or null <int32>
dates
Array of strings or null

Responses

Request samples

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

/api/visionfrequencies/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

/api/visionfrequencies/{id}

Authorizations:
path Parameters
id
required
integer <int32>
Request Body schema:
id
integer <int32>
name
string or null
description
string or null
type
integer or null <int32>
dates
Array of strings or null

Responses

Request samples

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

/api/visionfrequencies/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses

VisionJobAnomalies

/api/visionjobanomalies

Authorizations:
query Parameters
VisionCardAnomalyId
integer <int64>
VisionCardAnomalyIds
string or null
ScheduleDate
string <date-time>
TagPattern
string or null
StartedLate
boolean or null
EndedLate
boolean or null
ExpectedStartTime
string or null <date-time>
ExpectedEndTime
string or null <date-time>
ActualStartTime
string or null <date-time>
ActualEndTime
string or null <date-time>

Responses

VisionStatistic

/api/visionstatistic

Authorizations:
query Parameters
Ids
string or null
From
string or null
To
string or null
CardIds
string or null
ExcludeQos
boolean or null
ExcludeSla
boolean or null
Array of objects or null (CardTrackId)

Responses

VisionStats

/api/visionstats

Authorizations:
query Parameters
Ids
string or null

Responses

/api/visionstats/{id}

Authorizations:
path Parameters
id
required
integer <int32>

Responses