Important

   

Starting version 8.9.03, BMC Network Automation is renamed to TrueSight Network Automation. This space contains information about BMC Network Automation 8.9.02 and previous versions. For TrueSight Network Automation 8.9.03 and later releases, see the TrueSight Network Automation documentation.

Endpoints in the REST API v2.0

BMC Network Automation REST API – Version 2.0

Warning

REST API v2.0 is deprecated as of product version 8.9.03.


The base URL for the API is:

https://serverName:portNumber/bca-networks/api

combo_groups

GET /v2.0/combo_groups
 Retrieves combo groups, matching any filter criteria
Description

Retrieves combo groups, matching any filter criteria; may filter by filterable combo group dynamic fields by including query parameters in the form 'filter.dynamicFieldName=value'

Parameters

Name

Located in

Description

Default

Schema

filter.name

query

Filter for combo groups matching this name, asterisk wildcards allowed

string

filter.realm

query

Filter for combo groups that belong to this realm

string

orderBy

query

Sort by the specified attribute (name, realm, or a listable combo group dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending)

"+name"

string
Enum: [
  "+name",
  "-name",
  "+realm",
  "-realm"
]

offset

query

Return the specified page number

1

integer

limit

query

Define the number of rows in a page or the maximum number of combo groups to return

25

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

[
   #ComboGroupDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access combo groups

500

Internal server error: Unexpected exception occurred

POST /v2.0/combo_groups
 Adds a new combo group
Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new combo group

ComboGroupDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

201

Created: New combo group successfully added

400

Bad request: Input combo group DTO is missing or new combo group is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to add a new combo group

500

Internal server error: Unexpected exception occurred

PUT /v2.0/combo_groups/{id}
 Modifies all attributes of an existing combo group
Parameters

Name

Located in

Description

Default

Schema

id

path

Database key of the combo group to be modified

string *

body

body

Complete new attribute values for the combo group; anything left out will be considered to be null and will be nulled out in the combo group; any required dynamic fields missing or null in the input will revert to default values; to change the realm a combo group belongs to, must first remove all groups from the combo group or specify new groups in the new realm

#ComboGroupDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

ComboGroupDTO

400

Bad request: Input combo group DTO is missing, modified combo group is invalid, or a change of realm is not allowed

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the combo group

404

Not found: No single matching accessible combo group found

500

Internal server error: Unexpected exception occurred

DELETE /v2.0/combo_groups/{id}
 Deletes an unreferenced combo group
Parameters

Name

Located in

Description

Default

Schema

id

path

Database key of the combo group to be deleted

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

string

400

Bad request: combo group is currently in use

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to delete the combo group

404

Not found: No single matching accessible combo group found

500

Internal server error: Unexpected exception occurred

PATCH /v2.0/combo_groups/{id}
 Modifies only the specified attributes of an existing combo group, where the changes are specified in JSON Patch format (per RFC 6902)
Parameters

Name

Located in

Description

Default

Schema

id

path

Database key of the combo group to be modified

string *

body

body

New attribute values for the combo group, in JSON Patch format

#JsonPatch

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#ComboGroupDTO

400

Bad request: Input JSON patch information is missing, modified combo group is invalid, or a realm change is not allowed

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the combo group

404

Not found: No single matching accessible combo group found

500

Internal server error: Unexpected exception occurred

GET /v2.0/combo_groups/{id}/devices
 Retrieves the devices that belong to a combo group, with the returned result being abbreviated or partially-detailed devices
Parameters

Name

Located in

Description

Default

Schema

id

path

Database key of the combo group of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

[
   #AbbreviatedDeviceDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access combo groups

404

Not found: No single matching accessible combo group found

500

Internal server error: Unexpected exception occurred

GET /v2.0/combo_groups/{nameOrKey}
 Retrieves single combo group either by name or by database key
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the combo group of interest; a name must be unique across all realms for a combo group to be returned

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#ComboGroupDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access combo group

404

Not found: No single matching accessible combo group found

500

Internal server error: Unexpected exception occurred


devices

GET /v2.0/devices
 Retrieves devices, matching any filter criteria
Description

Retrieves devices, matching any filter criteria, with the returned result being abbreviated or partially-detailed devices. May filter by filterable device dynamic fields by including query parameters in the form 'filter.dynamicFieldName=value'

Parameters

Name

Located in

Description

Default

Schema

orderBy

query

Sort by the specified attribute (name, realm, address, model, osImage, or a listable device dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending)

"+name"

string
Enum: [
  "+name",
  "-name",
  "+realm",
  "-realm",
  "+address",
  "-address",
  "+model",
  "-model",
  "+osImage",
  "-osImage"
]

limit

query

Define the number of rows in a page or the maximum number of devices to return

25

integer

offset

query

Return the specified page number

1

integer

filter.name

query

Filter for devices matching this name, asterisk wildcards allowed

string

filter.realm

query

Filter for devices that belong to this realm

string

filter.address

query

Filter for devices matching this address, asterisk wildcards allowed

string

filter.vendor

query

Filter for devices from this vendor, by GUID

string

filter.deviceType

query

Filter for devices of this device type, by GUID

string

filter.model

query

Filter for devices matching this model, asterisk wildcards allowed

string

filter.osImage

query

Filter for devices matching this operating system name, asterisk wildcards allowed

string

filter.online

query

Filter for devices that are online or offline

boolean

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #AbbreviatedDeviceDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access devices

500

Internal server error: Unexpected exception occurred

POST /v2.0/devices
 Adds a new device
Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new device

#DeviceDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

201

Created: New device successfully added

400

Bad request: Input device DTO is missing or new device is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to add a new device

500

Internal server error: Unexpected exception occurred

GET /v2.0/devices/{nameOrKey}
 Retrieves one device either by name or by database key, with the returned result being a fully-detailed device
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#DeviceDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access devices

404

Not found: No single matching accessible device found

500

Internal server error: Unexpected exception occurred

PUT /v2.0/devices/{nameOrKey}
 Modifies all attributes of an existing device
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device of interest

string *

body

body

Complete new attribute values for the device; anything left out will be considered to be null and will be nulled out in the device; any required dynamic fields missing or null in the input will revert to default values

#DeviceDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#DeviceDTO

400

Bad request: Input device DTO is missing or modified device is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the device

404

Not found: No single matching accessible device found

500

Internal server error: Unexpected exception occurred

DELETE /v2.0/devices/{nameOrKey}
 Deletes an unreferenced device
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device of interest

string *

clearReferences

query

When true, will attempt to clear references to the device that would normally prevent it from being deleted. Not every reference can be cleared, so this call can still fail.

false

boolean

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

string

400

Bad request: device is currently in use

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to delete the device

404

Not found: No single matching accessible device found

500

Internal server error: Unexpected exception occurred

PATCH /v2.0/devices/{nameOrKey}
 Modifies only the specified attributes of an existing device, where the changes are specified in JSON Patch format (per RFC 6902)
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device of interest

string *

body

body

New attribute values for the device, in JSON Patch format

#JsonPatch

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#DeviceDTO

400

Bad request: Input JSON patch information is missing or modified device is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the device

404

Not found: No single matching accessible device found

500

Internal server error: Unexpected exception occurred

GET /v2.0/devices/{nameOrKey}/configurations/{cfgKey}
 Retrieves a single device configuration
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device of interest

string *

cfgKey

path

Database key of the configuration of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#ConfigurationDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access devices

404

Not found: No single matching accessible device or configuration found

500

Internal server error: Unexpected exception occurred

GET /v2.0/devices/{nameOrKey}/configurations/{cfgKey}/binaryData
 Retrieves the binary data for a single configuration
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device of interest

string *

cfgKey

path

Database key of the configuration of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

OK: Request completed successfully

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access devices

404

Not found: No single matching accessible device or configuration found, or the configuration has no binary data

500

Internal server error: Unexpected exception occurred

GET /v2.0/devices/{nameOrKey}/configurations/{cfgKey}/data
 Retrieves the ASCII data for a single configuration
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device of interest

string *

cfgKey

path

Database key of the configuration of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

string

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access devices

404

Not found: No single matching accessible device or configuration found, or the configuration has no ASCII data

500

Internal server error: Unexpected exception occurred

GET /v2.0/devices/{nameOrKey}/configurations/{trailGuid}
 Retrieves all configurations for a specified trail
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device of interest

string *

trailGuid

path

The GUID of the configuration trail of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #ConfigurationDTO
]

400

Bad request: Input trail GUID is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access devices

404

Not found: No single matching accessible device found

500

Internal server error: Unexpected exception occurred

PUT /v2.0/devices/{nameOrKey}/current_configuration/{trailGuid}
 Set current configuration of device trail "Device End of Life Trail"
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device of interest

string *

trailGuid

path

The GUID of the configuration trail "Device End of Life"

string *

body

body

Complete new configuration of configuration trail "Device End of Life";

string

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   {
   }
]

400

Bad request: Input device DTO is missing or modified device is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the device

404

Not found: No single matching accessible device found

500

Internal server error: Unexpected exception occurred

GET /v2.0/devices/{nameOrKey}/current_configurations
 Retrieves all of the current configurations for a device
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #ConfigurationDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access devices

404

Not found: No single matching accessible device found

500

Internal server error: Unexpected exception occurred

GET /v2.0/devices/{nameOrKey}/status
 Retrieves current detailed status for a device
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#DeviceStatusDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access devices

404

Not found: No single matching accessible device found

500

Internal server error: Unexpected exception occurred

GET /v2.0/devices/{nameOrKey}/status/{actionGuid}/transcript
 Retrieves the latest device action execution transcript for the specified type of action
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device of interest

string *

actionGuid

path

The GUID of the device action of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

string

400

Bad request: Input action GUID is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access devices or transcripts

404

Not found: No single matching accessible device found, or device has no transcript for the specified action

500

Internal server error: Unexpected exception occurred

GET /v2.0/devices/{nameOrKey}/trusted_configurations
 Retrieves all of the trusted configurations for a device
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #ConfigurationDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access devices

404

Not found: No single matching accessible device found

500

Internal server error: Unexpected exception occurred


groups

GET /v2.0/groups
 Retrieves groups, matching any filter criteria
Description

Retrieves groups, matching any filter criteria; may filter by filterable group dynamic fields by including query parameters in the form 'filter.dynamicFieldName=value'

Parameters

Name

Located in

Description

Default

Schema

filter.name

query

Filter for groups matching this name, asterisk wildcards allowed

string

filter.realm

query

Filter for groups that belong to this realm

string

filter.autoGroup

query

Filter for auto-groups or non-auto-groups; when true, returns only auto-groups (including empty ones); when false, returns only non-auto-groups; when this filter is absent, no filtering is done

boolean
Enum: [
  "true",
  "false"
]

orderBy

query

Sort by the specified attribute (name, realm, or a listable group dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending)

"+name"

string
Enum: [
  "+name",
  "-name",
  "+realm",
  "-realm"
]

offset

query

Return the specified page number

1

integer

limit

query

Define the number of rows in a page or the maximum number of groups to return

25

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #GroupDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access groups

500

Internal server error: Unexpected exception occurred

POST /v2.0/groups
 Adds a new group
Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new group

#GroupDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

201

Created: New group successfully added

400

Bad request: Input group DTO is missing or new group is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to add a new group

500

Internal server error: Unexpected exception occurred

PUT /v2.0/groups/{id}
 Modifies all attributes of an existing group
Parameters

Name

Located in

Description

Default

Schema

id

path

Database key of the group to be modified

string *

body

body

Complete new attribute values for the group; anything left out will be considered to be null and will be nulled out in the group; any required dynamic fields missing or null in the input will revert to default values; to change the realm a group belongs to, must first remove all devices from the group

#GroupDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#GroupDTO

400

Bad request: Input group DTO is missing, modified group is invalid, or attempted to make an invalid type of change (such as renaming an auto-group); see error message for details

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the group

404

Not found: No single matching accessible group found

500

Internal server error: Unexpected exception occurred

DELETE /v2.0/groups/{id}
 Deletes an unreferenced group
Parameters

Name

Located in

Description

Default

Schema

id

path

Database key of the group to be deleted

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

string

400

Bad request: group is currently in use or is a non-empty auto-group

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to delete the group

404

Not found: No single matching accessible group found

500

Internal server error: Unexpected exception occurred

PATCH /v2.0/groups/{id}
 Modifies only the specified attributes of an existing group, where the changes are specified in JSON Patch format (per RFC 6902)
Parameters

Name

Located in

Description

Default

Schema

id

path

Database key of the group to be modified

string *

body

body

New attribute values for the group, in JSON Patch format

#JsonPatch

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#GroupDTO

400

Bad request: Input JSON patch information is missing, modified group is invalid, or attempted to make an invalid type of change (such as renaming an auto-group); see error message for details

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the group

404

Not found: No single matching accessible group found

500

Internal server error: Unexpected exception occurred

GET /v2.0/groups/{id}/devices
 Retrieves the devices that belong to a group, with the returned result being abbreviated or partially-detailed devices
Parameters

Name

Located in

Description

Default

Schema

id

path

Database key of the group of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'

String *  

String *

Responses

Code

Description

Schema

200

successful operation

[
   #AbbreviatedDeviceDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access groups

404

Not found: No single matching accessible group found

500

Internal server error: Unexpected exception occurred

PUT /v2.0/groups/{id}/devices/{deviceId}
 Adds a new device to a group
Parameters

Name

Located in

Description

Default

Schema

id

path

Database key of the group of interest

string *

deviceId

path

Database key of the device to be added to the group

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


  String *

Responses

Code

Description

Schema

200

successful operation

string

400

Bad request: Device database key is not valid, device is not in the same realm as the group, or attempted to add a device to an auto-group

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the group

404

Not found: No single matching accessible group found

500

Internal server error: Unexpected exception occurred

DELETE /v2.0/groups/{id}/devices/{deviceId}
 Removes a member device from a group
Parameters

Name

Located in

Description

Default

Schema

id

path

Database key of the group of interest

string *

deviceId

path

Database key of the device to be removed from the group

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

string

400

Bad request: Device database key is not valid, device is not a member of the group, or attempted to remove a device from an auto-group

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the group

404

Not found: No single matching accessible group found

500

Internal server error: Unexpected exception occurred

GET /v2.0/groups/{nameOrKey}
 Retrieves one group either by name or by database key
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the group of interest; a name must be unique across all realms for a group to be returned

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


 
string *

Responses

Code

Description

Schema

200

successful operation

#GroupDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access groups

404

Not found: No single matching accessible group found

500

Internal server error: Unexpected exception occurred


jobs

GET /v2.0/jobs
 Retrieves jobs, matching any filter criteria
Description

Retrieves jobs, matching any filter criteria, with the returned result being abbreviated or partially-detailed jobs. May filter by filterable job dynamic fields by including query parameters in the form 'filter.dynamicFieldName=value'

Parameters

Name

Located in

Description

Default

Schema

filter.jobID

query

Filter for jobs matching this job ID, asterisk wildcards allowed

string

filter.changeID

query

Filter for jobs matching this change ID, asterisk wildcards allowed

string

filter.taskID

query

Filter for jobs matching this task ID, asterisk wildcards allowed

string

filter.action

query

Filter for jobs containing this type of action, by action GUID

string

filter.status

query

Filter for jobs currently in this numeric state

integer

filter.originator

query

Filter for jobs matching this originator name, asterisk wildcards allowed

string

orderBy

query

Sort by the specified attribute (jobID, changeID, taskID, status, originator, or a listable job dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending); note that status is a numeric sort on the current job state (not on the display names for the states)

"+jobID"

string

offset

query

Return the specified page number

1

integer

limit

query

Define the number of rows in a page or the maximum number of jobs to return

25

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #AbbreviatedJobDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access jobs

500

Internal server error: Unexpected exception occurred

POST /v2.0/jobs
 Adds a new job in the draft state
Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new job

#JobDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

201

Created: New draft job successfully added

400

Bad request: Input job DTO is missing or new job is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to add a new job

500

Internal server error: Unexpected exception occurred

GET /v2.0/jobs/{jobIdOrKey}
 Retrieves one job either by job ID or by database key, with the returned result being a fully-detailed job
Parameters

Name

Located in

Description

Default

Schema

jobIdOrKey

path

Job ID or database key of the job of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#JobDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access jobs

404

Not found: No single matching accessible job found

500

Internal server error: Unexpected exception occurred

POST /v2.0/jobs/{jobIdOrKey}
 Adds a new job in the draft state, copying the specified job
Parameters

Name

Located in

Description

Default

Schema

jobIdOrKey

path

Job ID or database key of the job to be copied

string *

onlyDeviceFailures

query

Which actions are to be copied; when false, copies all actions and uses their original network spans; when true, copies only actions where one or more device actions did not succeed, using a network span containing only the failed devices

boolean

proceedWithMissingDevice

query

How to handle multi-device network spans where one or more devices no longer exist; when false, treat this as an error; when true, proceed with the copy, using whatever devices still exist

boolean

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

201

Created: New draft job successfully added

400

Bad request: Copied job is invalid; or devices used in the original job are now missing; or, when copying only actions with device failures, job is not completed or no such failures exist

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to add a new job

404

Not found: No single matching accessible job found

500

Internal server error: Unexpected exception occurred

PUT /v2.0/jobs/{jobIdOrKey}
 Modifies all attributes of an existing draft job
Parameters

Name

Located in

Description

Default

Schema

jobIdOrKey

path

Job ID or database key of the draft job to be modified

string *

body

body

Complete new attribute values for the job; anything left out will be considered to be null and will be nulled out in the job; any required dynamic fields missing or null in the input will revert to default values

#JobDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#JobDTO

400

Bad request: Input job DTO is missing, job is not in the draft state, or modified job is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the job

404

Not found: No single matching accessible job found

500

Internal server error: Unexpected exception occurred

DELETE /v2.0/jobs/{jobIdOrKey}
 Deletes a draft job
Parameters

Name

Located in

Description

Default

Schema

jobIdOrKey

path

Job ID or database key of the draft job to be deleted

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

string

400

Bad request: Job is not in the draft state

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to delete the job

404

Not found: No single matching accessible job found

500

Internal server error: Unexpected exception occurred

PATCH /v2.0/jobs/{jobIdOrKey}
 Modifies only the specified attributes of an existing draft job, where the changes are specified in JSON Patch format (per RFC 6902)
Parameters

Name

Located in

Description

Default

Schema

jobIdOrKey

path

Job ID or database key of the draft job to be modified

string *

body

body

New attribute values for the job, in JSON Patch format

#JsonPatch

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#JobDTO

400

Bad request: Input JSON patch information is missing, job is not in the draft state, or modified job is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the job

404

Not found: No single matching accessible job found

500

Internal server error: Unexpected exception occurred

GET /v2.0/jobs/{jobIdOrKey}/action_results/{actionNumber}
 For one completed job (specified by either job ID or database key) retrieves one action execution result specified by its action number (starting at one)
Parameters

Name

Located in

Description

Default

Schema

jobIdOrKey

path

Job ID or database key of the job of interest

string *

actionNumber

path

The number of the action of interest within the job, where action numbers start at one

integer *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#ActionResultDTO

400

Bad request: Job is not in a completed state

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access jobs

404

Not found: No single matching accessible job found, or specified action not found in the job

500

Internal server error: Unexpected exception occurred

POST /v2.0/jobs/{jobIdOrKey}/approval
 Approves a job that is waiting for approval; if this is the final necessary approval, the job is scheduled for execution
Parameters

Name

Located in

Description

Default

Schema

jobIdOrKey

path

Job ID or database key of the job to be approved

string *

reason

query

The reason or explanation or annotation for this approval

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

OK: Job approved successfully

400

Bad request: Job is not in the wait for approval state, or the required 'reason' query parameter is missing, or the logged-in user is not a pending approver

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to approve the job

404

Not found: No single matching accessible job found

500

Internal server error: Unexpected exception occurred

POST /v2.0/jobs/{jobIdOrKey}/cancellation
 Terminates a job (cancels a scheduled job, or aborts an executing job); note that an abort request is asynchronous; the job may take some time before it completes its running actions
Parameters

Name

Located in

Description

Default

Schema

jobIdOrKey

path

Job ID or database key of the job to be cancelled/aborted

string *

reason

query

The reason or explanation or annotation for this cancellation

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

OK: Job cancelled successfully, or abort requested successfully

400

Bad request: Job is not a in state where it can be cancelled or aborted, or the required 'reason' query parameter is missing

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to cancel/abort the job

404

Not found: No single matching accessible job found

500

Internal server error: Unexpected exception occurred

POST /v2.0/jobs/{jobIdOrKey}/desubmission
 De-submits or re-drafts a job scheduled for execution or waiting for approval; any existing job approvals are removed
Parameters

Name

Located in

Description

Default

Schema

jobIdOrKey

path

Job ID or database key of the scheduled job to be de-submitted

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

OK: Job de-submitted successfully

400

Bad request: Job is not in a scheduled or wait for approval state, or an external approval has already been obtained

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to de-submit the job

404

Not found: No single matching accessible job found

500

Internal server error: Unexpected exception occurred

GET /v2.0/jobs/{jobIdOrKey}/device_results
 For one completed job (specified by either job ID or database key) retrieves abbreviated or summarized device action execution results matching any filter criteria
Parameters

Name

Located in

Description

Default

Schema

jobIdOrKey

path

Job ID or database key of the job of interest

string *

filter.actionNumber

query

Filter for results from this one action within the job; action numbers start with 1

integer

filter.subactionNumber

query

Filter for results from this one sub-action within the action specified by the filter.actionNumber parameter; sub-action numbers start with 1; this is ignored if you fail to specify filter.actionNumber

integer

filter.status

query

Filter for results with this numeric completion status

integer

filter.errorMessage

query

Filter for results that failed with this error message, asterisk wildcards allowed

string

orderBy

query

Sort by the specified attribute (actionNumber, deviceName, status, startTime, endTime, or errorMessage) in the specified order (prefix with a '+' for ascending or a '-' for descending); note that status is a numeric sort on the device action's completion status

"+actionNumber"

string

offset

query

Return the specified page number

1

integer

limit

query

Define the number of rows in a page or the maximum number of results to return

25

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #AbbreviatedDeviceResultDTO
]

400

Bad request: Job is not in a completed state, or filter.errorMessage is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access jobs

404

Not found: No single matching accessible job found

500

Internal server error: Unexpected exception occurred

GET /v2.0/jobs/{jobIdOrKey}/device_results/{resultKey}
 For one completed job (specified by either job ID or database key) retrieves one device action execution result specified by its database key
Parameters

Name

Located in

Description

Default

Schema

jobIdOrKey

path

Job ID or database key of the job of interest

string *

resultKey

path

Database key of the device result of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#DeviceResultDTO

400

Bad request: Job is not in a completed state

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access jobs

404

Not found: No single matching accessible job found, or device result not found in the job

500

Internal server error: Unexpected exception occurred

GET /v2.0/jobs/{jobIdOrKey}/device_results/{resultKey}/transcript
 For one completed job (specified by either job ID or database key) retrieves one device action execution transcript specified by the device result database key
Parameters

Name

Located in

Description

Default

Schema

jobIdOrKey

path

Job ID or database key of the job of interest

string *

resultKey

path

Database key of the device result whose transcript is of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

string

400

Bad request: Job is not in a completed state

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access jobs or transcripts

404

Not found: No single matching accessible job found, device result not found in the job, or device result has no transcript

500

Internal server error: Unexpected exception occurred

POST /v2.0/jobs/{jobIdOrKey}/rejection
 Rejects a job that is waiting for approval
Parameters

Name

Located in

Description

Default

Schema

jobIdOrKey

path

Job ID or database key of the job to be rejected

string *

reason

query

The reason or explanation or annotation for this rejection

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

OK: Job successfully rejected

400

Bad request: Job is not in the wait for approval state, or the required 'reason' query parameter is missing, or the logged-in user is not a pending approver

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to reject the job

404

Not found: No single matching accessible job found

500

Internal server error: Unexpected exception occurred

POST /v2.0/jobs/{jobIdOrKey}/submission
 Submits a draft job for execution, per its schedule and approval requirements
Parameters

Name

Located in

Description

Default

Schema

jobIdOrKey

path

Job ID or database key of the draft job to be submitted

string *

jobApprovalTypeId

query

When the job requires approval, the database key of the job approval type that specifies who must approve the job prior to execution; ignored if the job does not require approval

string

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

OK: Job submitted successfully

400

Bad request: Job is not in the draft state, or query parameter 'jobApprovalTypeId' is missing for a job requiring approval

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to submit the job

404

Not found: No single matching accessible job or job approval type found

500

Internal server error: Unexpected exception occurred


predefined_jobs

GET /v2.0/predefined_jobs
 Retrieves predefined jobs, matching any filter criteria
Description

Retrieves predefined jobs, matching any filter criteria;may filter by filterable predefined job dynamic fields by including query parameters in the form 'filter.dynamicFieldName=value'

Parameters

Name

Located in

Description

Default

Schema

filter.name

query

Filter for predefined jobs matching this name, asterisk wildcards allowed

string

filter.action

query

Filter for predefined jobs containing this type of action, by action GUID

string

orderBy

query

Sort by the specified attribute ('name' or a listable job dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending)

"+name"

string

offset

query

Return the specified page number

1

integer

limit

query

Define the number of rows in a page or the maximum number of predefined jobs to return

25

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #PredefinedJobDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access predefined jobs

500

Internal server error: Unexpected exception occurred

POST /v2.0/predefined_jobs
 Adds a new predefined job
Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new predefined job

#PredefinedJobDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

201

Created: New predefined job successfully added

400

Bad request: Input predefined job DTO is missing or new predefined job is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to add a new predefined job

500

Internal server error: Unexpected exception occurred

GET /v2.0/predefined_jobs/{nameOrKey}
 Retrieves one predefined job either by name or by database key
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the predefined job of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#PredefinedJobDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access predefined jobs

404

Not found: No single matching accessible predefined job found

500

Internal server error: Unexpected exception occurred

PUT /v2.0/predefined_jobs/{nameOrKey}
 Modifies all attributes of an existing predefined job
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the predefined job to be modified

string *

body

body

Complete new attribute values for the predefined job; anything left out will be considered to be null and will be nulled out in the predefined job; any required dynamic fields missing or null in the input will revert to default values

#PredefinedJobDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#PredefinedJobDTO

400

Bad request: Input predefined job DTO is missing or modified predefined job is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the predefined job

404

Not found: No single matching accessible predefined job found

500

Internal server error: Unexpected exception occurred

DELETE /v2.0/predefined_jobs/{nameOrKey}
 Deletes a predefined job
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the predefined job to be deleted

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

string

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to delete the predefined job

404

Not found: No single matching accessible predefined job found

500

Internal server error: Unexpected exception occurred

PATCH /v2.0/predefined_jobs/{nameOrKey}
 Modifies only the specified attributes of an existing predefined job, where the changes are specified in JSON Patch format (per RFC 6902)
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the predefined job to be modified

string *

body

body

New attribute values for the predefined job, in JSON Patch format

#JsonPatch

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#PredefinedJobDTO

400

Bad request: Input JSON patch information is missing or modified predefined job is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the predefined job

404

Not found: No single matching accessible predefined job found

500

Internal server error: Unexpected exception occurred

POST /v2.0/predefined_jobs/{nameOrKey}/job_preparation
 Prepares a draft job from the specified predefined job
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the predefined job to be used to prepare the draft job

string *

body

body

Optional parameters to be used to populate the job, filling in settings that are deferred or not present in the predefined job; if this is not present, the draft job is set to run now or when approved

#JobParametersDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

201

Created: New draft job successfully added

400

Bad request: Input JobParametersDTO is invalid or is missing information needed to fill in the job; or the prepared job is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to prepare a job from the predefined job

404

Not found: No single matching accessible predefined job found

500

Internal server error: Unexpected exception occurred


realms

GET /v2.0/realms
 Retrieves realms, matching any filter criteria
Parameters

Name

Located in

Description

Default

Schema

filter.name

query

Filter for realms matching this name, asterisk wildcards allowed

string

orderBy

query

Sort by the specified attribute ('name' or a listable realm dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending)

"+name"

string

offset

query

Return the specified page number

1

integer

limit

query

Define the number of rows in a page or the maximum number of realms to return

25

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #RealmDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access realms

500

Internal server error: Unexpected exception occurred

POST /v2.0/realms
 Adds a new realm
Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new realm

#RealmDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

201

Created: New realm successfully added

400

Bad request: Input realm DTO is missing or new realm is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to add a new realm

500

Internal server error: Unexpected exception occurred

GET /v2.0/realms/{nameOrKey}
 Retrieves one realm either by name or by database key
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the realm of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#RealmDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access realms

404

Not found: No single matching accessible realm found

500

Internal server error: Unexpected exception occurred

PUT /v2.0/realms/{nameOrKey}
 Modifies all attributes of an existing realm
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the realm to be modified

string *

body

body

Complete new attribute values for the realm; anything left out will be considered to be null and will be nulled out in the realm; any required fallback or hardware inventory purge criteria or dynamic fields missing or null in the input will revert to default values

#RealmDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#RealmDTO

400

Bad request: Input realm DTO is missing or modified realm is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the realm

404

Not found: No single matching accessible realm found

500

Internal server error: Unexpected exception occurred

DELETE /v2.0/realms/{nameOrKey}
 Deletes an unreferenced realm
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the realm to be deleted

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

string

400

Bad request: Realm is currently in use, or it is the only realm and cannot be deleted

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to delete the realm

404

Not found: No single matching accessible realm found

500

Internal server error: Unexpected exception occurred

PATCH /v2.0/realms/{nameOrKey}
 Modifies only the specified attributes of an existing realm, where the changes are specified in JSON Patch format (per RFC 6902)
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the realm to be modified

string *

body

body

New attribute values for the realm, in JSON Patch format

#JsonPatch

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#RealmDTO

400

Bad request: Input JSON patch information is missing or Modified realm is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the realm

404

Not found: No single matching accessible realm found

500

Internal server error: Unexpected exception occurred


rule_sets

GET /v2.0/rule_sets
 Retrieves rule sets, matching any filter criteria
Parameters

Name

Located in

Description

Default

Schema

filter.name

query

Filter for rule sets matching this name, asterisk wildcards allowed

string

filter.enabled

query

Filter for enabled or disabled rule sets; when true, returns only enabled rule sets; when false, returns only disabled rule sets; when this filter is absent, no filtering is done

boolean

orderBy

query

Sort by the specified attribute ('name' or a listable rule set dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending)

"+name"

string

offset

query

Return the specified page number

1

integer

limit

query

Define the number of rows in a page or the maximum number of rule set to return

25

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #RuleSetDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access rule sets

500

Internal server error: Unexpected exception occurred

POST /v2.0/rule_sets
 Adds a new rule set
Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new rule set

#RuleSetDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

201

Created: New rule set successfully added

400

Bad request: Input rule set DTO is missing or new rule set is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to add a new rule set

500

Internal server error: Unexpected exception occurred

GET /v2.0/rule_sets/{nameOrKey}
 Retrieves one rule set either by name or by database key
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the one rule set of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#RuleSetDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access rule sets

404

Not found: No single matching accessible rule set found

500

Internal server error: Unexpected exception occurred

PUT /v2.0/rule_sets/{nameOrKey}
 Modifies all attributes of an existing rule set
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or Database key of the rule set to be modified

string *

body

body

Complete new attribute values for the rule set; anything left out will be considered to be null and will be nulled out in the rule set; any required dynamic fields missing or null in the input will revert to default values

#RuleSetDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#RuleSetDTO

400

Bad request: Input rule set DTO is missing or modified rule set is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the rule set

404

Not found: No single matching accessible rule set found

500

Internal server error: Unexpected exception occurred

DELETE /v2.0/rule_sets/{nameOrKey}
 Deletes an unreferenced rule set
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the rule set to be deleted

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

string

400

Bad request: Rule set is currently in use

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to delete the rule set

404

Not found: No single matching accessible rule set found

500

Internal server error: Unexpected exception occurred

PATCH /v2.0/rule_sets/{nameOrKey}
 Modifies only the specified attributes of an existing rule set, where the changes are specified in JSON Patch format (per RFC 6902)
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the rule set to be modified

string *

body

body

New attribute values for the rule set, in JSON Patch format

#JsonPatch

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#RuleSetDTO

400

Bad request: Input JSON patch information is missing or modified rule set is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the rule set

404

Not found: No single matching accessible rule set found

500

Internal server error: Unexpected exception occurred


rules

GET /v2.0/rules
 Retrieves rules, matching any filter criteria
Description

Retrieves rules, matching any filter criteria, with the returned result being abbreviated or partially-detailed rules. May filter by filterable rule dynamic fields by including query parameters in the form 'filter.dynamicFieldName=value'

Parameters

Name

Located in

Description

Default

Schema

filter.name

query

Filter for rules matching this name, asterisk wildcards allowed

string

filter.ruleSetName

query

Filter for rules that belong to a rule set matching this rule set name, asterisk wildcards allowed

string

filter.correctable

query

Filter for correctable or non-correctable rules; when true, returns only correctable rules; when false, returns only non-correctable rules; when this filter is absent, no filtering is done

boolean

filter.onlyRulesWithCveIds

query

Filter for rules with associated CVE ID(s); when true, returns only rules that are associated with at least one CVE ID; when false or when this filter is absent, no filtering is done

boolean

limit

query

Define the number of rows in a page or the maximum number of rules to return

25

integer

offset

query

Return the specified page number

1

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #AbbreviatedRuleDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access rules

500

Internal server error: Unexpected exception occurred

POST /v2.0/rules
 Adds a new rule
Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new rule

#RuleDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

201

Created: New rule successfully added

400

Bad request: Input rule DTO is missing or new rule is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to add a new rule (must be able to edit the owning rule set)

500

Internal server error: Unexpected exception occurred

GET /v2.0/rules/{fullNameOrKey}
 Retrieves one rule either by its rule-set-qualified full name or by database key, with the returned result being a fully-detailed rule
Parameters

Name

Located in

Description

Default

Schema

fullNameOrKey

path

Rule-set-name-qualified full name or database key of the one rule of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#RuleDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access rules

404

Not found: No single matching accessible rule found

500

Internal server error: Unexpected exception occurred

PUT /v2.0/rules/{fullNameOrKey}
 Modifies all attributes of an existing rule
Parameters

Name

Located in

Description

Default

Schema

fullNameOrKey

path

Full name or database key of the rule to be modified

string *

body

body

Complete new attribute values for the rule; anything left out will be considered to be null and will be nulled out in the rule; any required dynamic fields missing or null in the input will revert to default values

#RuleDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#RuleDTO

400

Bad request: Input rule DTO is missing or modified rule is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the rule (must be able to edit the owning rule set)

404

Not found: No single matching accessible rule found

500

Internal server error: Unexpected exception occurred

DELETE /v2.0/rules/{fullNameOrKey}
 Deletes an unreferenced rule
Parameters

Name

Located in

Description

Default

Schema

fullNameOrKey

path

Name or database key of the rule to be deleted

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

string

400

Bad request: Rule is currently in use

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to delete the rule (must be able to edit the owning rule set)

404

Not found: No single matching accessible rule found

500

Internal server error: Unexpected exception occurred

PATCH /v2.0/rules/{fullNameOrKey}
 Modifies only the specified attributes of an existing rule, where the changes are specified in JSON Patch format (per RFC 6902)
Parameters

Name

Located in

Description

Default

Schema

fullNameOrKey

path

Full name or database key of the rule to be modified

string *

body

body

New attribute values for the rule, in JSON Patch format

#JsonPatch

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#RuleDTO

400

Bad request: Input JSON patch information is missing or modified rule is invalid

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to modify the rule (must be able to edit the owning rule set)

404

Not found: No single matching accessible rule found

500

Internal server error: Unexpected exception occurred


supporting components

GET /v2.0/device_adapters
 Retrieves device adapters, matching any filter criteria
Parameters

Name

Located in

Description

Default

Schema

filter.type

query

Filter for device adapters matching this type

string
Enum: [
  "configurationTrail",
  "customAction",
  "deviceType",
  "externalScriptAction",
  "vendor"
]

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #DeviceAdapterDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access device adapters

500

Internal server error: Unexpected exception occurred

GET /v2.0/device_adapters/{nameOrKeyOrGuid}
 Retrieves one device adapter either by name, by database key, or by GUID
Parameters

Name

Located in

Description

Default

Schema

nameOrKeyOrGuid

path

Name or database key or GUID of the one device adapter of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#DeviceAdapterDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access device adapters

404

Not found: No single matching device adapter found

500

Internal server error: Unexpected exception occurred

GET /v2.0/device_agents
 Retrieves all device agents
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #DeviceAgentDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access device agents

500

Internal server error: Unexpected exception occurred

GET /v2.0/device_agents/{nameOrKey}
 Retrieves one device agent either by name or by database key
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the one device agent of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#DeviceAgentDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access device agents

404

Not found: No single matching device agent found

500

Internal server error: Unexpected exception occurred

GET /v2.0/device_security_profiles
 Retrieves device security profiles, matching any filter criteria
Parameters

Name

Located in

Description

Default

Schema

filter.name

query

Filter for device security profiles matching this name, asterisk wildcards allowed

string

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #DeviceSecurityProfileDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access device security profiles

500

Internal server error: Unexpected exception occurred

GET /v2.0/device_security_profiles/{nameOrKey}
 Retrieves one device security profile either by name or by database key
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the one device security profile of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#DeviceSecurityProfileDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access device security profiles

404

Not found: No single matching accessible device security profile found

500

Internal server error: Unexpected exception occurred

GET /v2.0/dynamic_fields
 Retrieves dynamic fields, matching any filter criteria
Parameters

Name

Located in

Description

Default

Schema

filter.component

query

Filter for dynamic fields associated with this component (realm, group, combogroup, device, job, rule, or ruleset)

string
Enum: [
  "realm",
  "group",
  "combogroup",
  "device",
  "job",
"rule",
"ruleset"
]

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #DynamicFieldDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access dynamic fields

500

Internal server error: Unexpected exception occurred

GET /v2.0/dynamic_fields/{nameOrKey}
 Retrieves one dynamic field either by name or by database key
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the one dynamic field of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#DynamicFieldDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access dynamic field

404

Not found: No single matching dynamic field found

500

Internal server error: Unexpected exception occurred

GET /v2.0/email_distribution_lists
 Retrieves all email distribution lists
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #EmailDistributionListDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access email distribution lists

500

Internal server error: Unexpected exception occurred

GET /v2.0/email_distribution_lists/{nameOrKey}
 Retrieves one email distribution list either by name or by database key
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the one email distribution list of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#EmailDistributionListDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access email distribution list

404

Not found: No single matching email distribution list found

500

Internal server error: Unexpected exception occurred

GET /v2.0/job_approval_types
 Retrieves all job approval types
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #JobApprovalTypeDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access job approval types

500

Internal server error: Unexpected exception occurred

GET /v2.0/job_approval_types/{nameOrKey}
 Retrieves one job approval type either by name or by database key
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the one job approval type of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#JobApprovalTypeDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access job approval type

404

Not found: No single matching accessible job approval type found

500

Internal server error: Unexpected exception occurred

GET /v2.0/models
 Retrieves all models
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #ModelDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/models/{nameOrKey}
 Retrieves one model either by name or by database key
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the one model of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#ModelDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

404

Not found: No single matching model found

500

Internal server error: Unexpected exception occurred

GET /v2.0/os_images
 Retrieves OS images from the library, matching any filter criteria
Parameters

Name

Located in

Description

Default

Schema

filter.name

query

Filter for OS images matching this name, asterisk wildcards allowed

string

filter.filename

query

Filter for OS images matching this filename, asterisk wildcards allowed

string

filter.onlyDeployable

query

Filter for OS images that can be deployed; when true, returns only OS images whose 'Forbid Deployment of This Image' setting is unchecked; when false or when this filter is absent, no filtering is done

boolean

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #OsImageDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access OS image library

500

Internal server error: Unexpected exception occurred

GET /v2.0/os_images/{nameOrKey}
 Retrieves one OS image from the library either by name or by database key
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the one OS image of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#OsImageDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access the OS image library

404

Not found: No single matching OS image found

500

Internal server error: Unexpected exception occurred

GET /v2.0/remote_file_servers
 Retrieves remote file servers, matching any filter criteria
Parameters

Name

Located in

Description

Default

Schema

filter.name

query

Filter for remote file servers matching this name, asterisk wildcards allowed

string

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #RemoteFileServerDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access remote file servers

500

Internal server error: Unexpected exception occurred

GET /v2.0/remote_file_servers/{nameOrKey}
 Retrieves one remote file server either by name or by database key
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the one remote file server of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#RemoteFileServerDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access remote file servers

404

Not found: No single matching remote file server found

500

Internal server error: Unexpected exception occurred

GET /v2.0/security_vulnerabilities
 Retrieves all security vulnerabilities
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #SecurityVulnerabilityDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access security vulnerabilities

500

Internal server error: Unexpected exception occurred

GET /v2.0/security_vulnerabilities/{idOrKey}
 Retrieves one security vulnerability either by security vulnerability ID or by database key
Parameters

Name

Located in

Description

Default

Schema

idOrKey

path

ID or database key of the one security vulnerability of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#SecurityVulnerabilityDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access security vulnerability

404

Not found: No single matching security vulnerability found

500

Internal server error: Unexpected exception occurred

GET /v2.0/snmp_manager_stations
 Retrieves all SNMP manager stations
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #SnmpManagerStationDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access SNMP manager stations

500

Internal server error: Unexpected exception occurred

GET /v2.0/snmp_manager_stations/{addressOrKey}
 Retrieves one SNMP manager station either by address or by database key
Parameters

Name

Located in

Description

Default

Schema

addressOrKey

path

Address or database key of the one SNMP manager station of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#SnmpManagerStationDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to SNMP manager stations

404

Not found: No single matching SNMP manager station found

500

Internal server error: Unexpected exception occurred

GET /v2.0/templates
 Retrieves templates, matching any filter criteria
Parameters

Name

Located in

Description

Default

Schema

filter.name

query

Filter for templates matching this name, asterisk wildcards allowed

string

filter.contents

query

Filter for templates containing this text, asterisk wildcards allowed

string

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #TemplateDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access templates

500

Internal server error: Unexpected exception occurred

GET /v2.0/templates/{nameOrKey}
 Retrieves one template either by name or by database key
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the one template of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#TemplateDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access templates

404

Not found: No single matching accessible template found

500

Internal server error: Unexpected exception occurred

GET /v2.0/users
 Retrieves users, matching any filter criteria
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

[
   #UserDTO
]

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access users

500

Internal server error: Unexpected exception occurred

GET /v2.0/users/{nameOrKey}
 Retrieves one user either by name or by database key
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the one user of interest

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

#UserDTO

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

403

Forbidden: Not allowed to access user

404

Not found: No single matching accessible user found

500

Internal server error: Unexpected exception occurred


value mappings

GET /v2.0/action_delete_current_image_options
 Retrieves the action current image deletion options
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/action_image_sources
 Retrieves the action OS image sources
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/action_reboot_types
 Retrieves the action reboot types
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/action_script_types
 Retrieves the action script types
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/action_smart_merge_modes
 Retrieves the Deploy to Active action smart merge modes
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/action_statuses
 Retrieves the action execution statuses
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/boolean_expression_operators
 Retrieves the combo group boolean expression operators
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/canned_actions
 Retrieves the supported standard or canned actions
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/device_access_modes
 Retrieves the device access modes
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/device_adapter_states
 Retrieves the device adapter states
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/device_adapter_types
 Retrieves the device adapter types
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/device_categories
 Retrieves the device categories
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/device_inventory_report_attributes
 Retrieves the device inventory report attributes
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/device_security_context_types
 Retrieves the device security context types
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/device_transfer_modes
 Retrieves the device transfer modes
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/emailed_report_formats
 Retrieves the emailed report formats
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/integer_operators
 Retrieves the compliance rule numeric comparison operators
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/job_approval_type_methods
 Retrieves the job approval type methods
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/job_originator_types
 Retrieves the job originator types
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/job_reconciliation_statuses
 Retrieves the job reconciliation statuses
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/job_states
 Retrieves the job states
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

 Retrieves the job summary report-by types for reports and report links included in job state change emails and SNMP traps
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/quarantine_isolation_levels
 Retrieves the quarantine action isolation levels
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/rule_severities
 Retrieves the compliance rule severities
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

GET /v2.0/snmp_trap_types
 Retrieves the SNMP trap types
Parameters

Name

Located in

Description

Default

Schema

Authorization

header

Authorization token formatted as 'Bearer [token]'


String *

Responses

Code

Description

Schema

200

successful operation

{
}

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

500

Internal server error: Unexpected exception occurred

Object Definitions

Object

Schema

AbbreviatedActionDTO

 Abbreviated or summary information about an action or sub-action within a job

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job (or in the owning action, when this is a sub-action)
 
     guid: string
     The GUID that identifies the type of action
 
     name: string
     The type of action referred to by the GUID
 
     summary: string
     Brief summary of what this action does
 
     annotation: string
     Notes, comments, description, explanation
 
     networkSpanTypeName: string
     The type of network span (if any) that this action acts on
 
     networkSpanId: string
     The database key of the network span (if any) that this action acts on
 
     networkSpanName: string
     The network span (if any) that this action acts on
 
     realmId: string
     The database key of the realm that the network span belongs to
 
     realmName: string
     The realm that the network span belongs to
 
     deviceFilter: string
     Any device filter in a summarized format
 
     statusId: integer
     The current execution status of this action
 
     statusName: string
     The meaning of the numeric statusId
 
     startTimestamp: date-time
     When the action execution began
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number
 
       #AbbreviatedActionDTO
     ]
}

AbbreviatedDeviceDTO

 Abbreviated or summarized information about a device

{
     id: string
     The device's unique database key
 
     name: string
     The device's unique name
 
     deviceDetailsLink: string
     Link to get complete details about this device
 
     realmId: string
     The database key of the realm this device belongs to
 
     realmName: string
     The name of the realm this device belongs to
 
     modelName: string
     The discovered model
 
     osImageName: string
     The discovered operating system version
 
     deviceTypeGuid: string
     The GUID of the device type
 
     deviceTypeName: string
     The name of the device type
 
     vendorGuid: string
     The GUID of the vendor
 
     vendorName: string
     The name of the vendor
 
     categoryId: integer
     The category
 
     categoryName: string
     The meaning of the numeric categoryId
 
     onlineFlag: boolean
     Whether or not this device is online
 
     discrepanciesFlag: boolean
     Whether or not this device has discrepancies
 
     violationsFlag: boolean
     Whether or not this device has compliance violations
 
     primaryInterfaceAddress: string
     The primary interface IP address, host name, or URL
 
     primaryInterfaceDeviceAgentId: string
     The database key of the primary interface device agent
 
     primaryInterfaceDeviceAgentName: string
     The name of the primary interface device agent
 
     primaryInterfaceAccessModeId: integer
     The primary interface access mode
 
     primaryInterfaceAccessModeName: string
     The meaning of the numeric primaryInterfaceAccessModeId
 
     primaryInterfaceTransferModeId: integer
     The primary interface transfer mode
 
     primaryInterfaceTransferModeName: string
     The meaning of the numeric primaryInterfaceTransferModeId
 
     primaryInterfaceDeviceSecurityProfileId: string
     The database key of the primary interface device security profile
 
     primaryInterfaceDeviceSecurityProfileName: string
     The name of the primary interface device security profile
 
     dynamicFields: [
       The dynamic fields
 
       #DynamicFieldValueDTO
     ]
}

AbbreviatedDeviceResultDTO

 Abbreviated or summary information about device action execution results

{
     id: string
     This device result's unique database key
 
     deviceResultDetailsLink: string
     Link to retrieve full details about the device
 
     deviceId: string
     The unique database key of the device where this action ran
 
     deviceName: string
     The name of the device where this action ran
 
     realmName: string
     The name of the realm the device belonged to at execution time
 
     actionNumber: integer
     Which action within the job's list of actions
 
     subactionNumber: integer
     Which sub-action within the action; when null, does not refer to a sub-action
 
     statusId: integer
     The completion status of the device action
 
     statusName: string
     The meaning of the numeric statusId
 
     startTimestamp: date-time
     When the device action began execution
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the device action completed execution
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason for a device action execution failure
 
     exception: string
     Further details about a device action execution failure
}

AbbreviatedJobApprovalStatusDTO

 The approvals that have been made to a job

{
     approvals: [
       The approvals that have been made; null means no approvals have been made
 
       #JobApprovalDTO
     ]
 
     externalApprovalObtainedTimestamp: date-time
     The time at which an external approval was obtained; null means no such approval is needed or it is still pending
    Example: 2017-01-31T13:45:00.000+0000
 
     jobApprovalTypeId: string
     The job approval type's unique database key; note that it is possible for this job approval type to have been deleted since the job was submitted
 
     jobApprovalTypeName: string
     The name of the job approval type
}

AbbreviatedJobDTO

 Abbreviated or summary information about a job

{
     id: string
     The job's unique database key
 
     jobID: string
     The job's unique ID
 
     changeID: string
     The optional change ID, for mapping into any external change management system
 
     taskID: string
     The optional task ID, for mapping into any external change management system
 
     jobDetailsLink: string
     Link to get complete details about this job
 
     approvalStatus: #AbbreviatedJobApprovalStatusDTO
     The approvals that have been made
 
     currentStatus: #AbbreviatedJobStatusDTO
     The current state of the job
 
     originatorTypeId: integer
     The type of the originator
 
     originatorTypeName: string
     The meaning of the numeric originatorTypeId
 
     originator: string
     The originating user name or policy name
 
     runAtTimestamp: date-time
     When the job is to execute; null means now or when approved
    Example: 2017-01-31T13:45:00.000+0000
 
     dynamicFields: [
       The dynamic fields
 
       #DynamicFieldValueDTO
     ]
 
     actions: [
       The actions, ordered by action number
 
       #AbbreviatedActionDTO
     ]
}

AbbreviatedJobStatusDTO

 A job state transition

{
     annotation: string
     The annotation or reason, present only when the user approves, rejects, aborts, or cancels a job
 
     originator: string
     The name of the user or policy that caused the job to move into this state
 
     timestamp: date-time
     The time at which this state was initiated
    Example: 2017-01-31T13:45:00.000+0000
 
     stateId: integer
     The state of the job at the timestamp
 
     stateName: string
     The meaning of the numeric stateId
}

AbbreviatedRuleDTO

 Abbreviated or summarized information about a rule

{
     id: string
     The database key
 
     name: string
     The rule's display name
 
     activationDate: date-time
     When the rule starts to be active
    Example: 2017-01-31T13:45:00.000+0000
 
     annotation: string
     Notes, comments, description, explanation
 
     applicableSecurityContextTypeId: integer
     The types of security contexts this rule applies to
 
     applicableSecurityContextTypeName: string
     The meaning of the numeric applicableSecurityContextTypeId
 
     correctableFlag: boolean
     Whether or not this rule is correctable
 
     cveIDs: [
       Associated security vulnerability CVE ID(s)
 
       string
     ]
 
     deactivationDate: date-time
     When the rule stops being active
    Example: 2017-01-31T13:45:00.000+0000
 
     deviceTypeGuid: string
     Which device type this rules applies to; null means it applies to all device types
 
     deviceTypeName: string
     The name of the device type
 
     releases: string
     The operating system image versions this rule applies to
 
     ruleSetId: #ComponentId
     Identifies the owning rule set
 
     severityId: integer
     The violation severity
 
     severityName: string
     The meaning of the numeric severityId
 
     dynamicFields: [
       The dynamic fields
 
       #DynamicFieldValueDTO
     ]
}

ActionDTO

 Settings for executing an action in a job

Subclasses:
#TrapActionDTO
#SpanActionDTO
#FindEndpointActionDTO
#EventActionDTO
#UnquarantineEndpointActionDTO
#ExternalScriptActionDTO
#EmailActionDTO
#QuarantineEndpointActionDTO

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
}

ActionResultDTO

 Results or status from executing an action

Subclasses:
#EndpointActionResultDTO
#ExternalScriptActionResultDTO

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job (or in the owning action, when this is a sub-action)
 
     guid: string
     The GUID that identifies the type of action
 
     name: string
     The type of action referred to by the GUID
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action
 
     startTimestamp: date-time
     When the action execution began
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed
}

ActionSpecificResultsDTO

 Additional results specific to a particular type of action

ActionStatusDTO

 Status information about an executed span action

{
     actionGuid: string
     The GUID of the device action that was executed
 
     actionName: string
     The action name
 
     statusId: integer
     The completion status of the device action
 
     date: date-time
     The last time this action was attempted
    Example: 2017-01-31T13:45:00.000+0000
 
     accessModeId: integer
     The access mode that was used to connect to the device
 
     transferModeId: integer
     The transfer mode that was used to exchange files with the device
 
     deviceAgentName: string
     The device agent that was used to communicate with the device
 
     deviceInterfaceName: string
     Which set of interface settings was used (primary or auxiliary)
 
     port: string
     The TCP port that was used to connect to the device
 
     deviceSecurityProfileName: string
     The credentials that were used to login to the device
 
     message: string
     Reason for a device action execution failure
 
     transcriptLink: string
     Link to get the recorded device interaction transcript, when there is such a transcript (may not have one on certain error conditions)
}

AdhocTemplateDTO

 An ad-hoc template

{
     contents: string *
     The text contents
 
     injectionFlag: boolean
     Whether or not the contents contain device type interaction XML code
 
     substitutionParameterCheckFlag: boolean
     Whether or not the contents should be validated for correct substitution parameter syntax
}

ApprovalStepDTO

 A step within a job approval type

{
     jobApproverUserNames: [
       The users who can approve the job in this step
 
       string
     ]
 
     jobApproverRoleNames: [
       The roles who can approve the job in this step
 
       string
     ]
 
     numRequired: integer
     The number of approvals required at this step
}

AssignTargetCfgActionDTO

 Settings for executing an assign target action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$AssignTargetCfgActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     useAuxiliaryInterfaceFlag: boolean
     Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
     spanParams: #SpanParamsDTO *
     The selected network span
 
     replaceCurrentFlag: boolean
     When true, replaces any existing target configuration with the selected one; when false, only assigns new target configuration to devices that currently have none
 
     scriptParams: #ScriptParamsDTO *
     Which script or configuration is to be copied into the target configuration, or selects to clear the target configuration
}

BooleanExpressionDTO

 A boolean expression that combines groups

{
     leftParenFlag: boolean
     Whether or not this expression begins with a left parenthesis
 
     rightParenFlag: boolean
     Whether or not this expression ends with a right parenthesis
 
     booleanExpressionOperatorId: integer *
     How the left and right terms are joined together; when there is only a single term, this should be no operator; when there are two terms, this should be either the AND or the OR operator
 
     left: #TermDTO
     The term or operand to the left of the operator
 
     right: #TermDTO
     The term or operand to the right of the operator
}

ChangeSummaryParametersDTO

 Settings for attaching a change summary report to an email

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$ChangeSummaryParametersDTO"

{
     includeEventsFlag: boolean
     Whether or not events are shown in the report
 
     spanParams: #SpanParamsDTO *
     The network span to report on
 
     timePeriod: string *
     Which configuration changes are to be included in the report; that is, include the changes that occurred within this time period
 
     whichTrailGuid: string *
     Which configuration trail is to be reported on
}

ComboGroupDTO

 Details about a combo group

{
     id: string
     The combo group's unique database key (read-only)
 
     name: string *
     The combo group's display name
 
     realmId: #ComponentId *
     Identifies the realm this combo group belongs to
 
     realmDetailsLink: string
     Link to get complete details about the parent realm (read-only)
 
     groups: #BooleanExpressionDTO *
     How groups are combined to form this combo group
 
     dynamicFields: [
       The dynamic fields
 
       #DynamicFieldValueDTO
     ]
 
     memberDevicesLink: string
     Link to get a list of the member devices (read-only)
}

CommitActionDTO

 Settings for executing a commit action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$CommitActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     useAuxiliaryInterfaceFlag: boolean
     Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
     spanParams: #SpanParamsDTO *
     The selected network span
 
     commitAllContextsFlag: boolean
     When the device supports multiple security contexts, which contexts should be committed; false means just the context logged in to; true means all contexts
 
     markAsTrustedFlag: boolean
     Whether or not any changed configurations resulting from running this action should be marked as trusted
}

ComparisonCriteriaDTO

 How a value parsed out of a configuration line is compared

ComplianceStatusActionDTO

 Settings for executing a compliance status action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$ComplianceStatusActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     useAuxiliaryInterfaceFlag: boolean
     Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
     spanParams: #SpanParamsDTO *
     The selected network span
 
     ruleSetNames: [
       The names of the rule sets to be reported on; when null/empty, then this action reports on all rule sets (read-only)
 
       string
     ]
}

ComplianceStatusDTO

 Which rules the device is compliant with, and which rules the device is violating

{
     passedRules: [
       The rules that are currently compliant
 
       #PassedRuleDTO
     ]
 
     violatedRules: [
       The rules that are currently in violation
 
       #FailedRuleDTO
     ]
}

ComplianceStatusResultsDTO

 Results of executing a compliance status action

{
     ruleResults: [
       Compliance status for each rule
 
       #ComplianceStatusRuleResultDTO
     ]
}

ComplianceStatusRuleResultDTO

 The compliance status for a rule

{
     annotation: string
     The rule's annotation
 
     category: string
     The rule's category
 
     ruleId: string
     The rule's database key
 
     ruleName: string
     The rule's name
 
     ruleSetName: string
     The name of the rule's parent rule set
 
     status: string
     The compliance status
 
     trailName: string
     Which configuration trail this is a status for
 
     violationSeverityId: integer
     The rule's violation severity
}

ComplianceSummaryParametersDTO

 Settings for attaching a compliance summary report to an email

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$ComplianceSummaryParametersDTO"

{
     categories: [
       Selects rules in these categories; null/empty means no filtering of rules by category is done
 
       string
     ]
 
     forceReevaluationFlag: boolean
     When enabling to report only on devices assigned to the selected rules/rule sets, whether to use stored compliance status (false) or r-evaluate or re-compute the status (true) in case the stored results may be stale (such as after adding new rules or changing rules such that no status is currently stored)
 
     onlyShowDevicesAssignedToSelectedFlag: boolean
     Whether or not to report only on devices assigned to the selected rules or rule sets; when true, this pulls results from stored compliance status, which is far more efficient than re-evaluating each rule's status
 
     ruleIds: [
       Identifies which rules are to be reported on; can specify rules or rule sets, but not both; when both are null/empty, reports on all rule sets
 
       #ComponentId
     ]
 
     ruleSetIds: [
       Identifies which rule sets are to be reported on; can specify rules or rule sets, but not both; when both are null/empty, reports on all rule sets
 
       #ComponentId
     ]
 
     scriptTypeId: integer *
     Which script or configuration is to be reported on; limited to current/trusted running and startup, and other current
 
     showAddressColumnFlag: boolean
     Whether or not the report includes a column showing the device's primary interface host name/IP address/URL
 
     showBaseScoreColumnFlag: boolean
     Whether or not the report includes a column showing the rule's associated security vulnerability base score
 
     showFailedStatusFlag: boolean
     Whether or not the report includes rows where the result is 'Failed'
 
     showSuccessfulStatusFlag: boolean
     Whether or not the report includes rows where the result is 'Passed'
 
     showNonApplicableStatusFlag: boolean
     Whether or not the report includes rows where the result is 'N/A'
 
     spanParams: #SpanParamsDTO *
     The network span to report on
 
     whichTrailGuid: string
     When the script or configuration type is other current, specifies which other trail is to be reported on
}

ComponentId

 Identifies a component in a form that can be input to either the same BMC Network Automation server that emitted it or to a different BMC Network Automation server; the name, qualifiers, and type uniquely identify a component; and they verify that anything successfully retrieved by a database key is the right component

{
     id: string
     The database key of the component; an incoming component can be identified either by its database key, or by its unique name, or by its name with qualifiers which are unique when combined; when this database key is present, it takes precedence and componentName and qualifiers(when present) are used to verify the retrieved component
 
     componentName: string
     The name of the component; an incoming component can be identified either by its database key, or by its unique name, or by its name with qualifiers which are unique when combined; this name is used to verify any component retrieved by database key, and is used if there is no database key or if the database key fails to resolve
 
     componentType: string *
     The type of the component, used to verify what is retrieved by key/name; valid values are: Combogroup, Condition, Configuration, Device, DynamicField, EmailDistributionList, Group, Keyword, Model, OsImage, Realm, Role, Rule, RuleSet, SecurityVulnerability, SnmpManagerStation, Template, and User
 
     qualifiers: {
       Any additional single qualifier needed to identify the component uniquely, when the name alone is not sufficient; the map key is the extra attribute name string; the map value string completes the identification of the component; for componentType Configuration: key=deviceName, value=name of the device the configuration belongs to; for componentType DynamicField: key=type, value=base class name of the component associated with the dynamic field; for componentType Group, ComboGroup: key=realmName, value=name of the realm the group belongs to; for componentType Model: key=vendorGuid, value=the vendor GUID; for componentType OsImage: key=filename, value=name of the file(s) making up the image; for componentType SecurityVulnerability: key=vendorGuid, value=the vendor GUID
     }
}

ConfigCompareParametersDTO

 Settings for attaching a configuration comparison report to an email

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$ConfigCompareParametersDTO"

{
     compareScriptTypeId: integer *
     Which script or configuration is to be compared, appearing on the left side of the report; limited to current running and current startup
 
     compareToScriptTypeId: integer *
     Which script or configuration is to be compared, appearing on the right side of the report; limited to current/trusted running and startup, target, and template
 
     runtimeProperties: {
       When the script being compared to is a template and the template contains runtime substitution parameters, provides the values for those parameters; this is a map where the key is the property name string and the value is the property value string
     }
 
     spanParams: #SpanParamsDTO *
     The network span to report on
 
     templateId: #ComponentId
     When the script being compared to is a template, identifies the selected template
}

ConfigurationDTO

 Details about a configuration

{
     id: string
     The configuration's unique database key
 
     created: date-time
     Date/time this configuration was obtained from the device
    Example: 2017-01-31T13:45:00.000+0000
 
     trailGuid: string
     The GUID of the configuration trail
 
     osImageName: string
     The discovered operating system version
 
     annotation: string
     The user-defined notes or description about this configuration
 
     changeID: string
     The change ID from the job that generated this configuration, for mapping into any external change management system
 
     jobID: string
     The job ID of the job that generated this configuration
 
     externalFlag: boolean
     Whether this configuration resulted from an external change made to the device (true) or from an internal change made to the device (false); an internal change occurs when the system is used to make the change; an external change occurs when the device is changed by other means outside the system and detected via syslog
 
     historicalFlag: boolean
     Whether this is a historical configuration (true) or a current configuration (false)
 
     trustedFlag: boolean
     Whether or not this configuration is trusted
 
     trustedTimestamp: date-time
     Date/time this configuration was marked as trusted
    Example: 2017-01-31T13:45:00.000+0000
 
     filename: string
     The name of the file that any binary data was copied from
 
     dataLength: integer
     The length of the ASCII data in bytes; a zero indicates there is no ASCII data
 
     binaryDataLength: integer
     The length of the binary data in bytes; a zero indicates there is no binary data
 
     dataLink: string
     Link to retrieve the ASCII data
 
     binaryDataLink: string
     Link to retrieve the binary data
}

CorrectiveCustomActionDTO

 Settings for executing a custom action, as a corrective action in a rule

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.RuleService$CorrectiveCustomActionDTO"

{
     commitFlag: boolean
     Whether or not to commit changes after running the commands in the custom action
 
     guid: string *
     The GUID that identifies the type of action
 
     markAsTrustedFlag: boolean
     Whether or not any changed configurations resulting from running this action should be marked as trusted
 
     rebootFlag: boolean
     Whether or not the device should be rebooted after running the commands in the custom action
 
     runtimeProperties: {
       Name/value pairs for any runtime parameters, for substitution into device commands; this is a map where the key is the property name string and the value is the property value string
     }
}

CorrectiveDeployOsImageActionDTO

 Settings for executing a deploy OS image action, as a corrective action in a rule

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.RuleService$CorrectiveDeployOsImageActionDTO"

{
     activationKey: string
     When image source is from remote file server, license key to activate features in the binary image on the device
 
     deleteCurrentImageId: integer *
     How to handle the current image file, when the device supports file management of its binary files
 
     files: [
       When image source is from remote file server, which file (or files, for devices with multi-file images) are to be deployed
 
       #OsFileDTO
     ]
 
     footprintKbytes: integer
     When image source is from remote file server, the memory footprint, in kilobytes, for the remote image, to verify the new image can run in the device (for those devices that support memory size discovery)
 
     imageFromLibraryId: #ComponentId
     When image source is image from library, identifies the OS image in the library
 
     imageSourceId: integer *
     Which OS image is to be deployed; as a rule corrective action, this is limited to an image from the library or an image from a remote file server
 
     markAsTrustedFlag: boolean
     Whether or not any changed configurations resulting from running this action should be marked as trusted
 
     parallelExecutionFlag: boolean
     When true, runs this action on multiple devices concurrently; when false, runs this action on multiple devices one by one sequentially (to reduce memory overhead due to large or identical images)
 
     rebootTypeId: integer *
     Whether or not to reboot after the image is deployed, and how to handle unsaved changes prior to rebooting
 
     targetImageFilesystem: string *
     Where the binary file is to be placed on the device's file systems
 
     transferModeId: integer
     When image source is from remote file server, which file transfer mode is to be used to copy files from the remote server to the device
}

CorrectiveDeployToActiveActionDTO

 Settings for executing a deploy to active action, as a corrective action in a rule

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.RuleService$CorrectiveDeployToActiveActionDTO"

{
     commitFlag: boolean
     Whether or not to commit changes after deploying the script or configuration
 
     forceTunneledTransferFlag: boolean
     Whether or not to deploy the script in tunneled mode, overriding the transfer mode set in the device
 
     markAsTrustedFlag: boolean
     Whether or not any changed configurations resulting from running this action should be marked as trusted
 
     scriptParams: #CorrectiveScriptParamsDTO *
     Which script or configuration is to be deployed to the device
 
     smartMergeModeId: integer
     Selects to build an incremental merge script or a full merge script
 
     stopOnSyntaxErrorFlag: boolean
     When deploying in tunneled mode, whether or not to stop pushing commands from the script once a syntax error is detected
 
     syntaxScanFlag: boolean
     Whether or not to validate the command line syntax in the script prior to deploying it
}

CorrectiveDeployToStoredActionDTO

 Settings for executing a deploy to stored action, as a corrective action in a rule

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.RuleService$CorrectiveDeployToStoredActionDTO"

{
     markAsTrustedFlag: boolean
     Whether or not any changed configurations resulting from running this action should be marked as trusted
 
     rebootFlag: boolean
     Whether or not the device should be rebooted after deploying the script or configuration
 
     scriptParams: #CorrectiveScriptParamsDTO *
     Which script or configuration is to be deployed to the device
}

CorrectiveScriptParamsDTO

 Parameters that select a script or configuration, within a corrective action in a rule

{
     adhocTemplate: #AdhocTemplateDTO
     When the selected script type is ad-hoc template, this is the template
 
     templateId: #ComponentId
     When the selected script type is template, this identifies the template
 
     runtimeProperties: {
       When the selected script type is template, and the template contains runtime substitution parameters, this contains the name/value pairs for those parameters; this is a map where the key is the property name string and the value is the property value string
     }
 
     scriptTypeId: integer *
     The selected script or configuration type; for a rule corrective action, this is limited to complying with this rule, template, and ad-hoc template
}

CorrectiveSpanActionDTO

 Settings for executing a span action, as a corrective action in a rule

CustomActionDTO

 Settings for executing a custom action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$CustomActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     useAuxiliaryInterfaceFlag: boolean
     Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
     spanParams: #SpanParamsDTO *
     The selected network span
 
     commitFlag: boolean
     Whether or not to commit changes after running the commands in the custom action
 
     markAsTrustedFlag: boolean
     Whether or not any changed configurations resulting from running this action should be marked as trusted
 
     rebootFlag: boolean
     Whether or not the device should be rebooted after running the commands in the custom action
 
     runtimeProperties: {
       Name/value pairs for any runtime parameters, for substitution into device commands; this is a map where the key is the property name string and the value is the property value string; the use of a shared runtime parameter (in a predefined job) is indicated by a value in the form "sharedRuntimeParam." followed by the name of the shared runtime parameter
     }
}

CustomActionResultsDTO

 Results of executing a custom action

{
     resultProperties: {
       Any result.* properties that were discovered or populated while executing the custom action, as name/value pairs; this is a map where the key is the property name string and the value is the property value string
     }
}

DeployOsImageActionDTO

 Settings for executing a deploy OS image action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$DeployOsImageActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     useAuxiliaryInterfaceFlag: boolean
     Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
     spanParams: #SpanParamsDTO *
     The selected network span
 
     activationKey: string
     When image source is from remote file server, license key to activate features in the binary image on the device
 
     deleteCurrentImageId: integer *
     How to handle the current image file, when the device supports file management of its binary files
 
     files: [
       When image source is from remote file server, which file (or files, for device with multi-file images) is to be deployed
 
       #OsFileDTO
     ]
 
     footprintKbytes: integer
     When image source is from remote file server, the memory footprint, in kilobytes, for the remote image, to verify the new image can run in the device (for those devices that support memory size discovery)
 
     imageActiveOnTimestamp: date-time
     When image source is image active on date, specifies the date/time
    Example: 2017-01-31T13:45:00.000+0000
 
     imageFromLibraryId: #ComponentId
     When image source is image from library, identifies the OS image to be deployed from the library
 
     imageSourceId: integer *
     Which OS image is to be deployed; note that you will not be able to create or update this action to deploy from a file (feature is not currently supported)
 
     markAsTrustedFlag: boolean
     Whether or not any changed configurations resulting from running this action should be marked as trusted
 
     parallelExecutionFlag: boolean
     When true, runs this action on multiple devices concurrently; when false, runs this action on multiple devices one by one sequentially (to reduce memory overhead due to large or identical images)
 
     rebootTypeId: integer *
     Whether or not to reboot after the image is deployed, and how to handle unsaved changes prior to rebooting
 
     restoreAssociatedStartupFlag: boolean
     Whether or not to restore the startup configuration active when an image from the library was active, or active at the selected date/time
 
     targetImageFilesystem: string *
     Where the binary file is to be placed on the device's file systems
 
     transferModeId: integer
     When image source is from remote file server, which file transfer mode is to be used to copy files from the remote server to the device
 
     unresolvableOsImage: string
     Indicates that the selected OS image no longer exists in the library and thus re-using this action is not possible (read-only)
}

DeployToActiveActionDTO

 Settings for executing a deploy to active action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$DeployToActiveActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     useAuxiliaryInterfaceFlag: boolean
     Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
     spanParams: #SpanParamsDTO *
     The selected network span
 
     commitFlag: boolean
     Whether or not to commit changes after deploying the script or configuration
 
     forceTunneledTransferFlag: boolean
     Whether or not to deploy the script in tunneled mode, overriding the transfer mode set in the device
 
     markAsTrustedFlag: boolean
     Whether or not any changed configurations resulting from running this action should be marked as trusted
 
     overrideCorrectiveActionOptionsFlag: boolean
     When remediating, whether or not to use various options as defined in the rule corrective actions, or to use options as defined here as an override; when false, the commitFlag, forceTunneledTransferFlag, markAsTrustedFlag, smartMergeModeId,stopOnSyntaxErrorFlag, and syntaxScanFlag included here are ignored
 
     scriptParams: #ScriptParamsDTO *
     Which script or configuration is to be deployed to the device
 
     smartMergeModeId: integer
     Selects to build an incremental merge script or a full merge script
 
     stopOnSyntaxErrorFlag: boolean
     When deploying in tunneled mode, whether or not to stop pushing commands from the script once a syntax error is detected
 
     syntaxScanFlag: boolean
     Whether or not to validate the command line syntax in the script prior to deploying it
}

DeployToActiveResultsDTO

 Results of executing a deploy to active action

{
     scriptContents: string
     The script that was deployed to the device
}

DeployToStoredActionDTO

 Settings for executing a deploy to stored action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$DeployToStoredActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     useAuxiliaryInterfaceFlag: boolean
     Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
     spanParams: #SpanParamsDTO *
     The selected network span
 
     markAsTrustedFlag: boolean
     Whether or not any changed configurations resulting from running this action should be marked as trusted
 
     overrideCorrectiveActionOptionsFlag: boolean
     When remediating, whether or not to use various options as defined in the rule corrective actions, or to use options as defined here as an override; when false, the markAsTrustedFlag and rebootFlag included here are ignored
 
     rebootFlag: boolean
     Whether or not the device should be rebooted after deploying the script or configuration
 
     scriptParams: #ScriptParamsDTO *
     Which script or configuration is to be deployed to the device
}

DeviceAdapterDTO

 Information about a device adapter

{
     id: string
     The database key
 
     name: string
     The adapter's display name
 
     annotation: string
     Annotation with reasons for modification
 
     enabledFlag: boolean
     Whether or not this adapter is enabled
 
     guid: string
     The adapter's GUID
 
     lastModifiedTimestamp: date-time
     When this adapter was last modified
    Example: 2017-01-31T13:45:00.000+0000
 
     lastModifiedUserName: string
     The name of the user who last modified this adapter
 
     requiresMergeFlag: boolean
     Whether or not the adapter requires a manual three-way merge, caused by a software upgrade
 
     stateId: integer
     Whether an adapter is currently in the new, modified, or baseline state
 
     stateName: string
     The meaning of the numeric stateId
 
     typeId: integer
     The type of device adapter
 
     typeName: string
     The meaning of the numeric typeId
}

DeviceAgentDTO

 Information about a device agent

{
     id: string
     The database key
 
     name: string
     The device agent's unique display name
 
     address: string
     The address of the device agent
 
     port: integer
     The port of the device agent
 
     deviceFacingIpv4Address: string
     The IPv4 address of the agent relative to its managed devices
 
     deviceFacingIpv6Address: string
     The IPv6 address of the agent relative to its managed devices
 
     enabledFlag: boolean
     Whether or not this device agent is enabled
 
     localFlag: boolean
     Whether or not this device agent is local
 
     dynamicFields: [
       The dynamic fields
 
       #DynamicFieldValueDTO
     ]
}

DeviceDTO

 Details about a device

{
     id: string
     The device's unique database key (read-only)
 
     name: string *
     The device's unique name
 
     realmId: string *
     The database key of the realm this device belongs to
 
     realmDetailsLink: string
     Link to get complete details about the parent realm (read-only)
 
     onlineFlag: boolean
     Whether or not this device is online
 
     modelName: string
     The discovered model (read-only)
 
     osImageName: string
     The discovered operating system version (read-only)
 
     deviceTypeGuid: string *
     The GUID of the device type
 
     vendorGuid: string
     The GUID of the vendor
 
     categoryId: integer *
     The category
 
     created: date-time
     The date/time this device was created (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     externalId: string
     A key or identifier into some external system
 
     remoteImageFileServerId: string
     The database key of the remote image file server
 
     remoteImageFileServerDetailsLink: string
     Link to get complete details about the remote image file server (read-only)
 
     lastOnlineStateChange: date-time
     The last time the device's online state changed (either came online or was taken offline; read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     securityContextName: string
     The security context name
 
     securityContextTypeId: integer
     The security context type
 
     targetConfigurationId: string
     The database key of the target configuration read-only)
 
     targetConfigurationDetailsLink: string
     Link to get complete details about the target configuration (read-only)
 
     managerDeviceId: string
     The database key of the device that manages this device
 
     managerDeviceDetailsLink: string
     Link to get complete details about the manager device (read-only)
 
     numVfws: integer
     The number of virtual firewalls in this device (read-only)
 
     numVlbs: integer
     The number of virtual load balancers in this device (read-only)
 
     numVrfs: integer
     The number of VRFs in this device (read-only)
 
     primaryInterface: #DeviceInterfaceDTO *
     The device's primary interface
 
     auxiliaryInterface: #DeviceInterfaceDTO
     The device's auxiliary interface
 
     dynamicFields: [
       The dynamic fields
 
       #DynamicFieldValueDTO
     ]
 
     statusLink: string
     Link to get detailed device status (read-only)
 
     currentConfigurationsLink: string
     Link to get the current configurations (read-only)
 
     trustedConfigurationsLink: string
     Link to get the trusted configurations (read-only)
 
     configurationsLinks: [
       Links to get all configurations per trail (read-only)
 
       string
     ]
}

DeviceFilterDTO

 Criteria for filtering devices; discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$DeviceFilterDTO"

{
     dynamicFieldFilters: {
       Any filters on dynamic fields; this is a map where the map key is the filter string (the value to be matched) and the map value is a ComponentId that identifies the dynamic field; menu-type dynamic fields support only exact matching; the filter string must be formatted properly when the dynamic field is a Date or Integer type
     }
 
     containsUnresolvableDynamicFieldFiltersFlag: boolean
     Indicates that one or more of the dynamic fields being filtered on no longer exists and thus re-using this filter may not result in the same outcome (read-only)
 
     accessModeId: integer
     Search for devices with this access mode
 
     addressMatch: string
     Search for devices matching this wildcard-enabled IP address or host name
 
     autoDspFlag: boolean
     Search for devices set for device security profile auto-discovery (true) or set to an explicit profile (false); null means do no auto-discovery mode filtering
 
     categoryId: integer
     Search for devices in this category
 
     createdTimePeriod: string
     Search for devices created within this time period
 
     deviceAgentName: string
     Search for devices whose device agent equals this name
 
     deviceSecurityProfileName: string
     Search for devices whose device security profile equals this name
 
     deviceTypeGuid: string
     Search for devices whose device type equals this GUID
 
     filterAuxiliaryInterfaceFlag: boolean
     Whether or not to examine the auxiliary interface settings when matching on the interface-related fields (access mode, transfer mode, address, NAT address, device agent, and device security profile)
 
     filterPrimaryInterfaceFlag: boolean
     Whether or not to examine the primary interface settings when matching on the interface-related fields (access mode, transfer mode, address, NAT address, device agent, and device security profile)
 
     managerDeviceName: string
     Search for devices whose manager name equals this name
 
     modelNameMatch: string
     Search for devices whose model name matches this wildcard-enabled string
 
     nameMatch: string
     Search for devices whose name matches this wildcard-enabled string
 
     natAddressMatch: string
     Search for devices whose NAT address matches this wildcard-enabled string
 
     onlineFlag: boolean
     Search for either online devices (true) or offline devices (false); null means do not filter on the online/offline state
 
     osImageNameMatch: string
     Search for devices whose OS image name matches this wildcard-enabled string
 
     securityContextTypeId: integer
     Search for devices set to this type of security context
 
     transferModeId: integer
     Search for devices with this file transfer mode
 
     vendorGuid: string
     Search for devices whose device type belongs to this vendor
 
     noDiscrepanciesFlag: boolean
     Search for devices that have no discrepancies at all
 
     noDiscrepanciesIncludeFlag: boolean
     Whether to include (true) or exclude (false) devices that have no discrepancies
 
     osImageDiscrepancyFlag: boolean
     Search for devices that have an OS image discrepancy
 
     osImageDiscrepancyIncludeFlag: boolean
     Whether to include (true) or exclude (false) devices that have an OS image discrepancy
 
     runningStartupDiscrepancyFlag: boolean
     Search for devices that have a Running vs Startup discrepancy
 
     runningStartupDiscrepancyIncludeFlag: boolean
     Whether to include (true) or exclude (false) devices that have a Running vs Startup discrepancy
 
     runningTrustedDiscrepancyFlag: boolean
     Search for devices that have a Running vs Trusted Running discrepancy
 
     runningTrustedDiscrepancyIncludeFlag: boolean
     Whether to include (true) or exclude (false) devices that have a Running vs trusted Running discrepancy
 
     startupTrustedDiscrepancyFlag: boolean
     Search for devices that have a Startup vs Trusted Startup discrepancy
 
     startupTrustedDiscrepancyIncludeFlag: boolean
     Whether to include (true) or exclude (false) devices that have a Startup vs trusted Startup discrepancy
 
     noViolationsFlag: boolean
     Search for devices that have no compliance violations
 
     noViolationsIncludeFlag: boolean
     Whether to include (true) or exclude (false) devices that have no compliance violations
 
     includedViolationTrailGuids: [
       Include devices in the results that have a compliance violation in one of these trails
 
       string
     ]
 
     excludedViolationTrailGuids: [
       Exclude devices from the results that have a compliance violation in one of these trails
 
       string
     ]
 
     lastAttemptedSpanActionFlag: boolean
     Search for devices whose last attempted span action matches a particular completion status
 
     lastAttemptedSpanActionGuid: string
     When lastAttemptedSpanActionFlag is true, specifies which span action to examine
 
     lastAttemptedSpanActionStatusId: integer
     When lastAttemptedSpanActionFlag is true, specifies which completion status to search for
 
     lastAttemptedSpanActionErrorMatch: string
     When lastAttemptedSpanActionFlag is true, specifies which completion error message to search for, wildcards allowed
 
     lastSuccessfulSpanActionFlag: boolean
     Search for devices whose last successful span action occurred within a selected time period
 
     lastSuccessfulSpanActionGuid: string
     When lastSuccessfulSpanActionFlag is true, specifies which span action to examine
 
     lastSuccessfulSpanActionTimePeriod: string
     When lastSuccessfulSpanActionFlag is true, specifies when the action is to have succeeded
 
     noAttemptedSpanActionFlag: boolean
     Searches for devices that have not attempted a span action within a specified number of days
 
     noAttemptedSpanActionGuid: string
     When noAttemptedSpanActionFlag is true, specifies which span action to examine
 
     noAttemptedSpanActionDays: integer
     When noAttemptedSpanActionFlag is true, specifies when the action is to have been attempted
 
     noSuccessfulSpanActionFlag: boolean
     Searches for devices that have not succeeded executing a span action within a specified number of days
 
     noSuccessfulSpanActionGuid: string
     When noSuccessfulSpanActionFlag is true, specifies which span action to examine
 
     noSuccessfulSpanActionDays: integer
     When noSuccessfulSpanActionFlag is true, specifies when the action is to have succeeded
 
     iosHwFilter: #IOSHardwareInventoryFilterDTO
     Options for filtering on hardware inventory information obtained from Cisco IOS or IOS-like devices
}

DeviceInterfaceDTO

 Details for making a device connection

{
     address: string *
     The IP address, host name, or URL of the device
 
     port: string
     The TCP port used to connect to the device
 
     natAddress: string
     The device agent's address as it is known to the device, either an IP address or a host name
 
     accessModeId: integer *
     The protocol used to connect to the device
 
     transferModeId: integer *
     The protocol used to exchange files with the device
 
     deviceAgentId: string *
     The database key of the device agent that manages this device
 
     deviceAgentDetailsLink: string
     Link to get complete details about the device agent (read-only)
 
     deviceSecurityProfileId: string
     The login credentials for accessing the device
 
     deviceSecurityProfileDetailsLink: string
     Link to get complete details about the device security profile (read-only)
 
     autoDiscoverDspFlag: boolean
     Whether or not the device security profile is to be discovered automatically at the next login attempt
}

DeviceInventoryParametersDTO

 Settings for attaching a device inventory report to an email

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$DeviceInventoryParametersDTO"

{
     attributeIds: [
       Which selected attributes or device fields are to be displayed in the report; used only when showAllAttributesFlag is false
 
       integer
     ]
 
     dynamicFieldIds: [
       Which dynamic fields are to be displayed in the report
 
       #ComponentId
     ]
 
     forceLinearFormatFlag: boolean
     How the report is to be formatted; true means in linear format, false means in tabular format; tabular format selection is ignored when multiple complex attributes are selected
 
     historyTrailGuids: [
       Trails selected for display of their configuration history
 
       string
     ]
 
     showAllAttributesFlag: boolean
     Whether or not all attributes are to be shown in the report; false indicates display of selected device information as listed in attributeIds
 
     spanActionGuids: [
       Which span action status is to be displayed in the report
 
       string
     ]
 
     spanParams: #SpanParamsDTO *
     The network span to report on
 
     timePeriod: string
     When historyTrailGuids are selected, specifies which configurations are to be included in the report (those falling within this time period)
 
     violationTrailGuids: [
       Trails selected for display of their violation status
 
       string
     ]
}

DeviceResultDTO

 Full details about device action execution results

{
     id: string
     This device result's unique database key
 
     deviceId: string
     The unique database key of the device where this action ran
 
     deviceName: string
     The name of the device where this action ran
 
     realmName: string
     The name of the realm the device belonged to at execution time
 
     actionNumber: integer
     Which action within the job's list of actions
 
     subactionNumber: integer
     Which sub-action within the action; when null, does not refer to a sub-action
 
     statusId: integer
     The completion status of the device action
 
     startTimestamp: date-time
     When the device action began execution
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the device action completed execution
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason for a device action execution failure
 
     exception: string
     Further details about a device action execution failure
 
     accessModeId: integer
     The access mode that was used to connect to the device
 
     transferModeId: integer
     The transfer mode that was used to exchange files with the device
 
     deviceAgentName: string
     The device agent that was used to communicate with the device
 
     deviceInterfaceName: string
     Which set of interface settings was used (primary or auxiliary)
 
     deviceTypeName: string
     Which device type was used to interact with the device
 
     port: string
     The TCP port that was used to connect to the device
 
     deviceSecurityProfileName: string
     The credentials that were used to login to the device
 
     actionSpecificResults: #ActionSpecificResultsDTO
     Further detailed results
 
     transcriptLink: string
     Link to get the recorded device interaction transcript, when there is such a transcript (may not have one on certain error conditions)
}

DeviceSecurityProfileDTO

 Information about a device security profile

{
     id: string
     The database key
 
     name: string
     The device security profile's unique display name
 
     loginUserName: string
     Username for logging in to devices
 
     privilegedUserName: string
     Privileged username for logging in to devices
 
     realm: #ComponentId
     Identifies the associated realm; when null, this profile is available to the entire network
 
     realmDetailsLink: string
     Link to get complete details about the associated realm
}

DeviceStatusDTO

 Status information about a device

{
     id: string
     The unique database key of this device status
 
     runningViolationTimestamp: date-time
     Date/time the earliest running compliancy violation occurred
    Example: 2017-01-31T13:45:00.000+0000
 
     startupViolationTimestamp: date-time
     Date/time the earliest startup compliancy violation occurred
    Example: 2017-01-31T13:45:00.000+0000
 
     otherTrailsViolationTimestamp: date-time
     Date/time the earliest other compliancy violation occurred
    Example: 2017-01-31T13:45:00.000+0000
 
     rvtDiscrepancyTimestamp: date-time
     Date/time the Running vs Trusted discrepancy occurred
    Example: 2017-01-31T13:45:00.000+0000
 
     svtDiscrepancyTimestamp: date-time
     Date/time the Startup vs Trusted discrepancy occurred
    Example: 2017-01-31T13:45:00.000+0000
 
     rvsDiscrepancyTimestamp: date-time
     Date/time the Running vs Startup discrepancy occurred
    Example: 2017-01-31T13:45:00.000+0000
 
     osImageDiscrepancyTimestamp: date-time
     Date/time the OS image discrepancy occurred
    Example: 2017-01-31T13:45:00.000+0000
 
     currentHardwareInventory: #HardwareInventoryDTO
     The current discovered or imported hardware inventory information
 
     osImageLoadHistory: [
       Which OS images have been discovered or deployed on the device
 
       #OsImageLoadHistoryDTO
     ]
 
     actionStatus: [
       Latest device action execution status
 
       #ActionStatusDTO
     ]
 
     complianceStatus: {
       Latest compliance status (rules passed and failed during the latest scan); the map key is the configuration trail GUID of the configuration that was examined; the map value is the ComplianceStatusDTO for that trail
     }
}

DiscrepancySummaryParametersDTO

 Settings for attaching a discrepancy summary report to an email

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$DiscrepancySummaryParametersDTO"

{
     spanParams: #SpanParamsDTO *
     The network span to report on
}

DomainAnywhereDTO

 Specifies that the entire configuration is validated against the subject

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.RuleService$DomainAnywhereDTO"

{
     excludeTriggerFlag: boolean
     Whether or not lines that match the trigger are removed from the lines in the domain
 
     ignoreCommentsFlag: boolean
     Whether or not comment lines (as defined by the device's device type) are removed from the lines in the domain
 
     noOtherLinesContainingPattern: string
     Regular expression to match lines that the rule does not allow to exist in the configuration outside of those lines already matched by the rule's subject
}

DomainBlocksDTO

 Specifies that configuration lines within selected blocks make up the domain to be examined, where each block is validated against the subject

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.RuleService$DomainBlocksDTO"

{
     begin: #SearchStringDTO *
     The configuration line that starts a block of contiguous lines
 
     beginInclusiveFlag: boolean
     Whether or not the line that matches the 'begin' value is part of the block and thus included in validation against the subject; note the end line is always excluded from subject matching
 
     caseSensitiveFlag: boolean
     Whether or not string matching is case sensitive
 
     deleteEmptyBlocksFlag: boolean
     When computing the compliant configuration during remediation, if removing lines such that the enclosing block becomes completely empty, this flag determines whether or not the empty enclosing block is also removed
 
     distinctEndLinesFlag: boolean
     Whether or not each begin line has a distinct matching end line, such that the removal of an empty block during remediation can safely remove the end line; some configurations use a closing brace or an exit to delimit every block (in which case this flag should be true to prevent stray end lines being left behind); some configurations end a block with the start of a different block (in which case this flag should be false to prevent improper removal of unrelated lines)
 
     end: #SearchStringDTO *
     The configuration line that ends a block of lines
 
     excludeTriggerFlag: boolean
     Whether or not lines that match the trigger are removed from the lines in the domain
 
     frequency: string *
     How many times the blocks can appear in the configuration: notAtAll: the block should never appear and the rule is violated if it does; atMostOnce: the block should appear zero or one times and the rule is violated if it appears more; exactlyOnce: the block should appear once and the rule is violated if it appears more; atLeastOnce: the block should appear one or more times and the rule is violated if it is missing; anyNumberOfTimes: the block can appear any number of times
 
     ignoreCommentsFlag: boolean
     Whether or not comment lines (as defined by the device's device type) are removed from the lines in the domain
 
     ignoreEOLFlag: boolean
     Whether or not line breaks are ignored when matching the subject against the lines in this domain; when true, all eligible lines within the block are concatenated together into a single line before being tested against the subject
 
     ignoreBlocksContainingPattern: string
     Regular expression to select blocks to be removed from the domain; when this pattern is matched by at least one line within a block, then that block is ignored
 
     includeBlocksContainingPattern: string
     Regular expression to select blocks to be included in the domain; when this pattern is matched by at least one line within a block, then that block is included in the domain
 
     noOtherLinesContainingPattern: string
     Regular expression to match lines that the rule does not allow to exist in the configuration outside of those lines already matched by the rule's subject
}

DomainDTO

 Specifies what part of the configuration is to be examined or validated

DomainImageDTO

 Specifies that the OS image associated with the configuration is validated against the subject

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.RuleService$DomainImageDTO"

{
}

DomainLinesDTO

 Specifies that selected configuration lines make up the domain to be examined

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.RuleService$DomainLinesDTO"

{
     caseSensitiveFlag: boolean
     Whether or not string matching is case sensitive
 
     excludePattern: string
     Regular expression for lines removed from the lines in the domain
 
     excludeTriggerFlag: boolean
     Whether or not lines that match the trigger are removed from the lines in the domain
 
     ignoreCommentsFlag: boolean
     Whether or not comment lines (as defined by the device's device type) are removed from the lines in the domain
 
     includePattern: string *
     Regular expression for lines included in the domain, selecting the lines that are validated against the subject
 
     noOtherLinesContainingPattern: string
     Regular expression to match lines that the rule does not allow to exist in the configuration outside of those lines already matched by the rule's subject
}

DomainNestedBlocksDTO

 Specifies that configuration lines within selected blocks make up the domain to be examined, where each innermost nested block is validated against the subject

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.RuleService$DomainNestedBlocksDTO"

{
     blocks: [
       The begin and end lines for the nested levels of blocks that enclose the lines of interest
 
       #NestedBlockDTO
     ] *
 
     beginRegexFlag: boolean
     Whether or not the begin strings represent regex patterns (true) or exact complete lines (false)
 
     caseSensitiveFlag: boolean
     Whether or not string matching is case sensitive
 
     deleteEmptyBlocksFlag: boolean
     When computing the compliant configuration during remediation, if removing lines such that the enclosing block becomes completely empty, this flag determines whether or not the empty enclosing block is also removed
 
     distinctEndLinesFlag: boolean
     Whether or not each begin line has a distinct matching end line, such that the removal of an empty block during remediation can safely remove the end line; some configurations use a closing brace or an exit to delimit every block (in which case this flag should be true to prevent stray end lines being left behind); some configurations end a block with the start of a different block (in which case this flag should be false to prevent improper removal of unrelated lines)
 
     endRegexFlag: boolean
     Whether or not the end strings represent regex patterns (true) or exact complete lines (false)
 
     excludeTriggerFlag: boolean
     Whether or not lines that match the trigger are removed from the lines in the domain
 
     frequency: string *
     How many times the innermost blocks can appear in the configuration: notAtAll: the block should never appear and the rule is violated if it does; atMostOnce: the block should appear zero or one times and the rule is violated if it appears more; exactlyOnce: the block should appear once and the rule is violated if it appears more; atLeastOnce: the block should appear one or more times and the rule is violated if it is missing; anyNumberOfTimes: the block can appear any number of times
 
     ignoreCommentsFlag: boolean
     Whether or not comment lines (as defined by the device's device type) are removed from the lines in the domain
 
     ignoreEOLFlag: boolean
     Whether or not line breaks are ignored when matching the subject against the lines in this domain; when true, all eligible lines within the innermost block are concatenated together into a single line before being tested against the subject
 
     ignoreBlocksContainingPattern: string
     Regular expression to select blocks to be removed from the domain; when this pattern is matched by at least one line within an innermost block, then that block is ignored
 
     includeBlocksContainingPattern: string
     Regular expression to select blocks to be included in the domain; when this pattern is matched by at least one line within an innermost block, then that block is included in the domain
 
     innermostBeginInclusiveFlag: boolean
     Whether or not the line that matches the 'begin' value of the innermost block is part of that block and thus included in validation against the subject; note the end line is always excluded from subject matching
 
     noOtherLinesContainingPattern: string
     Regular expression to match lines that the rule does not allow to exist in the configuration outside of those lines already matched by the rule's subject
}

DynamicFieldDTO

 Information about a dynamic field

{
     id: string
     The database key
 
     name: string
     The dynamic field's display name
 
     annotation: string
     Notes, comments, description, explanation
 
     assignmentMechanism: string
     The assignment mechanism for dynamic field
 
     autoGroupFlag: boolean
     For a device dynamic field, whether or not devices are auto-grouped based on this field's value
 
     displayInListsFlag: boolean
     Whether or not this dynamic field is displayed as a column in the component list
 
     enabledFlag: boolean
     Whether or not the dynamic field is enabled
 
     filterableFlag: boolean
     Whether or not components can be filtered by this dynamic field's value
 
     component: string
     The component
 
     valueType: string
     The type of values that can be assigned
}

DynamicFieldValueDTO

 A dynamic field value

{
     id: string
     The database key of the dynamic field whose value this is (read-only)
 
     name: string
     The name of the dynamic field (read-only)
 
     values: [
       The value(s) for the dynamic field; for a single-value field, only the first entry is relevant; read-only for Auto Derived and Configuration Profiled types
 
       string
     ]
 
     dynamicFieldDetailsLink: string
     Link to get more detailed information about the dynamic field (read-only)
}

EmailActionDTO

 Settings for executing a send email action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$EmailActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     attachedReportParameters: #EmailedReportParametersDTO
     When attaching a report, parameters specific to the type of report
 
     attachmentFormatId: integer
     The format of an attached report (CSV, HTML, PDF, or RTF)
 
     attachmentIncludedFlag: boolean
     Whether or not a report is attached to the email
 
     containsUnresolvableRecipientsFlag: boolean
     Indicates that one or more email distribution lists and/or users no longer exist; re-using this action will result in fewer email recipients (read-only)
 
     detailsIncludedFlag: boolean
     Whether or not an attached report includes additional sub-reports for all its details
 
     hideCsvHeaderFooterFlag: boolean
     Whether or not an attached CSV-formatted report includes headers and footers that are not strictly part of the column-oriented report data
 
     linkIncludedFlag: boolean
     Whether or not the email includes a link to a report
 
     sensitiveDataHiddenFlag: boolean
     Whether or not sensitive data is hidden in any attached report
 
     subject: string *
     The subject of the email message
 
     text: string *
     The text that appears in the body of the email message
 
     toAdhocAddresses: [
       Any ad-hoc email addresses of the other interested recipients of the email
 
       string
     ]
 
     toEmailListIds: [
       Any email distribution lists to receive the email
 
       #ComponentId
     ]
 
     toUserIds: [
       Any users to receive the email
 
       #ComponentId
     ]
}

EmailDistributionListDTO

 Information about an email distribution list

{
     id: string
     The database key
 
     name: string
     The email distribution list's unique display name
 
     addresses: [
       The email addresses that make up this list
 
       string
     ]
 
     dynamicFields: [
       The dynamic fields
 
       #DynamicFieldValueDTO
     ]
}

EmailNotificationParametersDTO

 Settings for sending emails on job state changes as a job executes

{
     jobStateIds: [
       The job states of interest; the trap is sent when the job enters any of these states
 
       integer
     ] *
 
     emailApproverFlag: boolean
     Whether or not the job state change email should be sent to the user(s) who can approve the job
 
     emailCreatorFlag: boolean
     Whether or not the job state change email should be sent to the user who created the job
 
     emailOtherFlag: boolean
     Whether or not the job state change email should be sent to users other than the creator or approvers
 
     jobDetailsAttachmentIncludedFlag: boolean
     Whether or not the email includes an attached job details
 
     jobDetailsLinkIncludedFlag: boolean
     Whether or not the email includes a link to access the job details web page
 
     jobDetailsAllDetailsIncludedFlag: boolean
     Whether or not an attached job details includes all details (that is, device interaction transcripts)
 
     emailedJobDetailsAttachmentFormatId: integer
     The format of an attached job details (HTML, PDF, or RTF)
 
     jobSummaryAttachmentIncludedFlag: boolean
     Whether or not the email includes an attached job summary report
 
     jobSummaryLinkIncludedFlag: boolean
     Whether or not the email includes a link to access the job summary report web page
 
     emailedJobSummaryAttachmentFormatId: integer
     The format of an attached job summary report (HTML, PDF, or RTF)
 
     showJobSummaryById: integer
     When including the link to a job summary report, how the generated report is to be oriented (by job ID, by change ID, or by task ID)
 
     toAdhocAddresses: [
       When emailing to others, any ad-hoc email addresses of the other interested recipients of the email
 
       string
     ]
 
     toEmailListIds: [
       When emailing to others, any email distribution lists to receive the email
 
       #ComponentId
     ]
 
     toEmailListsDetailsLinks: [
       When emailing to others, links to get more detailed information about the email distribution lists (read-only)
 
       string
     ]
 
     toUserIds: [
       When emailing to others, any users to receive the email
 
       #ComponentId
     ]
 
     toUsersDetailsLinks: [
       When emailing to others, links to get more detailed information about the users (read-only)
 
       string
     ]
}

EmailedReportParametersDTO

EndpointActionResultDTO

 Results from executing an endpoint action

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job (or in the owning action, when this is a sub-action)
 
     guid: string
     The GUID that identifies the type of action
 
     name: string
     The type of action referred to by the GUID
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action
 
     startTimestamp: date-time
     When the action execution began
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed
 
     aclLabels: [
       Any ACLs modified by the action; will be null/empty when no ACLs were modified
 
       string
     ]
 
     endpointMacAddress: string
     The discovered ethernet MAC address of the endpoint
 
     endpointPortLocation: string
     The port the endpoint was seen on within the managing switch
 
     endpointPortType: string
     For an IOS switch, the type of port that the endpoint was seen on
 
     managingSwitchDeviceId: string
     The database key of the device that is the endpoint's managing switch
 
     managingSwitchName: string
     The name of the device that is the endpoint's managing switch
 
     tracerouteErrorText: string
     Any output to stderr emitted by the traceroute command
 
     tracerouteExitCode: integer
     The exit code of the traceroute command
 
     tracerouteManagingRouterAddress: string
     The IP address of the router nearest to the endpoint, as discovered by running the traceroute command
 
     tracerouteOutputText: string
     Any output to stdout emitted by the traceroute command
 
     tracerouteException: string
     Any unexpected error that occurred while running the traceroute command
 
     vlanMap: string
     Name of the VLAN map on which the ACL(s) was applied; will be null/empty when no VLAN map was modified
 
     vlanNumber: integer
     VLAN number on which the ACL(s) were applied; will be null/empty when no ACL was applied
}

EntityDTO

 A hardware component within the hardware inventory

{
     name: string
     The name of the component
 
     descr: string
    {{ The description of the component}}
 
     pid: string
     The product id or part number
 
     vid: string
     The version id
 
     sid: string
     The serial number
}

EventActionDTO

 Settings for executing a log event action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$EventActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
}

ExternalScriptActionDTO

 Settings for executing an external script action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$ExternalScriptActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     adhocTemplate: #AdhocTemplateDTO
     Any template that is passed to the script as a file
 
     continueOnFailureFlag: boolean
     Whether or not to continue sequential execution per device when script execution encounters an error
 
     runtimeProperties: {
       Name/value pairs for any runtime parameters, for substitution into the script execution command line; this is a map where the key is the property name string and the value is the property value string; the use of a shared runtime parameter (in a predefined job) is indicated by a value in the form "sharedRuntimeParam." followed by the name of the shared runtime parameter
     }
 
     spanParams: #SpanParamsDTO
     Any selected network span
}

ExternalScriptActionResultDTO

 Results from executing an external script action

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job (or in the owning action, when this is a sub-action)
 
     guid: string
     The GUID that identifies the type of action
 
     name: string
     The type of action referred to by the GUID
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action
 
     startTimestamp: date-time
     When the action execution began
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed
 
     transcript: string
     When script was not run per-device, contains the transcript of the script's single execution, in an XML format containing stdout and stderr
}

FailedRuleDTO

 Information about a rule the device is violating

{
     date: date-time
     Date/time when the rule was checked and found to be in violation
    Example: 2017-01-31T13:45:00.000+0000
 
     ruleId: string
     The rule's unique database key
 
     ruleDetailsLink: string
     Link to get complete details about the rule
 
     correctableFlag: boolean
     Whether or not the rule can be corrected
}

FindEndpointActionDTO

 Settings for executing a find endpoint action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$FindEndpointActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     boundingSpanParams: #SpanParamsDTO *
     The bounding network span, within which the search is to be limited
 
     endpointAddress: string *
     The address to be located
}

GetNextSwitchResultsDTO

 Results of executing an action that locates an endpoint

{
     endpointMacAddress: string
     Ethernet MAC address of the endpoint, in the form 'xxxx.xxxx.xxxx'; populated if the MAC address was first discovered by this device action; will be null if it was already known from a previous device action
 
     endpointPortLocation: string
     The port the endpoint was seen on within this switch
 
     endpointPortType: string
     For an IOS switch, the type of port that the endpoint was seen on (for example, Ethernet, FastEthernet, GigabitEthernet)
 
     nextSwitchAddress: string
     IP address of the next switch for reaching the endpoint; will be null/empty when this switch is the endpoint's closest managing switch
}

GroupDTO

 Details about a group

{
     id: string
     The group's unique database key (read-only)
 
     name: string *
     The group's display name
 
     realmId: string *
     The database key of the realm this group belongs to
 
     realmDetailsLink: string
     Link to get complete details about the parent realm (read-only)
 
     autoGroupFlag: boolean
     Whether or not this group is an auto-group (read-only)
 
     dynamicFields: [
       The dynamic fields
 
       #DynamicFieldValueDTO
     ]
 
     memberDevicesLink: string
     Link to get a list of the member devices (read-only)
}

HardwareInventoryDTO

 A device's hardware inventory

{
     created: date-time
     Time this inventory was created or last updated
    Example: 2017-01-31T13:45:00.000+0000
 
     importedInventory: string
     Inventory imported from an external element manager
 
     entities: [
       Hardware components reported in 'show inventory' command
 
       #EntityDTO
     ]
 
     fileSystems: [
       Data reported in 'dir all-filesystems' command
 
       #StorageDTO
     ]
 
     memories: [
       Data reported in 'show memory statistics' command
 
       #StorageDTO
     ]
}

IOSHardwareInventoryFilterDTO

 Criteria for filtering against a device's hardware inventory

{
     entityNameMatch: string
     Search for devices matching this wildcard-enabled hardware entity name
 
     entityDescrMatch: string
     Search for devices matching this wildcard-enabled hardware entity descr
 
     entityPidMatch: string
     Search for devices matching this wildcard-enabled hardware entity PID
 
     entityVidMatch: string
     Search for devices matching this wildcard-enabled hardware entity VID
 
     entitySnMatch: string
     Search for devices matching this wildcard-enabled hardware entity SN
 
     fileSystemFreeSizeIntegerRange: string
     Search for devices with a file system free size matching this range specification
 
     fileSystemNameMatch: string
     Search for devices matching this wildcard-enabled file system name
 
     fileSystemTotalSizeIntegerRange: string
     Search for devices with a file system total size matching this range specification
 
     memoryNameMatch: string
     Search for devices matching this wildcard-enabled memory name
 
     memorySizeIntegerRange: string
     Search for devices with a memory size matching this range specification
}

JobApprovalDTO

 An approval that has been made to a job

{
     message: string
     The explanation, notes, or comments for this approval
 
     timestamp: date-time
     The time at which this approval was made
    Example: 2017-01-31T13:45:00.000+0000
 
     username: string
     The user who made this approval
}

JobApprovalStatusDTO

 The approvals that have been made to a job

{
     approvals: [
       The approvals that have been made; null means no approvals have been made
 
       #JobApprovalDTO
     ]
 
     externalApprovalObtainedTimestamp: date-time
     The time at which an external approval was obtained; null means no such approval is needed or it is still pending
    Example: 2017-01-31T13:45:00.000+0000
}

JobApprovalTypeDTO

 Details about a job approval type

{
     name: string
     The unique identifying name
 
     accessibleToUserNames: [
       The users allowed to use this job approval type on jobs they submit; when accessible users and roles are both null, this job approval type is accessible to all
 
       string
     ]
 
     accessibleToRoleNames: [
       The roles allowed to use this job approval type on jobs they submit; when accessible users and roles are both null, this job approval type is accessible to all
 
       string
     ]
 
     approvalSteps: [
       Who must approve and in what order
 
       #ApprovalStepDTO
     ]
 
     methodName: string
     What sort of approval process is required
 
     sendEmailFlag: boolean
     Whether or not to send an email to the users when their approval is pending for a job
 
     externalApprovalRequiredFlag: boolean
     Whether or not approval is required from an external change management system
 
     dynamicFields: [
       The dynamic fields
 
       #DynamicFieldValueDTO
     ]
}

JobDTO

 Fully detailed information about a job

{
     id: string
     The job's unique database key (read-only)
 
     jobID: string
     The job's unique ID (read-only)
 
     changeID: string
     The optional change ID, for mapping into any external change management system
 
     taskID: string
     The optional task ID, for mapping into any external change management system
 
     approvalStatus: #JobApprovalStatusDTO
     The approvals that have been made (read-only)
 
     jobApprovalType: #JobApprovalTypeDTO
     The approvals that are required (read-only)
 
     statusHistory: [
       The history of job state transitions; the last or most recent entry is the current state (read-only)
 
       #JobStatusDTO
     ]
 
     includeDebugTraceFlag: boolean
     Whether or not to include debugging or processing trace messages in device interaction transcripts
 
     loginUsername: string
     Username for logging in to devices
 
     loginPassword: string
     Password for logging in to devices
 
     privilegedUsername: string
     Privileged username for logging in to devices
 
     privilegedPassword: string
     Privileged password for logging in to devices
 
     originatorTypeId: integer
     The type of the originator (read-only)
 
     originator: string
     The originating user name or policy name (read-only)
 
     reconciliationTimestamp: date-time
     When the job was reconciled (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     reconciliationErrorMsg: string
     Any error message from a failed reconciliation (read-only)
 
     reconciliationStatusId: integer
     Whether or not the job has been reconciled (read-only)
 
     runAtTimestamp: date-time
     When the job is to execute; null means now or when approved
    Example: 2017-01-31T13:45:00.000+0000
 
     skipRemainingActionsOnErrorFlag: boolean
     Whether or not remaining actions should be skipped once an action encounters an error
 
     triggeringEventSummary: string
     Any event that caused this job to be created/executed by an event-based policy (read-only)
 
     emailParams: #EmailNotificationParametersDTO
     Any parameters for sending an email as a notification that the job has changed its state
 
     snmpTrapParams: #SnmpTrapNotificationParametersDTO
     Any parameters for sending an SNMP trap as a notification that the job has changed its state
 
     dynamicFields: [
       The dynamic fields
 
       #DynamicFieldValueDTO
     ]
 
     actions: [
       The actions, ordered in execution order
 
       #ActionDTO
     ] *
 
     submissionLink: string
     Link to submit a draft job for execution (read-only)
 
     desubmissionLink: string
     Link to cancel a scheduled execution and make the job editable again (that is, re-draft; read-only)
 
     cancellationLink: string
     Link to cancel a scheduled execution or abort an executing job (read-only)
 
     approvalLink: string
     Link to approve the job (read-only)
 
     rejectionLink: string
     Link to reject the job (read-only)
 
     deviceResultsLink: string
     Link to retrieve device results (read-only)
}

JobParametersDTO

 Parameters for preparing a job from a predefined job; supplies values for various selections deferred in the predefined job, and values specific to jobs not part of predefined jobs; the job is otherwise populated with values copied from the predefined job

{
     changeID: string
     The optional change ID, for mapping into any external change management system
 
     includeDebugInTranscriptsFlag: boolean
     Whether or not to include debug trace messages in the device communication transcripts generated by device actions executed by the job
 
     networkSpans: {
       The selected network spans, for those actions whose span selection is deferred until runtime; map key is the spanParams.promptForSpanAtRuntime string (case sensitive); map value is the database key string(s) of the selected network span (which can be a single realm/group/device or multiple devices)
     }
 
     networkSpanFilters: {
       Any device filters to be applied to the selected network spans; map key is the spanParams.promptForSpanAtRuntime string (case sensitive); map value is the DeviceFilterDTO containing the filter criteria; applicable to realms and groups only
     }
 
     runAtTimestamp: date-time
     When the job is to execute; null means now or when approved
    Example: 2017-01-31T13:45:00.000+0000
 
     sharedRuntimeParameters: {
       The values for the predefined job's shared runtime parameters; map key is the shared runtime parameter name string; map value is a text string; must supply a value for every shared runtime parameter referenced by the actions (the system will not fill in defaults for you; a value can be null); note that password values should be provided in clear text
     }
 
     taskID: string
     The optional task ID, for mapping into any external change management system
}

JobStatusDTO

 A job state transition

{
     annotation: string
     The annotation or reason, present only when the user approves, rejects, aborts, or cancels a job
 
     originator: string
     The name of the user or policy that caused the job to move into this state
 
     timestamp: date-time
     The time at which this state was initiated
    Example: 2017-01-31T13:45:00.000+0000
 
     stateId: integer
     The state of the job at the timestamp
}

JsonPatch

 Click here to expand...

{
}

MarkAsTrustedActionDTO

 Settings for executing a mark as trusted action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$MarkAsTrustedActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     useAuxiliaryInterfaceFlag: boolean
     Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
     spanParams: #SpanParamsDTO *
     The selected network span
 
     cfgTimestamp: date-time
     Selects the configuration(s) active at this date and time to be the new trusted configuration(s); null when cfgId is set
    Example: 2017-01-31T13:45:00.000+0000
 
     cfgId: #ComponentId
     Identifies Which one running or startup configuration is to be marked as the trusted configuration; null when cfgTimestamp is set; note that this identifier is not portable across different BMC Network Automation servers
 
     containsUnresolvableConfigurationFlag: boolean
     Indicates that the selected single configuration no longer exists and thus re-using this action is not possible (read-only)
 
     currentFlag: boolean
     Whether or not the current running and/or startup configuration is to be marked as trusted; when false, a cfgTimestamp or cfgId must be provided to select the configuration(s)
 
     runningTrailFlag: boolean
     Whether or not a running configuration is to be marked as trusted
 
     startupTrailFlag: boolean
     Whether or not a startup configuration is to be marked as trusted
}

ModelDTO

 Information about a model, as discovered while accessing devices

{
     id: string
     The database key
 
     name: string
     The model name, unique within a vendor
 
     vendorGuid: string
     The GUID of the vendor associated with this model
 
     vendorName: string
     The name of the vendor associated with this model
}

NestedBlockDTO

 Specifies the boundaries of a block

{
     begin: string *
     The line that a block begins with
 
     end: string *
     The line that a block, beginning with the 'begin' line, ends with
}

NumericCriteriaDTO

 How a numeric value parsed out of a configuration line is compared

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.RuleService$NumericCriteriaDTO"

{
     max: string
     Number at the upper bound of valid values; string to allow use of substitution parameters
 
     min: string
     Number at the lower bound of valid values; string to allow use of substitution parameters
 
     notFlag: boolean
     For the "is" vs "is not" selection; true for "is not"
 
     operatorId: integer *
     How numbers are compared; valid values are the integer operators (except not "Not Equal To")
}

OsFileDTO

 Information about an operating system binary file

{
     imageTypeName: string
     What type of binary file this is, when a device supports multi-file images
 
     name: string
     The name of the file
 
     sizeBytes: integer
     The size of the file in bytes
 
     messageDigest: string
     The MD5 checksum or digest
}

OsImageDTO

 Information about an operating system image

{
     id: string
     The database key
 
     name: string
     The OS image's display name; null/empty when this image has not been verified as having run on a device
 
     deviceTypeGuid: string
     Which device type this OS image applies to
 
     deviceTypeName: string
     The name of the device type
 
     vendorGuid: string
     Which vendor owns the associated device type
 
     vendorName: string
     The name of the vendor
 
     forbidDeploymentFlag: boolean
     Whether or not this OS image is allowed to be deployed
 
     annotation: string
     Notes, comments, description, explanation
 
     memoryFootprintBytes: integer
     Bytes of memory this image consumes; a zero indicates this value is not used by the device
 
     activationKey: string
     License key to activate features in the binary image on the device
 
     files: [
       The binary files; null/empty when no image snapshot has been taken from a device running this image, or user has not supplied any files
 
       #OsFileDTO
     ]
 
     modelNames: [
       The models where this image can be deployed
 
       string
     ]
 
     dynamicFields: [
       The dynamic fields
 
       #DynamicFieldValueDTO
     ]
}

OsImageLoadHistoryDTO

 Information about an OS image discovered to be running on the device

{
     date: date-time
     Date/time this OS image was discovered or deployed
    Example: 2017-01-31T13:45:00.000+0000
 
     filename: string
     The image file name
 
     imageName: string
     The image name
 
     username: string
     The user who deployed this image
}

PassedRuleDTO

 Information about a rule with which the device is compliant

{
     date: date-time
     Date/time when the rule was checked and found to be compliant
    Example: 2017-01-31T13:45:00.000+0000
 
     ruleId: string
     The rule's unique database key
 
     ruleDetailsLink: string
     Link to get complete details about the rule
}

PredefinedJobDTO

 Fully detailed information about a predefined job

{
     id: string
     The predefined job's unique database key (read-only)
 
     name: string *
     The predefined job's unique name
 
     skipRemainingActionsOnErrorFlag: boolean
     Whether or not remaining actions should be skipped once an action encounters an error in a prepared job
 
     jobIds: [
       The jobs (by job ID) that have been prepared from this predefined job (read-only)
 
       string
     ]
 
     sharedRuntimeParameters: [
       The shared runtime parameters
 
       #SharedRuntimeParameterDTO
     ]
 
     emailParams: #EmailNotificationParametersDTO
     Any parameters for sending an email as a notification that a prepared job has changed its state
 
     snmpTrapParams: #SnmpTrapNotificationParametersDTO
     Any parameters for sending an SNMP trap as a notification that a prepared job has changed its state
 
     dynamicFields: [
       The dynamic fields
 
       #DynamicFieldValueDTO
     ]
 
     actions: [
       The actions, ordered in execution order
 
       #ActionDTO
     ] *
 
     prepareJobLink: string
     Link to prepare a job from this predefined job (read-only)
}

PurgeCriteriaDTO

 Settings that control purging

{
     purgeByCountFlag: boolean
     Whether or not to purge by count
 
     purgeCount: integer
     The number of entities to be retained before the oldest are purged away
 
     purgeByDaysFlag: boolean
     Whether or not to purge by age
 
     purgeDays: integer
     The number of days an entity can age before it is purged away
}

QuarantineEndpointActionDTO

 Settings for executing a quarantine endpoint action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$QuarantineEndpointActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     boundingSpanParams: #SpanParamsDTO *
     The bounding network span, within which the search for the endpoint is to be limited
 
     changeVlanOfSharedPortFlag: boolean
     Whether or not to proceed with changing VLAN membership of the endpoint's switch port when the switch has seen traffic with other endpoints on the same port; when false, changing VLAN membership of the shared port is skipped
 
     commitFlag: boolean
     Whether or not to commit changes after performing the quarantine operation
 
     disableSharedPortFlag: boolean
     Whether or not to proceed with disabling of the endpoint's switch port when the switch has seen traffic with other endpoints on the same port when false, the disabling of the shared port is skipped
 
     endpointAddress: string *
     The address to be located and quarantined
 
     markAsTrustedFlag: boolean
     Whether or not any changed configurations resulting from running this action should be marked as trusted
 
     quarantineIsolationLevelId: integer *
     How the quarantine is to be effected
 
     remediationAddress: string
     IP address or host name of a server that will be allowed to talk to the endpoint after it is quarantined, for remediation purposes
 
     remediationVlan: string
     A network from which the endpoint can be accessed after it is quarantined, for remediation purposes
}

RealmDTO

 Details about a realm

{
     id: string
     The realm's unique database key (read-only)
 
     name: string *
     The realm's unique name
 
     fallbackConfigsPurgeCriteria: #PurgeCriteriaDTO
     Fallback purge criteria for device configurations (those configurations not covered by the per-trail or per-device-type purge criteria)
 
     hardwareInventoryPurgeCriteria: #PurgeCriteriaDTO
     Purge criteria for device hardware inventory
 
     purgeConfigsByDeviceTypes: {
       Per-device-type device configuration purge criteria; this is a map where the key is a device type GUID string and the value is a PurgeCriteriaDTO
     }
 
     purgeConfigsByTrails: {
       Per-trail device configuration purge criteria; this is a map where the key is a configuration trail GUID string and the value is a PurgeCriteriaDTO
     }
 
     purgeDevicesByDaysFlag: boolean
     Whether or not to purge (automatically delete) devices that are flagged as offline
 
     purgeDevicesDays: integer
     Number of days a device can be offline before it is purged away (automatically deleted from the system)
 
     dynamicFields: [
       The dynamic fields
 
       #DynamicFieldValueDTO
     ]
}

RebootActionDTO

 Settings for executing a reboot action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$RebootActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     useAuxiliaryInterfaceFlag: boolean
     Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
     spanParams: #SpanParamsDTO *
     The selected network span
 
     markAsTrustedFlag: boolean
     Whether or not any changed configurations resulting from running this action should be marked as trusted
 
     rebootTypeId: integer *
     How to handle unsaved changes prior to rebooting
}

RefreshDeviceStatusActionDTO

 Settings for executing a refresh device status action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$RefreshDeviceStatusActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     useAuxiliaryInterfaceFlag: boolean
     Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
     spanParams: #SpanParamsDTO *
     The selected network span
 
     offlineCheckDays: integer
     Number of days a device must be offline before it is deleted, when performing the offline device check
 
     runComplianceCheckFlag: boolean
     Whether or not to refresh device compliance status
 
     runDeviceAttributesGenerationFlag: boolean
     Whether or not to generate fresh device attribute configurations
 
     runDiscrepancyCheckFlag: boolean
     Whether or not to refresh device discrepancy status
 
     runOfflineCheckFlag: boolean
     Whether or not to check for devices that have been offline for too long, and to delete those that exceed the offlineCheckDays
 
     runProfileCheckFlag: boolean
     Whether or not to refresh configuration attribute profiled dynamic fields
}

RemediateActionDTO

 Settings for executing a remediate action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$RemediateActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     useAuxiliaryInterfaceFlag: boolean
     Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
     spanParams: #SpanParamsDTO *
     The selected network span
 
     collapseSubactionsFlag: boolean
     Whether or not identical generated sub-actions are collapsed into a minimal set of unique sub-actions, to reduce device access overhead; true is the recommended value
 
     scriptParams: #ScriptParamsDTO *
     Which rule(s) and/or rule set(s) are to be remediated
}

RemoteFileServerDTO

 Information about a remote file server

{
     id: string
     The database key
 
     name: string
     The remote file server's unique display name
 
     address: string
     The IP address or host name of the remote system
 
     dynamicFields: [
       The dynamic fields
 
       #DynamicFieldValueDTO
     ]
}

RuleDTO

 Details about a rule

{
     id: string
     The database key
 
     name: string *
     The rule's display name
 
     activationDate: date-time
     When the rule starts to be active
    Example: 2017-01-31T13:45:00.000+0000
 
     annotation: string
     Notes, comments, description, explanation
 
     applicableModelIds: [
       Which models this rule is applied to; when null or empty, the rule applies to all models
 
       #ComponentId
     ]
 
     applicableSecurityContextTypeId: integer
     The types of security contexts this rule applies to
 
     applicableTrailGuids: [
       The GUID(s) of the configuration trails this rule applies to
 
       string
     ] *
 
     correctableFlag: boolean
     Whether or not this rule is correctable (read-only)
 
     correctiveActions: {
       How a rule violation can be corrected; map key is the configuration trail GUID; map value is a CorrectiveSpanActionDTO that applies a correction to the configuration that is in violation, resulting in the violation being cleared
     }
 
     cveIDs: [
       Associated security vulnerability CVE ID(s): when the rule is associated with a security vulnerability, this is read-only
 
       string
     ]
 
     deactivationDate: date-time
     When the rule stops being active
    Example: 2017-01-31T13:45:00.000+0000
 
     deviceTypeGuid: string
     Which device type this rule applies to; null means it applies to all device types
 
     domain: #DomainDTO *
     What part of the configuration is to be examined
 
     excludedGroupFilters: {
       The names of any groups whose member devices are excluded from being checked against this rule; map key is the name of the group (asterisk wildcards allowed); map value is a list of ComponentId containing the realm(s) that own the groups of interest (where a null value means all realms)
     }
 
     excludedSpanIds: [
       Any network spans whose member devices are excluded from being checked against this rule
 
       #ComponentId
     ]
 
     maxRelease: string
     The maximum OS version, for when this rule applies to a min/max range of operating system versions
 
     minRelease: string
     The minimum OS version, for when this rule applies to a min/max range of operating system versions
 
     osImageNamePatterns: [
       The regular expressions for matching on OS version names, when this rule applies to a discrete set of images
 
       string
     ]
 
     ruleSetId: #ComponentId *
     Identifies the owning rule set
 
     ruleSetDetailsLink: string
     Link to get complete details about the owning rule set (read-only)
 
     securityVulnerabilityId: #ComponentId
     Identifies any security vulnerability associated with this rule
 
     severityId: integer *
     The violation severity
 
     subject: #SubjectDTO *
     What content is to be verified in the configuration, that determines the presence of a violation
 
     substitutionParameterCheckFlag: boolean
     Whether or not the trigger, domain and subject are to be validated for proper substitution parameter syntax
 
     trigger: #TriggerDTO
     Content that must appear in the configuration in order for this rule to be applied
 
     dynamicFields: [
       The dynamic fields
 
       #DynamicFieldValueDTO
     ]
}

RuleFilterDTO

 Criteria for filtering rules; discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$RuleFilterDTO"

{
     dynamicFieldFilters: {
       Any filters on dynamic fields; this is a map where the map key is the filter string (the value to be matched) and the map value is a ComponentId that identifies the dynamic field; menu-type dynamic fields support only exact matching; the filter string must be formatted properly when the dynamic field is a Date or Integer type
     }
 
     containsUnresolvableDynamicFieldFiltersFlag: boolean
     Indicates that one or more of the dynamic fields being filtered on no longer exists and thus re-using this filter may not result in the same outcome (read-only)
 
     activationTimePeriod: string
     Search for rules whose activation date matches this criteria
 
     contentsMatch: string
     Search for rules whose trigger, subject, or domain contains text that matches this wildcard-enabled string
 
     cveIDs: [
       Search for rules whose associated CVE IDs include one of these CVE IDs
 
       string
     ]
 
     deactivationTimePeriod: string
     Search for rules whose deactivation date matches this criteria
 
     deviceTypeGuid: string
     Search for rules with this device type
 
     excludeRulesWithAllDeviceTypesFlag: boolean
     When searching for rules of a particular device type, whether or not rules associated with all device types are included in what matches or are excluded
 
     ruleNameMatch: string
     Search for rules whose name matches this wildcard-enabled string
 
     ruleSetNameMatch: string
     Search for rules whose parent rule set name matches this wildcard-enabled string
 
     severityIds: [
       Search for rules whose severity matches one of these severities
 
       integer
     ]
 
     vendorGuid: string
     Search for rules whose device type belongs to this vendor
}

RuleSetDTO

 Details about a rule set

{
     id: string
     The database key
 
     name: string *
     The rule set's unique display name
 
     assignedGroupFilters: {
       The names of any groups whose member devices are to be checked against the rules in this rule set; map key is the name of the group (asterisk wildcards allowed); map value is a list of ComponentId containing the realm(s) that own the groups of interest (where a null value means all realms); null when the rule set applies to the entire network
     }
 
     assignedSpanIds: [
       The network spans whose member devices are to be checked against the rules in this rule set; null when the rule set applies to the entire network
 
       #ComponentId
     ]
 
     assignedToEntireNetworkFlag: boolean
     Whether or not the rules in this rule set are to be applied to all devices in the system
 
     enabledFlag: boolean
     Whether or not the rule set is enabled
 
     excludedGroupFilters: {
       The names of any groups whose member devices are excluded from being checked against all of the rules in this rule set; map key is the name of the group (asterisk wildcards allowed); map value is a list of ComponentId containing the realm(s) that own the groups of interest (where a null value means all realms)
     }
 
     excludedSpanIds: [
       Any network spans whose member devices are excluded from being checked against all of the rules in this rule set
 
       #ComponentId
     ]
 
     dynamicFields: [
       The dynamic fields
 
       #DynamicFieldValueDTO
     ]
}

ScriptParamsDTO

 Parameters that select a script or configuration

{
     adhocTemplate: #AdhocTemplateDTO
     When the selected script type is ad-hoc template, this is the template
 
     cfgTimestamp: date-time
     When the selected script type is historical, this selects the configuration active at this date/time
    Example: 2017-01-31T13:45:00.000+0000
 
     componentIds: [
       When the selected script type is template, this contains the identifier of the template; when the script type is 'remediate with...', this contains the identifiers of the rule(s) and/or rule set(s); when the script type is a selected single configuration, this contains the identifier of the configuration
 
       #ComponentId
     ]
 
     ignoreRuleConflictsFlag: boolean
     When remediating multiple rules, whether or not to ignore conflicts in the corrections made to the same device by different rules; ignored when not performing remediattion
 
     ruleFilter: #RuleFilterDTO
     When remediating with all assigned, selects which rules are selected for remediation
 
     runtimeProperties: {
       When the selected script type is template, and the template contains runtime substitution parameters, this contains the name/value pairs for those parameters; this is a map where the key is the property name string and the value is the property value string; the use of a shared runtime parameter (in a predefined job) is indicated by a value in the form "sharedRuntimeParam." followed by the name of the shared runtime parameter
     }
 
     scriptTypeId: integer *
     The selected script or configuration type
 
     selectedTrailGuids: [
       When the selected script type is other trails, this specifies the trails
 
       string
     ]
 
     unresolvableComponents: string
     Indicates that a selected template, configuration, rule, and/or rule set no longer exist; this field contains a summary of all the original selections; componentIds contains only the components still present in the database; re-using this action may not be possible or may not result in the same outcome
}

SearchStringDTO

 Defines a string to be searched for

{
     regexFlag: boolean
     Whether or not the 'string' represents a regex pattern (true) or an exact complete line (false)
 
     string: string *
     Text for matching against a configuration line
}

SecurityVulnerabilityDTO

 Information about a security vulnerability

{
     id: string
     The database key
 
     securityVulnerabilityID: string
     The unique identifying tag assigned by the vendor
 
     affectedOsVersions: [
       The operating system versions which are vulnerable
 
       string
     ]
 
     affectedProducts: [
       The models or product lines which are vulnerable
 
       string
     ]
 
     associatedRuleNames: string
     The rules generated from this vulnerabilty or manually associate with it
 
     baseScore: float
     The severity of this vulnerabilty, per the Common Vulnerability Scoring System (CVSS)
 
     created: date-time
     When this vulnerability was first added to the system
 
     cveIDs: string
     The IDs back into the central CVE database
 
     descriptions: [
       Longer description or explanation of the issue
 
       string
     ]
 
     deviceTypes: [
       Device type name(s) or GUID(s) associated with the affected products and OS versions
 
       string
     ]
 
     initialRelease: date-time
     When this vulnerability was first released
 
     lastImported: date-time
     When this vulnerability was last updated via import into the system
 
     notificationUrl: string
     The URL to the vendor's site with more details about this vulnerability
 
     remediations: [
       What a user can do to fix or alleviate or avoid this vulnerability
 
       string
     ]
 
     status: string
     Status of the vulnerability, which indicates if future updates are likely or not (i.e. "Final" means no more updates)
 
     title: string
     The short summary of this vulnerability
 
     unenforceableVersions: [
       OS versions that lack any sort of version number and cannot be turned into an applicable OS image name pattern in a rule
 
       string
     ]
 
     vendorGuid: string
     The GUID of the vendor that originated this vulnerability
 
     vendorName: string
     The name of the vendor that originated this vulnerability
 
     version: string
     The version of this vulnerability
}

SharedRuntimeParameterDTO

 A shared runtime parameter, that defines a runtime parameter whose value can be used in multiple actions

{
     name: string *
     The shared runtime parameter's name, unique within the predefined job
 
     defaultValue: string
     The default value; note that Menu-type parameters have no default value; note that Password-type parameters have a clear text value
 
     menuOptions: [
       When type is Menu, the menu options, in the order they are presented when preparing a job through the user interface; required when type is Menu
 
       string
     ]
 
     type: string *
     What type of data can be entered into the value for this parameter (Integer, Menu, Password, or Text)
}

SnapshotActionDTO

 Settings for executing a snapshot action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$SnapshotActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     useAuxiliaryInterfaceFlag: boolean
     Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
     spanParams: #SpanParamsDTO *
     The selected network span
 
     markAsTrustedFlag: boolean
     Whether or not any changed configurations resulting from running this action should be marked as trusted
}

SnapshotOsImageActionDTO

 Settings for executing a snapshot OS image action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$SnapshotOsImageActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     useAuxiliaryInterfaceFlag: boolean
     Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
     spanParams: #SpanParamsDTO *
     The selected network span
 
     parallelExecutionFlag: boolean
     When true, runs this action on multiple devices concurrently; When false, runs this action on multiple devices one by one sequentially (to reduce memory overhead due to large or identical images)
 
     transferModeId: integer
     When using remote image file servers, selects which file transfer mode is used
 
     useRemoteImageFileServerFlag: boolean
     Whether or not to deposit the images to a remote file server; when false, saves images to the database; when true, saves images to the remote image file server associated with each device
}

SnmpManagerStationDTO

 Information about an SNMP manager station

{
     id: string
     The database key
 
     address: string
     The address of the SNMP manager
 
     port: string
     The port where the SNMP manager listens for traps
 
     trapCommunity: string
     The trap community accepted by the SNMP manager
 
     versionName: string
     The SNMP version
 
     dynamicFields: [
       The dynamic fields
 
       #DynamicFieldValueDTO
     ]
}

SnmpTrapNotificationParametersDTO

 Settings for sending SNMP traps on job state changes as a job executes

{
     annotation: string
     Notes or comments to include in the SNMP trap
 
     jobStateIds: [
       The job states of interest; the SNMP trap is sent when the job enters any of these states
 
       integer
     ] *
 
     destinationSnmpManagerStationIds: [
       The SNMP manager station(s) to be sent the job state change SNMP traps
 
       #ComponentId
     ] *
 
     destinationSnmpManagerStationDetailsLinks: [
       Link to get more detailed information about the SNMP manager stations (read-only)
 
       string
     ]
 
     jobDetailsLinkIncludedFlag: boolean
     Whether or not the SNMP trap includes a link to access the job details web page
 
     jobSummaryLinkIncludedFlag: boolean
     Whether or not the SNMP trap includes a link to access the job summary report web page
 
     showJobSummaryById: integer
     When including the link to a job summary report, how the generated report is to be oriented (by job ID, by change ID, or by task ID)
}

SpanActionDTO

 Settings for executing a span action

Subclasses:
#TelnetSshSessionActionDTO
#ComplianceStatusActionDTO
#DeployToStoredActionDTO
#MarkAsTrustedActionDTO
#CustomActionDTO
#CommitActionDTO
#SnapshotActionDTO
#DeployToActiveActionDTO
#SnapshotOsImageActionDTO
#AssignTargetCfgActionDTO
#SyntaxScanActionDTO
#RefreshDeviceStatusActionDTO
#RebootActionDTO
#DeployOsImageActionDTO
#RemediateActionDTO

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     useAuxiliaryInterfaceFlag: boolean
     Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
     spanParams: #SpanParamsDTO *
     The selected network span
}

SpanParamsDTO

 Parameters that select a network span

{
     deviceFilter: #DeviceFilterDTO
     When the selected network span is a realm, group, or combo group, narrows down which devices in that span are included in the action; ignored when the selected network span is a single device or multiple devices
 
     spanIds: [
       The database key and/or name of the single selected realm, group, combo group, or device; or the database keys and/or names of the multiple selected devices; or, in the case of emailed reports, null to indicate the report is to be generated for the entire network
 
       #ComponentId
     ]
 
     promptForSpanAtRuntime: string
     The text to be displayed when preparing a job from a predefined job that prompts the user to select a network span; when set, then spanIds and deviceFilter are invalid
 
     unresolvableSpanSummary: string
     When getting a job and the network span or one or more devices in a multi-device span have been deleted since the job was executed; contains the name of the network span or the names of all the devices in the multi-device span; re-using this action is not possible (read-only)
}

StorageDTO

 A file system or memory component within the hardware inventory

{
     name: string
     The identifying name
 
     bytesFree: integer
     The number of bytes that are unused
 
     bytesTotal: integer
     The total size of the storage in bytes
 
     bytesUsed: integer
     The number of bytes that are filled up
}

SubjectDTO

 What content is to be verified in the configuration, that determines the presence of a violation

Subclasses:
#SubjectPatternsDTO
#SubjectPatternDTO
#SubjectLinesDTO
#SubjectLineDTO

{
     caseSensitiveFlag: boolean
     Whether or not string matching is case sensitive
 
     frequency: string *
     How many times the specified string(s) can appear within the domain: notAtAll: the string(s) should never appear and the rule is violated if they do; atMostOnce: the string(s) should appear zero or one times and the rule is violated if they appear more; exactlyOnce: the string(s) should appear once and the rule is violated if they appear more; atLeastOnce: the string(s) should appear one or more times and the rule is violated if they are missing
 
     ignoreWhitespaceFlag: boolean
     Whether or not whitespace within configuration lines is ignored
}

SubjectLineDTO

 Specifies that a single exact line is to be checked against the lines in the domain

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.RuleService$SubjectLineDTO"

{
     caseSensitiveFlag: boolean
     Whether or not string matching is case sensitive
 
     frequency: string *
     How many times the specified string(s) can appear within the domain: notAtAll: the string(s) should never appear and the rule is violated if they do; atMostOnce: the string(s) should appear zero or one times and the rule is violated if they appear more; exactlyOnce: the string(s) should appear once and the rule is violated if they appear more; atLeastOnce: the string(s) should appear one or more times and the rule is violated if they are missing
 
     ignoreWhitespaceFlag: boolean
     Whether or not whitespace within configuration lines is ignored
 
     line: string *
     Literal line to look for within the domain
}

SubjectLinesDTO

 Specifies that multiple exact lines are to be checked against the lines in the domain

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.RuleService$SubjectLinesDTO"

{
     caseSensitiveFlag: boolean
     Whether or not string matching is case sensitive
 
     frequency: string *
     How many times the specified string(s) can appear within the domain: notAtAll: the string(s) should never appear and the rule is violated if they do; atMostOnce: the string(s) should appear zero or one times and the rule is violated if they appear more; exactlyOnce: the string(s) should appear once and the rule is violated if they appear more; atLeastOnce: the string(s) should appear one or more times and the rule is violated if they are missing
 
     ignoreWhitespaceFlag: boolean
     Whether or not whitespace within configuration lines is ignored
 
     combinedWithAndFlag: boolean
     Whether or not the lines are combined with the AND operation (true; line one AND line two AND line three, and so on) or with the OR operation (false; line one OR line two OR line three, and so on)
 
     contiguousFlag: boolean
     Whether or not any other non-matching lines from the configuration are allowed to appear interspersed within the matched subject lines
 
     lines: [
       The literal lines to look for within the configuration (in the order the lines are to appear, when the orderedFlag is set)
 
       string
     ] *
 
     orderedFlag: boolean
     Whether or not the lines are matched in order
}

SubjectOrderedVersionDTO

 Specifies that the lines in the domain are matched against a min/max version range; a version string is composed of letter and digit elements, separated by a special character or by a transition between letters and digits

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.RuleService$SubjectOrderedVersionDTO"

{
     caseSensitiveFlag: boolean
     Whether or not string matching is case sensitive
 
     frequency: string *
     How many times the specified string(s) can appear within the domain: notAtAll: the string(s) should never appear and the rule is violated if they do; atMostOnce: the string(s) should appear zero or one times and the rule is violated if they appear more; exactlyOnce: the string(s) should appear once and the rule is violated if they appear more; atLeastOnce: the string(s) should appear one or more times and the rule is violated if they are missing
 
     ignoreWhitespaceFlag: boolean
     Whether or not whitespace within configuration lines is ignored
 
     correction: string
     A literal line to apply as a correction when the subject pattern is not matched as required
 
     pattern: string *
     The regular expression for matching a line within the domain
 
     max: string
     Version at the upper bound of valid values
 
     min: string
     Version at the lower bound of valid values
 
     operatorId: integer *
     How versions are to be compared; valid values are the integer operators (except not "Equal To" and "Not Equal To")
}

SubjectParsedLineDTO

 Specifies that the lines in the domain are matched against a line containing ranges of values

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.RuleService$SubjectParsedLineDTO"

{
     caseSensitiveFlag: boolean
     Whether or not string matching is case sensitive
 
     frequency: string *
     How many times the specified string(s) can appear within the domain: notAtAll: the string(s) should never appear and the rule is violated if they do; atMostOnce: the string(s) should appear zero or one times and the rule is violated if they appear more; exactlyOnce: the string(s) should appear once and the rule is violated if they appear more; atLeastOnce: the string(s) should appear one or more times and the rule is violated if they are missing
 
     ignoreWhitespaceFlag: boolean
     Whether or not whitespace within configuration lines is ignored
 
     correction: string
     A literal line to apply as a correction when the subject pattern is not matched as required
 
     pattern: string *
     The regular expression for matching a line within the domain
 
     comparisonCriteria: [
       How the values within a line are compared
 
       #ComparisonCriteriaDTO
     ] *
}

SubjectPatternDTO

 Specifies that the lines in the domain are matched against a regular expression

Subclasses:
#SubjectParsedLineDTO
#SubjectOrderedVersionDTO

{
     caseSensitiveFlag: boolean
     Whether or not string matching is case sensitive
 
     frequency: string *
     How many times the specified string(s) can appear within the domain: notAtAll: the string(s) should never appear and the rule is violated if they do; atMostOnce: the string(s) should appear zero or one times and the rule is violated if they appear more; exactlyOnce: the string(s) should appear once and the rule is violated if they appear more; atLeastOnce: the string(s) should appear one or more times and the rule is violated if they are missing
 
     ignoreWhitespaceFlag: boolean
     Whether or not whitespace within configuration lines is ignored
 
     correction: string
     A literal line to apply as a correction when the subject pattern is not matched as required
 
     pattern: string *
     The regular expression for matching a line within the domain
}

SubjectPatternsDTO

 Specifies that the lines in the domain are matched against multiple regular expressions

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.RuleService$SubjectPatternsDTO"

{
     caseSensitiveFlag: boolean
     Whether or not string matching is case sensitive
 
     frequency: string *
     How many times the specified string(s) can appear within the domain: notAtAll: the string(s) should never appear and the rule is violated if they do; atMostOnce: the string(s) should appear zero or one times and the rule is violated if they appear more; exactlyOnce: the string(s) should appear once and the rule is violated if they appear more; atLeastOnce: the string(s) should appear one or more times and the rule is violated if they are missing
 
     ignoreWhitespaceFlag: boolean
     Whether or not whitespace within configuration lines is ignored
 
     combinedWithAndFlag: boolean
     Whether or not the patterns are combined with the AND operation (true; pattern one AND pattern two AND pattern three, and so on) or with the OR operation (false; pattern one OR pattern two OR pattern three, and so on)
 
     contiguousFlag: boolean
     Whether or not any other non-matching lines from the configuration are allowed to appear interspersed within the matched subject lines
 
     corrections: [
       The literal lines to apply as corrections when the subject patterns are not matched as required
 
       string
     ]
 
     forceAllCorrectionsFlag: boolean
     When true, every correction line is applied if any of the patterns is violated; when false, only the correction line that corresponds positionally to the failed pattern is applied
 
     orderedFlag: boolean
     Whether or not the patterns are matched in order
 
     patterns: [
       The regular expressions to match within the configuration; (in the order the lines are to appear, when the orderedFlag is set)
 
       string
     ] *
}

SyntaxScanActionDTO

 Settings for executing a scan syntax action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$SyntaxScanActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     useAuxiliaryInterfaceFlag: boolean
     Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
     spanParams: #SpanParamsDTO *
     The selected network span
 
     scriptParams: #ScriptParamsDTO *
     Which script or configuration is to be checked by the device
}

SyntaxScanResultsDTO

 Results of executing a scan syntax action

{
     scriptLines: [
       Results of checking each line in the configuration or template or script
 
       #SyntaxScanScriptLineDTO
     ]
}

SyntaxScanScriptLineDTO

 The results of scanning a line within a script

{
     commandLine: string
     The command line from the configuration or template
 
     errorMessage: string
     The device's response to validating or checking the command line
 
     scanned: boolean
     Whether or not the command line was checked; some command lines are skipped, such as comments, lines inside multi-line commands (such as banners), and lines inside blocks whose header reported a syntax error
}

TelnetSshSessionActionDTO

 Settings for executing a telnet/SSH session action

Discriminator: "@class" : "com.bmc.bcan.rest.services.v2_0.ActionService$TelnetSshSessionActionDTO"

{
     actionNumber: integer
     The number of this action within the list of actions in the owning job or predefined job (or in the owning action, when this is a sub-action; read-only)
 
     guid: string
     The GUID that identifies the type of action; read-only for canned actions; required for custom and external script actions
 
     name: string
     The type of action referred to by the GUID (read-only)
 
     annotation: string
     Notes, comments, description, explanation
 
     statusId: integer
     The current execution status of this action (read-only)
 
     startTimestamp: date-time
     When the action execution began (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     endTimestamp: date-time
     When the action execution completed (read-only)
    Example: 2017-01-31T13:45:00.000+0000
 
     errorMessage: string
     Reason that a completed action failed (read-only)
 
     subactions: [
       Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       #ActionDTO
     ]
 
     useAuxiliaryInterfaceFlag: boolean
     Whether or not the auxiliary interface of the selected device is to be used for connecting to the device; applicable only when the network span is a single device
 
     spanParams: #SpanParamsDTO *
     The selected network span
 
     loginUsername: string
     Username for logging in to the device
 
     loginPassword: string
     Password for logging in to the device
}

TemplateDTO

 Information about a template

{
     id: string
     The database key
 
     name: string
     The template's unique display name
 
     annotation: string
     Notes, comments, description, explanation
 
     dynamicFields: [
       The dynamic fields
 
       #DynamicFieldValueDTO
     ]
}

TermDTO

 An operand within a boolean expression

{
     notFlag: boolean
     Whether or not the opposite of the operand is to be computed
 
     groupId: #ComponentId
     Identifies the single group that makes up this term; must specify either 'groupId' or 'groups' as an operand in a boolean expression
 
     groupDetailsLink: