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

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

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

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

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

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

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

{
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{
    dynamicFieldFilters: {
      Any filters on dynamic fields; this is a map where the map key is the filter string (the value to be matched) and the map value is a ComponentId that identifies the dynamic field; menu-type dynamic fields support only exact matching; the filter string must be formatted properly when the dynamic field is a Date or Integer type
    }
 
    containsUnresolvableDynamicFieldFiltersFlag: boolean
    Indicates that one or more of the dynamic fields being filtered on no longer exists and thus re-using this filter may not result in the same outcome (read-only)
 
    accessModeId: integer
    Search for devices with this access mode
 
    addressMatch: string
    Search for devices matching this wildcard-enabled IP address or host name
 
    autoDspFlag: boolean
    Search for devices set for device security profile auto-discovery (true) or set to an explicit profile (false); null means do no auto-discovery mode filtering
 
    categoryId: integer
    Search for devices in this category
 
    createdTimePeriod: #TimePeriodDTO
   Search for devices created within this time period
 
    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; use "(Default)" to filter for devices using the default NIC
 
    deviceSecurityProfileName: string
    Search for devices whose device security profile equals this name
 
    deviceTypeGuid: string
    Search for devices whose device type equals this GUID
 
    filterAuxiliaryInterfaceFlag: boolean
    Whether or not to examine the auxiliary interface settings when matching on the interface-related fields (access mode, transfer mode, address, NAT address, device agent, 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 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 realm
 
    securityContextTypeId: integer
    Search for devices set to this type of security context
 
    transferModeId: integer
    Search for devices with this file transfer mode
 
    vendorGuid: string
    Search for devices whose device type belongs to this vendor
 
    noDiscrepanciesFlag: boolean
    Search for devices that have no discrepancies at all
 
    noDiscrepanciesIncludeFlag: boolean
    Whether to include (true) or exclude (false) devices that have no discrepancies
 
    osImageDiscrepancyFlag: boolean
    Search for devices that have an OS image discrepancy
 
    osImageDiscrepancyIncludeFlag: boolean
    Whether to include (true) or exclude (false) devices that have an OS image discrepancy
 
    runningStartupDiscrepancyFlag: boolean
    Search for devices that have a Running vs Startup discrepancy
 
    runningStartupDiscrepancyIncludeFlag: boolean
    Whether to include (true) or exclude (false) devices that have a Running vs Startup discrepancy
 
    runningTrustedDiscrepancyFlag: boolean
    Search for devices that have a Running vs Trusted Running discrepancy
 
    runningTrustedDiscrepancyIncludeFlag: boolean
    Whether to include (true) or exclude (false) devices that have a Running vs trusted Running discrepancy
 
    startupTrustedDiscrepancyFlag: boolean
    Search for devices that have a Startup vs Trusted Startup discrepancy
 
    startupTrustedDiscrepancyIncludeFlag: boolean
    Whether to include (true) or exclude (false) devices that have a Startup vs trusted Startup discrepancy
 
    noViolationsFlag: boolean
    Search for devices that have no compliance violations
 
    noViolationsIncludeFlag: boolean
    Whether to include (true) or exclude (false) devices that have no compliance violations
 
    includedViolationTrailGuids: [
      Include devices in the results that have a compliance violation in one of these trails
 
      string
    ]
 
    excludedViolationTrailGuids: [
      Exclude devices from the results that have a compliance violation in one of these trails
 
      string
    ]
 
    lastAttemptedSpanActionFlag: boolean
    Search for devices whose last attempted span action matches a particular completion status
 
    lastAttemptedSpanActionGuid: string
    When lastAttemptedSpanActionFlag is true, specifies which span action to examine
 
    lastAttemptedSpanActionStatusId: integer
    When lastAttemptedSpanActionFlag is true, specifies which completion status to search for
 
    lastAttemptedSpanActionErrorMatch: string
    When lastAttemptedSpanActionFlag is true, specifies which completion error message to search for, wildcards allowed
 
    lastSuccessfulSpanActionFlag: boolean
    Search for devices whose last successful span action occurred within a selected time period
 
    lastSuccessfulSpanActionGuid: string
    When lastSuccessfulSpanActionFlag is true, specifies which span action to examine
 
    lastSuccessfulSpanActionTimePeriod: #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
}

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

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

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

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

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

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