v4.0 Devices API


TrueSight Network Automation REST API – DeviceService
The base URL for the API is:

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

devices

{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/devices
Click here to expand...


Description

Retrieves devices, matching any filter criteria or view, 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, lastSnapshotStatus, lastSnapshotTimestamp, model, osImage, vendorName, or a listable device dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending)


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

offset

query

Return the specified page number

1

integer

limit

query

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

25

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, either by exact name or by database key


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

filter.action

query

Filter for devices where the user is allowed to perform this action, by action GUID


string

view

query

Filter for devices per the named private or shared view; any input filter.* or orderBy parameters override those settings in the view


string

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 accessToken cookie, or the specified user is not logged in


403

Forbidden: Not allowed to access devices


404

Not found: No matching view found


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Green" title="POST"/}}

 /v4.0/devices
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new device


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 accessToken cookie, or the specified user is not logged in


403

Forbidden: Not allowed to add a new device


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Green" title="POST"/}}

 /v4.0/devices/filtered
Click here to expand...


Description

Retrieves devices, matching any filter criteria passed in the request body, with the returned result being abbreviated or partially-detailed devices.

Parameters

Name

Located in

Description

Default

Schema

body

body

Filter for devices matching the various criteria specified in the DeviceFilterDTO; when null, no filtering occurs


orderBy

query

Sort by the specified attribute (name, realm, address, lastSnapshotStatus, lastSnapshotTimestamp, model, osImage, vendorName, 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",
 "+lastSnapshotStatus",
 "-lastSnapshotStatus",
 "+lastSnapshotTimestamp",
 "-lastSnapshotTimestamp",
 "+model",
 "-model",
 "+osImage",
 "-osImage",
 "+vendorName",
 "-vendorName"
]

offset

query

Return the specified page number

1

integer

limit

query

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

25

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

400

Bad request: Input device filter contains invalid selections


401

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


403

Forbidden: Not allowed to access devices


500

Internal server error: Unexpected exception occurred

{{status subtle="false" colour="Yellow" title="PUT"/}}

 /v4.0/devices/multiple_device_updates
Click here to expand...


Description

Modifies the specified static and dynamic fields in the selected devices; the response reports which devices are successfully updated and which are not updated due to some validation error; note there are no partial updates; any one device either has all the changes applied to it or none of them

Parameters

Name

Located in

Description

Default

Schema

body

body

What changes to make and to which devices


Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

400

Bad request: Input DTO is missing or invalid


401

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


403

Forbidden: Not allowed to access devices, or not allowed to modify all of the selected devices


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/devices/{nameOrKey
}
Click here to expand...


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

401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, 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


{{status subtle="false" colour="Yellow" title="PUT"/}}

 /v4.0/devices/{nameOrKey
}
Click here to expand...


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


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 accessToken cookie, 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

{{status subtle="false" colour="Red" title="DELETE"/}}

 /v4.0/devices/{nameOrKey
}
Click here to expand...


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 accessToken cookie, 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


{{status subtle="false" colour="Yellow" title="PATCH"/}}

 /v4.0/devices/{nameOrKey
}
Click here to expand...


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


Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

400

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


401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, 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


{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/devices/{nameOrKey}/available_trails
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device of interest


string *

context

query

Which configuration trails are of interest (existingConfigurations, mergeable, restorable, targetAssignable); existingConfigurations retrieves the trails of configurations currently present in the device; mergeable retrieves the trails that can be deployed in a Deploy To Active action; restorable retrieves the trails that can be deployed in a Deploy To Stored action; targetAssignable retrieves the trails that can be assigned to the target configuration; when null, retrieves the configuration trails supported by the device type


string 
Enum: [
 "existingConfigurations",
 "mergeable",
 "restorable",
 "targetAssignable"
]

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 accessToken cookie, or the specified user is not logged in


404

Not found: No single matching accessible device found


500

Internal server error: Unexpected exception occurred

{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/devices/{nameOrKey}/configurations/{cfgKey
}
Click here to expand...


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

401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, 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


{{status subtle="false" colour="Yellow" title="PUT"/}}

 /v4.0/devices/{nameOrKey}/configurations/{cfgKey}/annotation
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device whose configuration is to be modified


string *

cfgKey

path

Database key of the configuration of interest


string *

annotation

query

Annotation for the configuration


string

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

400

Bad request: Modified configuration is invalid


401

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


403

Forbidden: Not allowed to modify the configuration


404

Not found: No single matching accessible device or configuration found


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/devices/{nameOrKey}/configurations/{cfgKey}/binaryData
Click here to expand...


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 accessToken cookie, 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 (has only ascii data), or the binary data is missing from the database


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/devices/{nameOrKey}/configurations/{cfgKey}/data
Click here to expand...


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 accessToken cookie, 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


{{status subtle="false" colour="Green" title="POST"/}}

 /v4.0/devices/{nameOrKey}/configurations/{cfgKey}/emailed_file
Click here to expand...


Description

Exports and then emails a device configuration; any sensitive configuration data is masked if you are not granted the "Access Sensitive Data" system right

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 *

body

body

Parameters for exporting and emailing the configuration


hideLineNumbers

query

Whether or not to hide the line numbers in the configuration; when false, a line number appears with each configuration line; when true, only the configuration lines appear, with no line numbers


boolean

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

OK: Exported device configuration file successfully emailed


400

Bad request: Input email parameters are missing or invalid


401

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


404

Not found: No single matching accessible device or configuration found


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Green" title="POST"/}}

 /v4.0/devices/{nameOrKey}/configurations/{cfgKey}/exported_file
Click here to expand...


Description

Exports a device configuration; any sensitive configuration data is masked if you are not granted the "Access Sensitive Data" system right

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 *

body

body

Parameters for exporting the configuration


hideLineNumbers

query

Whether or not to hide the line numbers in the configuration; when false, a line number appears with each configuration line; when true, only the configuration lines appear, with no line numbers


boolean

Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

400

Bad request: Input export parameters are missing or invalid


401

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


404

Not found: No single matching accessible device or configuration found


500

Internal server error: Unexpected exception occurred

{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/devices/{nameOrKey}/configurations/{trailGuid
}
Click here to expand...


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

400

Bad request: Input trail GUID is invalid


401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, 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


{{status subtle="false" colour="Yellow" title="PUT"/}}

 /v4.0/devices/{nameOrKey}/current_configuration/{trailGuid
}
Click here to expand...


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 accessToken cookie, 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


{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/devices/{nameOrKey}/current_configurations
Click here to expand...


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

401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, 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


{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/devices/{nameOrKey}/hardware_inventory/{hwKey
}
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device of interest


string *

hwKey

path

Database key of the hardware inventory of interest


string *

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 accessToken cookie, or the specified user is not logged in


403

Forbidden: Not allowed to access devices


404

Not found: No single matching accessible device or hardware inventory found


500

Internal server error: Unexpected exception occurred

{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/devices/{nameOrKey}/status
Click here to expand...


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

401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, 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


{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/devices/{nameOrKey}/status/{actionGuid}/transcript
Click here to expand...


Description

Retrieves the latest device action execution transcript for the specified type of action; any sensitive configuration data is masked if you are not granted the "Access Sensitive Data" system right; use an Accept header to choose the format of the response, which defaults to text/plain; since the system maintains its transcripts as XML strings, the raw XML is returned as text/plain should the XML be malformed in some way

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

400

Bad request: Input action GUID is invalid


401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, 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, or no action found matching the input actionGuid


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Green" title="POST"/}}

 /v4.0/devices/{nameOrKey}/status/{actionGuid}/transcript/emailed_file
Click here to expand...


Description

Exports and then emails the latest device action execution transcript for the specified type of action; any sensitive configuration data exposed in the transcript is masked if you are not granted the "Access Sensitive Data" system right

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 *

body

body

Parameters for emailing the device transcript


Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

OK: Exported device transcript file successfully emailed


400

Bad request: Input action GUID is invalid or input email parameters are missing or invalid


401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, 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


500

Internal server error: Unexpected exception occurred

{{status subtle="false" colour="Green" title="POST"/}}

 /v4.0/devices/{nameOrKey}/status/{actionGuid}/transcript/exported_file
Click here to expand...


Description

Exports the latest device action execution transcript for the specified type of action; any sensitive configuration data exposed in the transcript is masked if you are not granted the "Access Sensitive Data" system right

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 *

body

body

Parameters for exporting the device transcript


Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

400

Bad request: Input action GUID is invalid or input export parameters are missing or invalid


401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, 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


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/devices/{nameOrKey}/target_configuration
Click here to expand...


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

401

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


403

Forbidden: Not allowed to access device target configurations


404

Not found: No single matching accessible device found or the device has no target configuration


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Yellow" title="PUT"/}}

 /v4.0/devices/{nameOrKey}/target_configuration
Click here to expand...


Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the device whose target configuration is to be modified


string *

body

body

Complete new attribute values for the target configuration; anything left out will be considered to be null and will be nulled out in the target configuration


Authorization

header

Authorization token formatted as 'Bearer [token]'


string *

Responses

Code

Description

Schema

200

successful operation

400

Bad request: Input target configuration DTO is missing or modified target configuration is invalid


401

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


403

Forbidden: Not allowed to modify the target configuration


404

Not found: No single matching accessible device found or the device has no target configuration


500

Internal server error: Unexpected exception occurred


{{status subtle="false" colour="Blue" title="GET"/}}

 /v4.0/devices/{nameOrKey}/trusted_configurations
Click here to expand...


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

401

Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, 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

Object Definitions

Object

Schema

AbbreviatedConfigurationDTO


Click here to expand...


{ 
    id: string 
    The configuration's unique database key 

    annotation: string 
    The user-defined notes or description about this configuration 

    asciiDataFlag: boolean 
    Whether or not this configuration contains readable data 

    binaryDataFlag: boolean 
    Whether or not this configuration contains unreadable binary data 

    changeID: string 
    The change ID from the job that generated this configuration, for mapping into any external change management system 

    created: string 
    Date/time this configuration was obtained from the device 

    jobID: string 
    The job ID of the job that generated this configuration 

    osImageName: string 
    The full name of the operating system version in effect at the time this configuration was created 

    trustedFlag: boolean 
    Whether or not this configuration is trusted 
}

AbbreviatedDeviceDTO


Click here to expand...


{ 
    id: string 
    The device's unique database key 

    name: string 
    The device's unique display name 

    canCopyFlag: boolean 
   {{Whether or not the user is allowed to copy this device }}

    canDeleteFlag: boolean 
   {{Whether or not the user is allowed to delete this device }}

    canEditFlag: boolean 
   {{Whether or not the user is allowed to edit this device }}

    canViewTranscriptFlag: boolean 
    Whether or not the user can view recorded device interaction transcripts 

    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 

    lastSnapshotErrorMessage: string 
    Reason for the failure of the most recently attempted snapshot action 

    modelName: string 
    The discovered model 

    osImageName: string 
    The full name of the discovered operating system version 

    deviceTypeId: ComponentId
    Identifies the owning device type and 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 

    primaryInterfaceDeviceAgentNIC: string 
    The name of the primary interface device agent NIC 

    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
    ] 

    lastSnapshotTimestamp: date-time 
    The date/time of the most recently attempted snapshot action 
    Example: 2017-01-31T13:45:00.000+0000

    lastSnapshotStatus: string 
    The status of the most recently attempted snapshot action; a null indicates the device has never attempted a snapshot 
}

ActionStatusDTO


Click here to expand...


{ 
    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 

    deviceAgentNIC: string 
    The device agent NIC 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 

    lastSuccessTimestamp: date-time 
    The last time this action was successfully executed 
    Example: 2017-01-31T13:45:00.000+0000

    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) and when the user is allowed to view a transcript from the device 
}

ActiveConfigurationTrailDTO


Click here to expand...


{ 
    guid: string 
    The GUID of this trail 

    name: string 
    The name of this trail 

    supportsAsciiDataFlag: boolean 
    Whether or not a configuration of this trail contains readable text data; true when the data obtained from the device is natively ASCII, or when the natively binary data can somehow be decoded into something readable 

    supportsBinaryDataFlag: boolean 
    Whether or not a configuration of this trail contains unreadable binary data 

    supportsTemplateCreationFlag: boolean 
    Whether or not a template can be created from a configuration of this trail 

    supportsTrustedFlag: boolean 
    Whether or not a configuration in this trail can be marked as trusted 
}

ComboGroupFilterDTO


Click here to expand...


{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

      DynamicFieldFilterDTO
    ] 

    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) 

    nameMatch: string 
    Search for combo groups whose name matches this wildcard-enabled string 

    realmName: string 
    Search for combo groups that belong to this exact realm 
}

ComplianceStatusDTO


Click here to expand...


{ 
    passedRules: [ 
      The rules that are currently compliant 

      PassedRuleDTO
    ] 

    violatedRules: [ 
      The rules that are currently in violation 

      FailedRuleDTO
    ] 
}

ComponentFilterDTO


Click here to expand...

Subclasses:
TemplateFilterDTO
OsImageFilterDTO
PredefinedJobFilterDTO
ComboGroupFilterDTO
RuleFilterDTO
JobFilterDTO
RuleSetFilterDTO
DeviceFilterDTO
GroupFilterDTO

{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

      DynamicFieldFilterDTO
    ] 

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

ComponentId


Click here to expand...


{ 
    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; for componentType Configuration and HardwareInventory, componentName is the created timestamp (in milliseconds); for componentType SecurityVulnerability, componentName is the securityVulnerabilityID; for componentType SnmpManagerStation, componentName is the address 

    componentType: string * 
    The type of the component, used to verify what is retrieved by key/name; valid values are: Combogroup, Condition, Configuration, Device, DeviceAdapter, DeviceAgent, DeviceSecurityProfile DynamicField, EmailDistributionList, Group, HardwareInventory, JobApprovalType, Keyword, Model, OsImage, PredefinedJob, Realm, RemoteFileServer, 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 and HardwareInventory: key=deviceKey, value=database key of the device the item belongs to, key=deviceName, value=name of the device the item belongs to, key=timestamp, value=creation date/time in server display format; for componentType DeviceAdapter: key=adapterType, value=type of the device adapter, key=parent, value=parent or owner used for organizing certain types of adapters, key=vendorName, value=name of the vendor that owns a device type; 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 
    } 
}

ConfigurationDTO


Click here to expand...


{ 
    id: string 
    The configuration's unique database key 

    created: date-time 
    Date/time this configuration was obtained from the devicedisplayed in a text format 
    Example: 2017-01-31T13:45:00.000+0000

    createdMilliseconds: integer 
    Date/time this configuration was obtained from the device, displayed in milliseconds 

    trailId: ComponentId
    The configuration trail 

    osImageName: string 
    The full name of the operating system version in effect at the time this configuration was created 

    osImageVersion: OsImageReleaseDTO
    The primary OS image version in a parsed form 

    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 

    binaryDataChecksum: string 
    The MD5 checksum or digest on the binary data 

    dataLink: string 
    Link to retrieve the ASCII data 

    binaryDataLink: string 
    Link to retrieve the binary data 
}

DeviceDTO


Click here to expand...


{ 
    id: string 
    The device's unique database key (read-only) 

    name: string * 
    The device's unique display name 

    allowedAndSupportedActions: { 
      The span actions the user is allowed to perform on this device and that are supported by its device type, keys containing the GUIDs of these actions (read-only), values containing the name of these actions 
    } 

    canCopyFlag: boolean 
    Whether or not the user is allowed to copy this device (read-only) 

    canDeleteFlag: boolean 
    Whether or not the user is allowed to delete this device (read-only) 

    canEditFlag: boolean 
    Whether or not the user is allowed to edit this device (read-only) 

    realmId: ComponentId*
    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 full name of the discovered operating system version (read-only) 

    deviceTypeId: ComponentId*
    Identifies the owning device type and vendor 

    categoryId: integer * 
    The category 

    categoryName: string 
    The meaning of the numeric categoryId (read-only) 
   

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

    memberOfAutoGroups: [ 
      The auto-groups this device belongs to (read-only) 

      ComponentId
    ] 

    memberOfComboGroups: [ 
      The combo groups this device belongs to (read-only) 

      ComponentId
    ] 

    memberOfStaticGroups: [ 
      The static groups this device belongs to; during creation and update requests, the device is added to the static groups listed here, and is removed from any static group it belongs to but that is not listed here 

      ComponentId
    ] 

    dynamicFields: [ 
      The dynamic fields 

      DynamicFieldValueDTO
    ] 

    statusLink: string 
    Link to get detailed device status (read-only) 

    trustedConfigurations: { 
      Trusted configurations; the map key is the GUID of the configuration trail; the map value is the trusted configuration in that trail (read-only) 
    } 

    configurations: { 
      Configurations per trail; the map key is the GUID of the configuration trail; the map value is the configurations in that trail, ordered by creation date/time, with the current configuration being first (read-only) 
    } 
}

DeviceDynamicFieldEditDTO


Click here to expand...


{ 
    clearExistingValueFlag: boolean 
    Whether or not to clear or null out the existing value for the dynamic field; when true, the newValues field must be null, and the current value is set to null; when false, the current value is set to the value(s) specified by newValues, which must not be null 

    id: string * 
    The database key of the dynamic field to be updated 

    newValues: [ 
      When clearExistingValueFlag is false, the new value(s) for the dynamic field; if the dynamic field is a single-value type of field, then only the first entry is used 

      string 
    ] 
}

DeviceFilterDTO


Click here to expand...


{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

      DynamicFieldFilterDTO
    ] 

    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: TimePeriodDTO
    Search for devices created within this time period 

    defaultDeviceAgentNICFlag: boolean 
    Whether or not to search for devices whose interface is set to use the default NIC of its selected device agent; when true, the deviceAgentNICName field is ignored 

    deviceAgentName: string 
    Search for devices whose device agent equals this name 

    deviceAgentNICName: string 
    Search for devices whose NIC equals this name, within the device agent specified by the deviceAgentName field; to search for devices using the "(Default)" NIC, use the defaultDeviceAgentNICFlag field instead 

    deviceSecurityProfileName: string 
    Search for devices whose device security profile equals this name 

    deviceTypeId: ComponentId
    Search for devices whose device type equals this device type 

    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, NIC, 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, NIC, and device security profile) 

    groupName: string 
    Search for devices that belong to this group in the realm specified by realmName 

    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 or secondary 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 

    realmName: string 
    Search for devices that belong to this exact realm 

    securityContextTypeId: integer 
    Search for devices set to this type of security context 

    transferModeId: integer 
    Search for devices with this file transfer mode 

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

    includedViolationTrailIds: [ 
      Include devices in the results that have a compliance violation in one of these trails 

      ComponentId
    ] 

    excludedViolationTrailIds: [ 
      Exclude devices from the results that have a compliance violation in one of these trails 

      ComponentId
    ] 

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


Click here to expand...


{ 
    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 

    secondaryNatAddress: string 
    An alternate or backup NAT address for reaching the device agent from the device, either an IP address or a host name, that is used when the 'Use Secondary NAT Address For Devices' system parameter is enabled 

    accessModeId: integer * 
    The protocol used to connect to the device 

    accessModeName: string 
    The meaning of the numeric accessModeId (read-only) 

    transferModeId: integer * 
    The protocol used to exchange files with the device 

    transferModeName: string 
    The meaning of the numeric transferModeId (read-only) 

    deviceAgentId: ComponentId*
    The device agent that directly accesses this device 

    deviceAgentNIC: string 
    The name of the device agent NIC that accesses this device; when null, indicates the default NIC is used 

    deviceAgentNICDetails: string 
    More detailed information about the device agent NIC; when null, indicates the default NIC is used 

    deviceAgentDetailsLink: string 
    Link to get complete details about the device agent (read-only) 

    deviceSecurityProfileId: ComponentId
    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 
}

DeviceMultiEditDTO


Click here to expand...


{ 
    dynamicFieldUpdates: [ 
      The updates or edits to be made to the dynamic fields in each selected device 

      DeviceDynamicFieldEditDTO
    ] 

    itemsToUpdate: [ 
      Which devices are to be updated or edited 

      ComponentId
    ] * 

    staticFieldUpdates: [ 
      The updates or edits to be made to the static fields in each selected device 

      DeviceStaticFieldEditDTO
    ] 
}

DeviceMultiEditResultDTO


Click here to expand...


{ 
    errorMessage: string 
    Reason the update or edit failed 

    device: ComponentId
    The device that was requested to be updated 

    successFlag: boolean 
    Whether or not the requested update was successful 
}

DeviceResultFilterDTO


Click here to expand...


{ 
    actionNumber: integer 
    Include the results from this one action within the job; action numbers start with 1 

    errorMessageMatch: string 
    Include the results that failed with this error message, asterisk wildcards allowed 

    statusId: integer 
    Include the results with this numeric completion status 

    subactionNumber: integer 
    Include the results from this one sub-action within the action specified by the actionNumber field; sub-action numbers start with 1; this is ignored if you fail to specify an actionNumber 
}

DeviceStaticFieldEditDTO


Click here to expand...


{ 
    clearExistingValueFlag: boolean 
    Whether or not to clear or null out the existing value for this field; when true, the newValue field must be null, and the current value is set to false or null or an appropriate numeric value; when false, the current value is set to the value specified by newValue, which must not be null 

    fieldName: string * 
    Which device field is to be updated or edited; any setting related to the auxiliary interface is ignored when the device has no auxiliary interface; the legal field names are: categoryid, devicetypeid, onlineflag, realmid, remoteimagefileserverid, securitycontextname, securitycontexttypeid, auxiliaryinterface.accessmodeid, auxiliaryinterface.autodiscoverdspflag, auxiliaryinterface.deviceagentid, auxiliaryinterface.deviceagentnic, auxiliaryinterface.devicesecurityprofileid, auxiliaryinterface.nataddress, auxiliaryinterface.port, auxiliaryinterface.transfermodeid, primaryinterface.accessmodeid, primaryinterface.autodiscoverdspflag, primaryinterface.deviceagentid, primaryinterface.deviceagentnic, primaryinterface.devicesecurityprofileid, primaryinterface.nataddress, primaryinterface.port, primaryinterface.transfermodeid 

    newValue: string 
    When clearExistingValueFlag is false, the new value for the field; if the field is a flag, this value must be either "true" or "false"; if the field is deviceTypeId, this value must be the GUID of the device type; if the field is realmId, this value must be the database key of the realm; if the field is remoteImageFileServerId, this value must be the database key of the remote file server; if the field is primary or auxiliary deviceAgentId, this value must be the database key of the device agent; if the field is primary or auxiliary deviceSecurityProfileId, this value must be the database key of the device security profile 
}

DeviceStatusDTO


Click here to expand...


{ 
    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 

    hardwareInventories: [ 
      Information for accessing Hardware inventories, with the first entry being the current inventory, followed by historical inventories 

      ComponentId
    ] 

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

DynamicFieldFilterDTO


Click here to expand...


{ 
    dynamicField: ComponentId*
    The dynamic field whose value is being searched for 

    value: string * 
    The filter string (the value to be matched); if this value is null or empty, no filtering is done on the specified 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 
}

DynamicFieldValueDTO


Click here to expand...


{ 
    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) 
}

EmailParametersDTO


Click here to expand...

Subclasses:
EventEmailParametersDTO
JobEmailParametersDTO

{ 
    formatId: integer * 
    The format of the exported file (CSV, HTML, PDF, or RTF) 

    hideHeaderAndFooterFlag: boolean 
    When the format is CSV, whether or not to hide the header and footer; when false, the header/title and footer/selections are included in the CSV file; when true, parts of the header and footer are excluded from the CSV file, making the file more easily imported into a spreadsheet; ignored when the format is not CSV 

    hideSensitiveDataFlag: boolean 
    For those exports that carry configuration data, whether or not the exported file masks sensitive configuration data, when false, the exported file contains the same data as the viewed data (which may already have masked its sensitive data, if you are not granted the "Access Sensitive Data" system right); when true, the exported file masks sensitive configuration data 

    includeAllDetailsFlag: boolean 
    Whether or not the exported file contains all the details associated with the main report or owned by the selected job; when false, the exported file contains only the selected report or job; when true, the exported file contains the selected report and its details subreports, or the selected job and its device transcripts; for reports, the number of details subreports is limited by the system parameter "Maximum Number of Details in Exported Reports"; ignored when the selected report supports no details (such as system diagnostics, device inventory, and OS image History reports) 

    orderBy: string 
    Sort details by the specified attribute in the specified order (prefix with a '+' for ascending order or a '-' for descending order); each type of export supports different attributes that can be sorted; not applicable to exports that lack sortable rows (such as configurations, transcripts, system diagnostics report, and all details-type reports); ignored when not applicable 

    subject: string 
    The subject of the email message carrying the exported content 

    toAdhocAddresses: [ 
      Any ad-hoc email addresses of the other interested recipients of the exported content 

      string 
    ] 

    toEmailListIds: [ 
      Any email distribution lists to receive the exported content 

      ComponentId
    ] 

    toUserIds: [ 
      Any users to receive the exported content 

      ComponentId
    ] 
}

EntityDTO


Click here to expand...


{ 
    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 

    sn: string 
    The serial number 
}

EventEmailParametersDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.EventService$EventEmailParametersDTO"

{ 
    formatId: integer * 
    The format of the exported file (CSV, HTML, PDF, or RTF) 

    hideHeaderAndFooterFlag: boolean 
    When the format is CSV, whether or not to hide the header and footer; when false, the header/title and footer/selections are included in the CSV file; when true, parts of the header and footer are excluded from the CSV file, making the file more easily imported into a spreadsheet; ignored when the format is not CSV 

    hideSensitiveDataFlag: boolean 
    For those exports that carry configuration data, whether or not the exported file masks sensitive configuration data, when false, the exported file contains the same data as the viewed data (which may already have masked its sensitive data, if you are not granted the "Access Sensitive Data" system right); when true, the exported file masks sensitive configuration data 

    includeAllDetailsFlag: boolean 
    Whether or not the exported file contains all the details associated with the main report or owned by the selected job; when false, the exported file contains only the selected report or job; when true, the exported file contains the selected report and its details subreports, or the selected job and its device transcripts; for reports, the number of details subreports is limited by the system parameter "Maximum Number of Details in Exported Reports"; ignored when the selected report supports no details (such as system diagnostics, device inventory, and OS image History reports) 

    orderBy: string 
    Sort details by the specified attribute in the specified order (prefix with a '+' for ascending order or a '-' for descending order); each type of export supports different attributes that can be sorted; not applicable to exports that lack sortable rows (such as configurations, transcripts, system diagnostics report, and all details-type reports); ignored when not applicable 

    subject: string 
    The subject of the email message carrying the exported content 

    toAdhocAddresses: [ 
      Any ad-hoc email addresses of the other interested recipients of the exported content 

      string 
    ] 

    toEmailListIds: [ 
      Any email distribution lists to receive the exported content 

      ComponentId
    ] 

    toUserIds: [ 
      Any users to receive the exported content 

      ComponentId
    ] 

    filter: EventFilterDTO
    Filter for events matching the various criteria specified in the EventFilterDTO; when null, no filtering occurs 

    viewNameForTitle: string * 
    The name of the view being exported, used only for display in the exported file's header 
}

EventExportParametersDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.EventService$EventExportParametersDTO"

{ 
    formatId: integer * 
    The format of the exported file (CSV, HTML, PDF, or RTF) 

    hideHeaderAndFooterFlag: boolean 
    When the format is CSV, whether or not to hide the header and footer; when false, the header/title and footer/selections are included in the CSV file; when true, parts of the header and footer are excluded from the CSV file, making the file more easily imported into a spreadsheet; ignored when the format is not CSV 

    hideSensitiveDataFlag: boolean 
    For those exports that carry configuration data, whether or not the exported file masks sensitive configuration data, when false, the exported file contains the same data as the viewed data (which may already have masked its sensitive data, if you are not granted the "Access Sensitive Data" system right); when true, the exported file masks sensitive configuration data 

    includeAllDetailsFlag: boolean 
    Whether or not the exported file contains all the details associated with the main report or owned by the selected job; when false, the exported file contains only the selected report or job; when true, the exported file contains the selected report and its details subreports, or the selected job and its device transcripts; for reports, the number of details subreports is limited by the system parameter "Maximum Number of Details in Exported Reports"; ignored when the selected report supports no details (such as system diagnostics, device inventory, and OS image History reports) 

    orderBy: string 
    Sort details by the specified attribute in the specified order (prefix with a '+' for ascending order or a '-' for descending order); each type of export supports different attributes that can be sorted; not applicable to exports that lack sortable rows (such as configurations, transcripts, system diagnostics report, and all details-type reports); ignored when not applicable 

    filter: EventFilterDTO
    Filter for events matching the various criteria specified in the EventFilterDTO; when null, no filtering occurs 

    viewNameForTitle: string * 
    The name of the view being exported, used only for display in the exported file's header 
}

EventFilterDTO


Click here to expand...


{ 
    categoryId: integer 
    Search for events in this category; a null or a zero value means do not filter on this field 

    descriptionMatch: string 
    Search for events whose description matches this wildcard-enabled string; a null means do not filter on this field 

    groupId: string 
    Search for events related to the group or the combo group specified by this database key; this field can be used only in transient filters (not in any views), as it is an input-only field and is not persisted to the database 

    maxEvents: integer 
    The maximum number of events returned by a database query that uses this filter, from which a selected page is extracted; setting a value improves performance when there are many events in the database; a value of zero or less means an unlimited number of events are returned 

    realmNameMatch: string 
    Search for events whose realm matches this wildcard-enabled string; a null means do not filter on this field 

    rootThreadId: integer 
    Search for events that were logged in this parent or root database session; a null or a zero value means do not filter on this field 

    severityIds: [ 
      Search for events of this severity; a null or an empty list means do not filter on this field 

      integer 
    ] 

    sourceNameMatch: string 
    Search for events whose source matches this wildcard-enabled string; a null means do not filter on this field 

    targetNameMatch: string 
    Search for events whose target matches this wildcard-enabled string; a null means do not filter on this field 

    timestamp: TimePeriodDTO
    Search for events that occurred within this time period; a null means do not filter on this field 

    typeId: integer 
    Search for events of this type; a null or a zero value means do not filter on this field 
}

ExportParametersDTO


Click here to expand...

Subclasses:
EventExportParametersDTO
EmailParametersDTO
JobExportParametersDTO

{ 
    formatId: integer * 
    The format of the exported file (CSV, HTML, PDF, or RTF) 

    hideHeaderAndFooterFlag: boolean 
    When the format is CSV, whether or not to hide the header and footer; when false, the header/title and footer/selections are included in the CSV file; when true, parts of the header and footer are excluded from the CSV file, making the file more easily imported into a spreadsheet; ignored when the format is not CSV 

    hideSensitiveDataFlag: boolean 
    For those exports that carry configuration data, whether or not the exported file masks sensitive configuration data, when false, the exported file contains the same data as the viewed data (which may already have masked its sensitive data, if you are not granted the "Access Sensitive Data" system right); when true, the exported file masks sensitive configuration data 

    includeAllDetailsFlag: boolean 
    Whether or not the exported file contains all the details associated with the main report or owned by the selected job; when false, the exported file contains only the selected report or job; when true, the exported file contains the selected report and its details subreports, or the selected job and its device transcripts; for reports, the number of details subreports is limited by the system parameter "Maximum Number of Details in Exported Reports"; ignored when the selected report supports no details (such as system diagnostics, device inventory, and OS image History reports) 

    orderBy: string 
    Sort details by the specified attribute in the specified order (prefix with a '+' for ascending order or a '-' for descending order); each type of export supports different attributes that can be sorted; not applicable to exports that lack sortable rows (such as configurations, transcripts, system diagnostics report, and all details-type reports); ignored when not applicable 
}

FailedRuleDTO


Click here to expand...


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

GroupFilterDTO


Click here to expand...


{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

      DynamicFieldFilterDTO
    ] 

    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) 

    nameMatch: string 
    Search for groups whose name matches this wildcard-enabled string 

    realmName: string 
    Search for groups that belong to this exact realm 

    showAutoGroupsFlag: boolean 
    Whether or not to include auto-groups in the results 

    showSimpleGroupsFlag: boolean 
    Whether or not to include manually-created groups in the results 

    showEmptyAutoGroupsFlag: boolean 
    Whether or not to include empty auto-groups in the results 
}

HardwareInventoryDTO


Click here to expand...


{ 
    created: date-time 
    Time this inventory was created or last updated 
    Example: 2017-01-31T13:45:00.000+0000

    historicalFlag: boolean 
    Whether this is a historical hardware inventory (true) or a current hardware inventory (false) 

    entities: [ 
      Hardware components reported in 'show inventory' command on a Cisco device 

      EntityDTO
    ] 

    fileSystems: [ 
      Data reported in 'dir all-filesystems' command on a Cisco device 

      StorageDTO
    ] 

    memories: [ 
      Data reported in 'show memory statistics' command on a Cisco device 

      StorageDTO
    ] 

    importedInventory: [ 
      Inventory imported from an external element manager, parsed out into rows and columns in a generic fashion, since the content reported by each type of element manager varies 

      TableOrientedInventoryValueDTO
    ] 

    rawImportedInventory: string 
    When imported inventory is present but it cannot be parsed, contains the raw XML text 
}

IOSHardwareInventoryFilterDTO


Click here to expand...


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

JobEmailParametersDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.JobService$JobEmailParametersDTO"

{ 
    formatId: integer * 
    The format of the exported file (CSV, HTML, PDF, or RTF) 

    hideHeaderAndFooterFlag: boolean 
    When the format is CSV, whether or not to hide the header and footer; when false, the header/title and footer/selections are included in the CSV file; when true, parts of the header and footer are excluded from the CSV file, making the file more easily imported into a spreadsheet; ignored when the format is not CSV 

    hideSensitiveDataFlag: boolean 
    For those exports that carry configuration data, whether or not the exported file masks sensitive configuration data, when false, the exported file contains the same data as the viewed data (which may already have masked its sensitive data, if you are not granted the "Access Sensitive Data" system right); when true, the exported file masks sensitive configuration data 

    includeAllDetailsFlag: boolean 
    Whether or not the exported file contains all the details associated with the main report or owned by the selected job; when false, the exported file contains only the selected report or job; when true, the exported file contains the selected report and its details subreports, or the selected job and its device transcripts; for reports, the number of details subreports is limited by the system parameter "Maximum Number of Details in Exported Reports"; ignored when the selected report supports no details (such as system diagnostics, device inventory, and OS image History reports) 

    orderBy: string 
    Sort details by the specified attribute in the specified order (prefix with a '+' for ascending order or a '-' for descending order); each type of export supports different attributes that can be sorted; not applicable to exports that lack sortable rows (such as configurations, transcripts, system diagnostics report, and all details-type reports); ignored when not applicable 

    subject: string 
    The subject of the email message carrying the exported content 

    toAdhocAddresses: [ 
      Any ad-hoc email addresses of the other interested recipients of the exported content 

      string 
    ] 

    toEmailListIds: [ 
      Any email distribution lists to receive the exported content 

      ComponentId
    ] 

    toUserIds: [ 
      Any users to receive the exported content 

      ComponentId
    ] 

    filter: DeviceResultFilterDTO
    Which device results are included in the emailed file 
}

JobExportParametersDTO


Click here to expand...

Discriminator: "@class" : "com.bmc.bcan.rest.services.v4_0.JobService$JobExportParametersDTO"

{ 
    formatId: integer * 
    The format of the exported file (CSV, HTML, PDF, or RTF) 

    hideHeaderAndFooterFlag: boolean 
    When the format is CSV, whether or not to hide the header and footer; when false, the header/title and footer/selections are included in the CSV file; when true, parts of the header and footer are excluded from the CSV file, making the file more easily imported into a spreadsheet; ignored when the format is not CSV 

    hideSensitiveDataFlag: boolean 
    For those exports that carry configuration data, whether or not the exported file masks sensitive configuration data, when false, the exported file contains the same data as the viewed data (which may already have masked its sensitive data, if you are not granted the "Access Sensitive Data" system right); when true, the exported file masks sensitive configuration data 

    includeAllDetailsFlag: boolean 
    Whether or not the exported file contains all the details associated with the main report or owned by the selected job; when false, the exported file contains only the selected report or job; when true, the exported file contains the selected report and its details subreports, or the selected job and its device transcripts; for reports, the number of details subreports is limited by the system parameter "Maximum Number of Details in Exported Reports"; ignored when the selected report supports no details (such as system diagnostics, device inventory, and OS image History reports) 

    orderBy: string 
    Sort details by the specified attribute in the specified order (prefix with a '+' for ascending order or a '-' for descending order); each type of export supports different attributes that can be sorted; not applicable to exports that lack sortable rows (such as configurations, transcripts, system diagnostics report, and all details-type reports); ignored when not applicable 

    filter: DeviceResultFilterDTO
    Which device results are included in the exported file 
}

JobFilterDTO


Click here to expand...


{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

      DynamicFieldFilterDTO
    ] 

    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) 

    actionGuids: [ 
      Search for jobs that include one of these actions 

      string 
    ] 

    changeIdMatch: string 
    Search for jobs whose change ID matches this wildcard-enabled string 

    creationTime: TimePeriodDTO
    Search for jobs whose creation date/time falls within this date/time range 

    editorNameMatch: string 
    Search for jobs with a creator or an editor matching this wildcard-enabled string 

    jobIdMatch: string 
    Search for jobs whose job ID matches this wildcard-enabled string 

    jobApprovalModeId: integer 
    Search for jobs with this job approval mode 

    jobApprovalTypeName: string 
    Search for jobs whose job approval type matches this exact name 

    networkSpanNameMatch: string 
    Search for jobs that have actions acting on a network span whose name matches this wildcard-enabled string 

    originatorMatch: string 
    Search for jobs whose originator matches this wildcard-enabled string 

    originatorTypeId: integer 
    Search for jobs with this type of originator 

    preparedFromPredefinedJobNameMatch: string 
    Search for jobs which were prepared from a predefined job whose name matches this wildcard-enabled string 

    reconciliationStatusId: integer 
    Search for jobs with this reconciliation status 

    showOnlyJobsICanApproveFlag: boolean 
    When searching for jobs with status "waiting for approval", whether or not to only include jobs that the user for this session can approve 

    statusIds: [ 
      Search for jobs whose current status matches one of these statuses 

      integer 
    ] 

    taskIdMatch: string 
    Search for jobs whose task ID matches this wildcard-enabled string 
}

JsonPatch


Click here to expand...


[ 
    A list of JSON Patch operations 

    JsonPatch.OneOperation
  ]

JsonPatch.OneOperation

JsonPatch.Pointer


Click here to expand...


string 
  Pointer or path to an element or property

JsonPatch.Add


Click here to expand...


{ 
    op: string * 
   Enum: [
     "add"
   ]
    value: any * 
    path: JsonPatch.Pointer*
}

JsonPatch.Remove


Click here to expand...


{ 
    op: string * 
   Enum: [
     "remove"
   ]
    path: JsonPatch.Pointer*
}

JsonPatch.Replace


Click here to expand...


{ 
    op: string * 
   Enum: [
     "replace"
   ]
    value: any * 
    path: JsonPatch.Pointer*
}

JsonPatch.Move


Click here to expand...


{ 
    op: string * 
   Enum: [
     "move"
   ]
    path: JsonPatch.Pointer*
    from: JsonPatch.Pointer*
}

JsonPatch.Copy


Click here to expand...


{ 
    op: string * 
   Enum: [
     "copy"
   ]
    path: JsonPatch.Pointer*
    from: JsonPatch.Pointer*
}

JsonPatch.Test


Click here to expand...


{ 
    op: string * 
   Enum: [
     "test"
   ]
    value: any * 
    path: JsonPatch.Pointer*
}

OsImageFilterDTO


Click here to expand...


{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

      DynamicFieldFilterDTO
    ] 

    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) 

    deviceTypeId: ComponentId
    Search for OS images associated with this device type 

    fileNameMatch: string 
    Search for OS images with filenames that match this wildcard-enabled string 

    modelNameMatch: string 
    Search for OS images associated with a model whose name matches this wildcard-enabled string 

    nameMatch: string 
    Search for OS images whose name matches this wildcard-enabled string 

    vendorId: ComponentId
    Search for OS images whose device type belongs to this vendor 
}

OsImageLoadHistoryDTO


Click here to expand...


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

OsImageReleaseDTO


Click here to expand...


{ 
    major: string * 
    The first element of a version number; asterisk wildcard is allowed 

    minor: string * 
    The second element of a version number; asterisk wildcard is allowed 

    build: string * 
    The rest of a version number; asterisk wildcard is allowed 
}

PassedRuleDTO


Click here to expand...


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

PredefinedJobFilterDTO


Click here to expand...


{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

      DynamicFieldFilterDTO
    ] 

    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) 

    actionGuids: [ 
      Search for predefined jobs that include one of these actions 

      string 
    ] 

    nameMatch: string 
    Search for predefined jobs whose name matches this wildcard-enabled string 

    networkSpanNameMatch: string 
    Search for predefined jobs that have actions acting on a network span whose name matches this wildcard-enabled string 
}

RuleFilterDTO


Click here to expand...


{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

      DynamicFieldFilterDTO
    ] 

    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: TimePeriodDTO
    Search for rules whose activation date/time falls within this date/time range 

    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: TimePeriodDTO
    Search for rules whose deactivation date/time falls within this date/time range 

    deviceTypeId: ComponentId
    Search for rules associated 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 

    includeNonCorrectableRulesFlag: boolean 
    Search for rules that cannot be corrected (that is, a rule that has no corrective actions, is in a disabled rule set, is not currently activated, or has a grammar whose violation cannot be automatically corrected); when all include*Flag values are false, then filtering based on correctability is skipped; note using the include*Flags is not allowed in jobs or predefined jobs 

    includeRulesCorrectableViaDeployToActiveFlag: boolean 
    Search for rules that can be corrected by running a Deploy to Active action; when all include*Flag values are false, then filtering based on correctability is skipped; note using the include*Flags is not allowed in jobs or predefined jobs 

    includeRulesCorrectableViaDeployToStoredFlag: boolean 
    Search for rules that can be corrected by running a Deploy to Stored action; when all include*Flag values are false, then filtering based on correctability is skipped; note using the include*Flags is not allowed in jobs or predefined jobs 

    includeRulesCorrectableViaRemediateFlag: boolean 
    Search for rules that can be corrected by running a Remediate action; when all include*Flag values are false, then filtering based on correctability is skipped; note using the include*Flags is not allowed in jobs or predefined jobs 

    isNullSecurityVulnerabilityFlag: boolean 
    Whether or not to search for rules that have no associated security vulnerability; when true, search only for such rules; when false or null, do not filter on associated security vulnerability; this flag cannot be used and must be null when this filter is used in a job, predefined job, policy, or view 

    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 
    ] 

    vendorId: ComponentId
    Search for rules whose device type belongs to this vendor 
}

RuleSetFilterDTO

Click here to expand...


{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

      DynamicFieldFilterDTO
    ] 

    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) 

    nameMatch: string 
    Search for rule sets whose name matches this wildcard-enabled string 

    enabledFlag: boolean 
    Search for rule sets that are enabled (true) or disabled (false); null means do not filter on the enabled/disabled state 
}

StorageDTO

Click here to expand...


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

TableOrientedInventoryValueDTO

Click here to expand...


{ 
    name: string 
    The overall name or title of this table 

    rowsAndColumns: [ 
      The values laid out as rows and columns 

      [ 
        string 
      ] 
    ] 

    titles: [ 
      Headers or titles for the values in each column, one per column; null when there is only one column or when titles are not applicable 

      string 
    ] 
}

TargetConfigurationDTO

Click here to expand...


{ 
    annotation: string 
    The user-defined notes or description about this target configuration 

    contents: string 
    The user-defined contents of this target configuration 

    deviceId: ComponentId
    The device to which this target configuration belongs 

    lastModifiedTimestamp: date-time 
    When this target configuration was last modified 
    Example: 2017-01-31T13:45:00.000+0000

    osImageId: ComponentId
    The OS image version of the original configuration from which this target configuration was copied 
}

TemplateFilterDTO

Click here to expand...


{ 
    dynamicFieldFilters: [ 
      Any filters on dynamic fields 

      DynamicFieldFilterDTO
    ] 

    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) 

    containerBlueprintName: string 
    Search for templates referenced by this exact container blueprint 

    contentsMatch: string 
    Search for templates whose content matches this wildcard-enabled string 

    deviceTypeId: ComponentId
    Search for templates associated with this device type 

    nameMatch: string 
    Search for templates whose name matches this wildcard-enabled string 

    vendorId: ComponentId
    Search for templates whose device type belongs to this vendor 
}

TimePeriodDTO

Click here to expand...


{ 
    timePeriodTypeId: integer * 
    What sort of time period this is 

    timePeriodTypeName: string 
    The meaning of the numeric timePeriodTypeId (read-only) 

    startTimestamp: date-time 
    The start date/time. Required only for certain user-defined time period types of After and Range; when the timestamp is missing the timezone, the server local timezone is assumed 
    Example: 2017-01-31T13:45:00.000+0000

    endTimestamp: date-time 
    The end date/time. Required only for certain user-defined time period types of Before and Range; when the timestamp is missing the timezone, the server local timezone is assumed 
    Example: 2017-01-31T13:45:00.000+0000
}

TranscriptSectionDTO

Click here to expand...


{ 
    interactions: string 
    The commands and responses that make up this part of the overall conversation with the device; or a bit of information emitted by an external script execution 

    properties: string 
    Any properties that were discovered during this part of the conversation; formatted as name=value and with newlines separating the individual properties (not populated for external script executions) 

    propertiesTitle: string 
    The name of this group of properties 

    title: string 
    The name of this part of the overall conversation 
}

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*