{
    segment: string
    One part or section of the configuration line
 
    segmentIsAclFlag: boolean
    Whether or not this part of the configuration line is the ACL that was searched for
}

{
    id: string
    A GUID that is a hook for further sorting, paging, exporting, and emailing of the report
 
    abortedByCapacityReachedFlag: boolean
    When the report generation was aborted, whether or not it was aborted by the system due to its content having reached the maximum allowed content size, as defined by global.properties; when true, it indicates you should use different input parameters to generate a smaller report
 
    abortedByUser: string
    When the report generation was aborted, the name of the user who manually aborted it
 
    canAccessSensitiveDataFlag: boolean
    Whether or not the user is allowed to view sensitive data; when false, any sensitive data in this report is masked
 
    canContainSensitiveDataFlag: boolean
    Whether or not this report might include sensitive data; note this does not indicate if the report does or does not contain actual sensitive data, but just that it is possible it could contain such data
 
    defaultEmailSubject: string
    Text that can be used as the subject line of an email containing this report
 
    inputParameters: ReportParametersDTO
   The selections used to generate the content, which can be used to refine or re-generate the report
 
    isAbortedFlag: boolean
    Whether or not the report generation was aborted; a report can be aborted by a user or by the system (when report capacity is reached or when the system is shut down); when true, it indicates the report content is incomplete
 
    subtitle: string
    Brief information about the most important report selection(s) suitable for display as a subtitle of the report
 
    supportsDetailsSubreportsFlag: boolean
    Whether or not this report supports export and email that includes all associated details reports
 
    supportedFormatIds: [
      The formats in which this report can be exported or emailed
 
      integer
    ]
 
    timestamp: date-time
    When this report was generated
     Example: 2017-01-31T13:45:00.000+0000
 
    allAcls: [
      All the ACLs found in the configuration, to help in selecting another ACL to report on
 
      string
    ]
 
    configuration: ReportedScriptInformationDTO
   The configuration that was searched
 
    results: [
      Information about whhere the selected ACL is found in the configuration
 
       AclSearchReportDetailsRowDTO
   ]
 
    targetAcl: string
    The specific ACL that was searched for
}

{
    acl: string*
    The specific ACL to search for
 
    configuration: ComponentId*
    The configuration to be searched
 
    showFullViewFlag: boolean
    Whether or not to show a full view of the configuration; when true, the report shows the entire configuration with the ACL indicated; when false, the report shows just the ACL-related lines, with a few lines of surrounding context
}

{
    id: string
    A GUID that is a hook for further sorting, paging, exporting, and emailing of the report
 
    abortedByCapacityReachedFlag: boolean
    When the report generation was aborted, whether or not it was aborted by the system due to its content having reached the maximum allowed content size, as defined by global.properties; when true, it indicates you should use different input parameters to generate a smaller report
 
    abortedByUser: string
    When the report generation was aborted, the name of the user who manually aborted it
 
    canAccessSensitiveDataFlag: boolean
    Whether or not the user is allowed to view sensitive data; when false, any sensitive data in this report is masked
 
    canContainSensitiveDataFlag: boolean
    Whether or not this report might include sensitive data; note this does not indicate if the report does or does not contain actual sensitive data, but just that it is possible it could contain such data
 
    defaultEmailSubject: string
    Text that can be used as the subject line of an email containing this report
 
    inputParameters: ReportParametersDTO
   The selections used to generate the content, which can be used to refine or re-generate the report
 
    isAbortedFlag: boolean
    Whether or not the report generation was aborted; a report can be aborted by a user or by the system (when report capacity is reached or when the system is shut down); when true, it indicates the report content is incomplete
 
    subtitle: string
    Brief information about the most important report selection(s) suitable for display as a subtitle of the report
 
    supportsDetailsSubreportsFlag: boolean
    Whether or not this report supports export and email that includes all associated details reports
 
    supportedFormatIds: [
      The formats in which this report can be exported or emailed
 
      integer
    ]
 
    timestamp: date-time
    When this report was generated
     Example: 2017-01-31T13:45:00.000+0000
 
    acls: [
      Information about each device and its matching ACLs
 
       PerDevicePerAclSearchResultDTO
   ]
 
    configurationDisplayString: string
    Displayable version of the selected configuration
 
    deviceFilterDisplayString: string
    When the network span is filtered, the displayable version of the device filtering selections
 
    selectedConfiguration: ReportedScriptInformationDTO
   Information about the selected configuration
 
    selectedNetworkSpan: ReportNetworkSpanDTO
   The network span being reported on; a null means the network span is the entire network
 
    skippedDevices: [
      Information about devices that were skipped
 
       SearchReportSkippedDeviceDTO
   ]
}

{
    data: string
    One line of text from the configuration or the transcript that was searched
 
    firstSkippedLineNumber: integer
    The line number that starts a range of skipped or hidden lines
 
    lastSkippedLineNumber: integer
    The line number that ends a range of skipped or hidden lines
 
    lineNumber: integer
    The line number where the data appears, where line numbering starts at one
 
    lineType: string
    What sort of information this object represents: MATCHED means this is a line that matched the subject; SKIPPED means this is a skipped range of non-matching lines; BLOCK_HEADER means this is the header of the block that contains the matched line; MATCHED_BLOCK_HEADER means this is a matched line that is also a block header line; CONTEXT_LINE means this is a line near the matched line, provided as context; ACL_DEFINED means this is a line the defines an ACL (in an ACL search report); ACL_USED means this is a line where an ACL is referenced (in an ACL search report); ACL_DEFINED_BLOCK_HEADER means this is the header of the block where an ACL is defined (in an ACL search report); ACL_USED_BLOCK_HEADER means this is the header of the block where an ACL is referenced (in an ACL search report)
 
    lineSegments: [
      The configuration line where the ACL appears, broken into parts, indicating which part(s) are the actual ACL reference and which are surrounding text
 
       AclRelatedConfigurationLineSegmentDTO
   ]
}

{
    backgroundGenerationAnnotation: string
    When the report is being generated in the background, an optional annotation or description that helps identify this particular report; will be truncated to 255 characters if this is too long
 
    backgroundGenerationNotifyViaEmailFlag: boolean
    When the report is being generated in the background, whether or not a notification is emailed to the requesting user when the report generation is finished and the report is ready for retrieval; note that the requesting user must be configured with an email address and system parameters must be configured with an SMTP gateway
 
    foregroundGenerationFlag: boolean
    Whether or not the report is to be generated in the foreground; when false, the report is generated in the background and stored to the database for later retrieval; when true, the report is generated in the foreground and returned to the caller immediately; ignored for details type reports and the license usage report (which are always foregrounded)
 
    configuration: ComponentId
   When configurationTypeId is for a keyed configuration and when networkSpan is a single device, selects the one specific configuration to be searched
 
    configurationTimestamp: date-time
    {{When configurationTypeId is historical, the date/time of the configuration }}
     Example: 2017-01-31T13:45:00.000+0000
 
    configurationTypeId: integer*
    Which configuration is to be searched in each device
 
    deviceFilter: DeviceFilterDTO
   Specifies which devices are included in the network span; must be null when the networkSpan refers to a single device
 
    networkSpan: ComponentId
   Selects the devices to be reported on; a null means to report on all accessible devices in the system
 
    showDefinedAndUsedFlag: boolean
    Whether or not to show devices where the selected ACL(s) are both defined and used
 
    showDefinedButUnusedFlag: boolean
    Whether or not to show devices where the selected ACL(s) are declared or defined, but are not used or referred to
 
    showMatchingDevicesFlag: boolean
    Whether or not show devices that contain the searched-for ACL, or that contain any ACL (when searching for all ACLs)
 
    showMatchingLinesFlag: boolean
    Whether or not the lines in the configuration that contain the ACL are included in the results
 
    showNonMatchingDevicesFlag: boolean
    Whether or not to show devices that do not contain the searched-for ACL, or that contain no ACLS (when searching for all ACLs)
 
    showUsedButUndefinedFlag: boolean
    Whether or not to show devices where the selected ACL(s) are used or referred to, but are not declared or defined
 
    targetAcl: string
    The specific ACL to search for; a null means to search for all ACLs
}

{
    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
 
    summary: string
    Brief summary of what this action does (read-only)
 
    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)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
}

{
    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
    ]
 
    numPending: integer
    The number of approvals that remain to be obtained at this step
 
    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
 
    summary: string
    Brief summary of what this action does (read-only)
 
    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)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
 
    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
}

{
    availableScripts: [
      Other scripts (configurations or templates) that can be compared to the script on the other side of the report
 
       ComponentId
   ]
 
    prompt: string
    When there are available scripts, the prompt for selecting from that collection of scripts
 
    templatesWithRuntimeParameters: [
      When the available scripts refer to templates, the database keys of the templates that have runtime parameters
 
      string
    ]
 
    trustedConfiguration: string
    When the available scripts refer to running or startup configurations, the database key of the trusted configuration
}

{
    backgroundGenerationAnnotation: string
    When the report is being generated in the background, an optional annotation or description that helps identify this particular report; will be truncated to 255 characters if this is too long
 
    backgroundGenerationNotifyViaEmailFlag: boolean
    When the report is being generated in the background, whether or not a notification is emailed to the requesting user when the report generation is finished and the report is ready for retrieval; note that the requesting user must be configured with an email address and system parameters must be configured with an SMTP gateway
 
    foregroundGenerationFlag: boolean
    Whether or not the report is to be generated in the foreground; when false, the report is generated in the background and stored to the database for later retrieval; when true, the report is generated in the foreground and returned to the caller immediately; ignored for details type reports and the license usage report (which are always foregrounded)
}

{
    id: string
    A GUID that is a hook for aborting the report generation request, and for retrieving the completed report content
}

{
    id: string
    A GUID that is a hook for further sorting, paging, exporting, and emailing of the report
 
    abortedByCapacityReachedFlag: boolean
    When the report generation was aborted, whether or not it was aborted by the system due to its content having reached the maximum allowed content size, as defined by global.properties; when true, it indicates you should use different input parameters to generate a smaller report
 
    abortedByUser: string
    When the report generation was aborted, the name of the user who manually aborted it
 
    canAccessSensitiveDataFlag: boolean
    Whether or not the user is allowed to view sensitive data; when false, any sensitive data in this report is masked
 
    canContainSensitiveDataFlag: boolean
    Whether or not this report might include sensitive data; note this does not indicate if the report does or does not contain actual sensitive data, but just that it is possible it could contain such data
 
    defaultEmailSubject: string
    Text that can be used as the subject line of an email containing this report
 
    inputParameters: ReportParametersDTO
   The selections used to generate the content, which can be used to refine or re-generate the report
 
    isAbortedFlag: boolean
    Whether or not the report generation was aborted; a report can be aborted by a user or by the system (when report capacity is reached or when the system is shut down); when true, it indicates the report content is incomplete
 
    subtitle: string
    Brief information about the most important report selection(s) suitable for display as a subtitle of the report
 
    supportsDetailsSubreportsFlag: boolean
    Whether or not this report supports export and email that includes all associated details reports
 
    supportedFormatIds: [
      The formats in which this report can be exported or emailed
 
      integer
    ]
 
    timestamp: date-time
    When this report was generated
     Example: 2017-01-31T13:45:00.000+0000
 
    changes: ScriptDifferencesReportDTO
   The differences between the two configurations
 
    eventsSinceNewerConfiguration: [
      The events that occurred on the device since the newer of the two configurations
 
       ChangeRelatedEventDTO
   ]
 
    eventsSinceNewerConfigurationRange: TimePeriodDTO
   The time range for the events populating the eventsSinceNewerConfiguration field
 
    interveningEvents: [
      The events that occurred on the device between the two configurations
 
       ChangeRelatedEventDTO
   ]
 
    interveningEventsRange: TimePeriodDTO
   The time range for the events populating the interveningEvents field
}

{
    eventRangeEndTimestamp: date-time
    When showEventsFlag is true, the timestamp to use as the bounding end time for the query for events since the newer configuration; when null, the current time is the end time; ideally, this should be the time the next change occurred after the newer configuration; when the timestamp is missing the timezone, the server local timezone is assumed
     Example: 2017-01-31T13:45:00.000+0000
 
    newerConfiguration: ComponentId*
    The newer configuration of the two configurations being compared
 
    olderConfiguration: ComponentId*
    The older configuration of the two configurations being compared
 
    showEventsFlag: boolean
    Whether or not to show events related to the device; when true, events that occurred between the older and the newer configurations, and events that occurred between the newer configuration and the eventRangeEndTimestamp, are included in the results, which can indicate the reason the change occurred
 
    showFullViewFlag: boolean
    Whether or not to show a full view of the configurations; when true, the report shows the entire configuration with the changes indicated; when false, the report shows just the changed lines, with a few lines of surrounding context
}

{
    category: string
    The event category
 
    description: string
    Description of the event
 
    name: string
    The event type
 
    severity: string
    The event severity
 
    source: string
    The source of the event, or what caused the event
 
    target: string
    The target of the event, or what was acted on
 
    timestamp: date-time
    Date and time the event occurred
     Example: 2017-01-31T13:45:00.000+0000
}

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

{
    id: string
    A GUID that is a hook for further sorting, paging, exporting, and emailing of the report
 
    abortedByCapacityReachedFlag: boolean
    When the report generation was aborted, whether or not it was aborted by the system due to its content having reached the maximum allowed content size, as defined by global.properties; when true, it indicates you should use different input parameters to generate a smaller report
 
    abortedByUser: string
    When the report generation was aborted, the name of the user who manually aborted it
 
    canAccessSensitiveDataFlag: boolean
    Whether or not the user is allowed to view sensitive data; when false, any sensitive data in this report is masked
 
    canContainSensitiveDataFlag: boolean
    Whether or not this report might include sensitive data; note this does not indicate if the report does or does not contain actual sensitive data, but just that it is possible it could contain such data
 
    defaultEmailSubject: string
    Text that can be used as the subject line of an email containing this report
 
    inputParameters: ReportParametersDTO
   The selections used to generate the content, which can be used to refine or re-generate the report
 
    isAbortedFlag: boolean
    Whether or not the report generation was aborted; a report can be aborted by a user or by the system (when report capacity is reached or when the system is shut down); when true, it indicates the report content is incomplete
 
    subtitle: string
    Brief information about the most important report selection(s) suitable for display as a subtitle of the report
 
    supportsDetailsSubreportsFlag: boolean
    Whether or not this report supports export and email that includes all associated details reports
 
    supportedFormatIds: [
      The formats in which this report can be exported or emailed
 
      integer
    ]
 
    timestamp: date-time
    When this report was generated
     Example: 2017-01-31T13:45:00.000+0000
 
    changes: [
      Changes that occurred in the selected trail to the devices in the network span within the selected time period
 
       PerDevicePerChangeResultDTO
   ]
 
    deviceFilterDisplayString: string
    When the network span is filtered, the displayable version of the device filtering selections
 
    selectedNetworkSpan: ReportNetworkSpanDTO
   The network span being reported on; a null means the network span is the entire network
 
    timePeriodDisplayString: string
    Displayable version of the time period that selected which changes are included in this report
 
    unchangedDevices: [
      Devices that had no changes in the selected trail during the selected time period
 
       ReportNetworkSpanDTO
   ]
}

{
    backgroundGenerationAnnotation: string
    When the report is being generated in the background, an optional annotation or description that helps identify this particular report; will be truncated to 255 characters if this is too long
 
    backgroundGenerationNotifyViaEmailFlag: boolean
    When the report is being generated in the background, whether or not a notification is emailed to the requesting user when the report generation is finished and the report is ready for retrieval; note that the requesting user must be configured with an email address and system parameters must be configured with an SMTP gateway
 
    foregroundGenerationFlag: boolean
    Whether or not the report is to be generated in the foreground; when false, the report is generated in the background and stored to the database for later retrieval; when true, the report is generated in the foreground and returned to the caller immediately; ignored for details type reports and the license usage report (which are always foregrounded)
 
    configurationTrail: ComponentId*
    Search for changes to configurations of this trail
 
    deviceFilter: DeviceFilterDTO
   Specifies which devices are included in the network span; must be null when the networkSpan refers to a single device
 
    externalChangeFilteringFlag: boolean
    Search for the source of the changes; when true, searches for changes from jobs that were triggered by an external event or that ran a snapshot (picking up a change made to the device by means outside the system); when false, searches for changes from jobs that internally made the changes; when null, no change source filtering is done
 
    networkSpan: ComponentId
   Selects the devices to be reported on; a null means to report on all accessible devices in the system
 
    originatingUserMatch: string
    Search for changes that originated in a job run by this wildcard-enabled username
 
    showEventsFlag: boolean
    Whether or not to include a count of the events that occurred between changes
 
    timePeriod: TimePeriodDTO*
    Search for configuration changes that occurred within this time range
}

{
    backgroundGenerationAnnotation: string
    When the report is being generated in the background, an optional annotation or description that helps identify this particular report; will be truncated to 255 characters if this is too long
 
    backgroundGenerationNotifyViaEmailFlag: boolean
    When the report is being generated in the background, whether or not a notification is emailed to the requesting user when the report generation is finished and the report is ready for retrieval; note that the requesting user must be configured with an email address and system parameters must be configured with an SMTP gateway
 
    foregroundGenerationFlag: boolean
    Whether or not the report is to be generated in the foreground; when false, the report is generated in the background and stored to the database for later retrieval; when true, the report is generated in the foreground and returned to the caller immediately; ignored for details type reports and the license usage report (which are always foregrounded)
 
    configurationTrail: ComponentId*
    Search for changes to configurations of this trail
 
    deviceFilter: DeviceFilterDTO
   Specifies which devices are included in the network span; must be null when the networkSpan refers to a single device
 
    externalChangeFilteringFlag: boolean
    Search for the source of the changes; when true, searches for changes from jobs that were triggered by an external event or that ran a snapshot (picking up a change made to the device by means outside the system); when false, searches for changes from jobs that internally made the changes; when null, no change source filtering is done
 
    networkSpan: ComponentId
   Selects the devices to be reported on; a null means to report on all accessible devices in the system
 
    originatingUserMatch: string
    Search for changes that originated in a job run by this wildcard-enabled username
 
    showEventsFlag: boolean
    Whether or not to include a count of the events that occurred between changes
 
    timePeriod: TimePeriodDTO*
    Search for configuration changes that occurred within this time range
}

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

{
    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
 
    summary: string
    Brief summary of what this action does (read-only)
 
    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)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
 
    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
}

{
}

{
    id: string
    A GUID that is a hook for further sorting, paging, exporting, and emailing of the report
 
    abortedByCapacityReachedFlag: boolean
    When the report generation was aborted, whether or not it was aborted by the system due to its content having reached the maximum allowed content size, as defined by global.properties; when true, it indicates you should use different input parameters to generate a smaller report
 
    abortedByUser: string
    When the report generation was aborted, the name of the user who manually aborted it
 
    canAccessSensitiveDataFlag: boolean
    Whether or not the user is allowed to view sensitive data; when false, any sensitive data in this report is masked
 
    canContainSensitiveDataFlag: boolean
    Whether or not this report might include sensitive data; note this does not indicate if the report does or does not contain actual sensitive data, but just that it is possible it could contain such data
 
    defaultEmailSubject: string
    Text that can be used as the subject line of an email containing this report
 
    inputParameters: ReportParametersDTO
   The selections used to generate the content, which can be used to refine or re-generate the report
 
    isAbortedFlag: boolean
    Whether or not the report generation was aborted; a report can be aborted by a user or by the system (when report capacity is reached or when the system is shut down); when true, it indicates the report content is incomplete
 
    subtitle: string
    Brief information about the most important report selection(s) suitable for display as a subtitle of the report
 
    supportsDetailsSubreportsFlag: boolean
    Whether or not this report supports export and email that includes all associated details reports
 
    supportedFormatIds: [
      The formats in which this report can be exported or emailed
 
      integer
    ]
 
    timestamp: date-time
    When this report was generated
     Example: 2017-01-31T13:45:00.000+0000
}

{
    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
 
    summary: string
    Brief summary of what this action does (read-only)
 
    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)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
 
    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
 
    ruleSets: [
      The rule sets to be reported on; when null/empty, then this action reports on all rule sets
 
       ComponentId
   ]
}

{
    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
 
    whichTrailId: ComponentId
   When the script or configuration type is other current, specifies which other trail is to be reported on
}

{
    backgroundGenerationAnnotation: string
    When the report is being generated in the background, an optional annotation or description that helps identify this particular report; will be truncated to 255 characters if this is too long
 
    backgroundGenerationNotifyViaEmailFlag: boolean
    When the report is being generated in the background, whether or not a notification is emailed to the requesting user when the report generation is finished and the report is ready for retrieval; note that the requesting user must be configured with an email address and system parameters must be configured with an SMTP gateway
 
    foregroundGenerationFlag: boolean
    Whether or not the report is to be generated in the foreground; when false, the report is generated in the background and stored to the database for later retrieval; when true, the report is generated in the foreground and returned to the caller immediately; ignored for details type reports and the license usage report (which are always foregrounded)
 
    configuration: ComponentId
   When configurationTypeId is for a keyed configuration and when networkSpan is a single device, selects the one specific configuration to be checked for rule compliance
 
    configurationTimestamp: date-time
    When configurationTypeId is historical, the date/time of the configuration to be checked for rule compliance, which selects the configuration in effect at this date/time; when the timestamp is missing the timezone, the server local timezone is assumed
     Example: 2017-01-31T13:45:00.000+0000
 
    configurationTrail: ComponentId
   When configurationTypeId is for other trails, the selected configuration trail
 
    configurationTypeId: integer*
    Which configuration is to be checked for rule compliance
 
    deviceFilter: DeviceFilterDTO
   Which devices are included in the network span; ignored when the networkSpan refers to a device
 
    enforceables: [
      Which rules and/or rule sets are to be checked for compliance; when null, all accessible rule sets and their member rules are checked
 
       ComponentId
   ]
 
    forceReevaluationFlag: boolean
    When includeOnlyDevicesAssignedToEnforceablesFlag is true, whether or not the selected rules are evaluated per device as part of report generation, which can take a long time; when false, stored compliance status calculated during the most recent configuration change or Refresh Device Status action is used to populate the report, which is always faster than re-evaluation
 
    includeDeviceAddressesFlag: boolean
    Whether or not the results include the primary interface IP address or hostname information for each device
 
    includeOnlyDevicesAssignedToEnforceablesFlag: boolean
    Whether or not the results include only devices that are assigned to the selected rule sets or rules; when true, the included and excluded spans are considered and only enabled rule sets are included; when false, the included and excluded spans are ignored and both enabled and disabled rule sets are included; a false value causes evaluation of the rules, which can take a long time
 
    includeOnlyDevicesWithCurrentViolations: boolean
    Whether or not the results include only devices that have a current compliance violation, and include only the rules in violation
 
    includeOnlyRulesCorrectableBySpanActionGuid: string
    Selects only rules that can be corrected by running this type of span action (deploy to active or deploy to stored), by the action GUID; when null, rules are not filtered by their corrective actions
 
    includeSecurityVulnerabilityBaseScoresFlag: boolean
    Whether or not the results include the base score of any associated security vulnerability for each rule
 
    networkSpan: ComponentId
   Selects the devices to be reported on; a null means to report on all accessible devices in the system
 
    ruleCategories: [
      Which rules are to be included in the results, filtered by the selected categories; when null or empty, no category-based filtering of rules is done
 
      string
    ]
 
    ruleFilter: RuleFilterDTO
   Which rules are to be included in the results
 
    ruleSeverityIds: [
      Which rules are to be included in the results, filtered by the selected severity levels; at least one severity is required when reporting on one or more rule sets
 
      integer
    ]
 
    showStatusFailedFlag: boolean
    Whether or not the results include rules found to be in violation per device
 
    showStatusNonApplicableFlag: boolean
    Whether or not the results include rules found to be inapplicable per device
 
    showStatusSuccessFlag: boolean
    Whether or not the results include rules found to be in compliance per device
 
    viewByRuleFlag: boolean
    Whether or not a display of the results should give priority to rules (true) or to devices (false) in column ordering; this has no effect on report generation, but it does affect sorting
}

{
    complianceStatus: string
    Overall result of testing the rule against the configuration
 
    configuration: ReportedScriptInformationDTO
   The configuration or target configuration that is traced
 
    device: ReportNetworkSpanDTO
   The device that owns the traced configuration or target configuration
 
    deviceType: ComponentId
   The device type associated with the device
 
    evaluationErrorMessage: string
    When an error has occurred, the details about the nature of the error
 
    inputParameters: ComplianceTraceParametersDTO
   The parameters used to create this trace
 
    rule: RuleDTO
   The rule that is traced
 
    traces: [
      The details about the configuration lines and the changes or corrections needed to make them compliant with the rule; there is one trace per rule trigger, or one trace overall if the rule has no trigger; a trace can be very large, so only the specified page of traces is included here
 
       PerTriggerComplianceTraceDTO
   ]
}

{
    configuration: ComponentId
   The configuration to be traced; only one of the two fields, configuration or deviceForTargetConfiguration, can be specified
 
    deviceForTargetConfiguration: ComponentId
   The device for which the target configuration is traced; only one of the two fields, configuration or deviceForTargetConfiguration, can be specified
 
    doExportFlag: boolean
    Whether or not the resulting trace is to be exported; when true, the trace is exported as XML; when false, the trace is formatted into a ComplianceTraceDTO
 
    rule: ComponentId
   The rule to be traced
}

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

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

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

{
    id: string
    A GUID that is a hook for further sorting, paging, exporting, and emailing of the report
 
    abortedByCapacityReachedFlag: boolean
    When the report generation was aborted, whether or not it was aborted by the system due to its content having reached the maximum allowed content size, as defined by global.properties; when true, it indicates you should use different input parameters to generate a smaller report
 
    abortedByUser: string
    When the report generation was aborted, the name of the user who manually aborted it
 
    canAccessSensitiveDataFlag: boolean
    Whether or not the user is allowed to view sensitive data; when false, any sensitive data in this report is masked
 
    canContainSensitiveDataFlag: boolean
    Whether or not this report might include sensitive data; note this does not indicate if the report does or does not contain actual sensitive data, but just that it is possible it could contain such data
 
    defaultEmailSubject: string
    Text that can be used as the subject line of an email containing this report
 
    inputParameters: ReportParametersDTO
   The selections used to generate the content, which can be used to refine or re-generate the report
 
    isAbortedFlag: boolean
    Whether or not the report generation was aborted; a report can be aborted by a user or by the system (when report capacity is reached or when the system is shut down); when true, it indicates the report content is incomplete
 
    subtitle: string
    Brief information about the most important report selection(s) suitable for display as a subtitle of the report
 
    supportsDetailsSubreportsFlag: boolean
    Whether or not this report supports export and email that includes all associated details reports
 
    supportedFormatIds: [
      The formats in which this report can be exported or emailed
 
      integer
    ]
 
    timestamp: date-time
    When this report was generated
     Example: 2017-01-31T13:45:00.000+0000
 
    deviceFilterDisplayString: string
    When the network span is filtered, the displayable version of the device filtering selections
 
    leftSideNetworkSpan: ReportNetworkSpanDTO
   The network span selected fro comparison on the left side
 
    leftSideScriptDisplayString: string
    The scripts selected for comparison on the left side
 
    leftSideSelectedConfiguration: ReportedScriptInformationDTO
   The configuration selected for comparison on the left side
 
    results: [
      The results of comparing the selected scripts
 
       PerScriptComparisonResultDTO
   ]
 
    rightSideNetworkSpan: ReportNetworkSpanDTO
   The network span selected for comparison on the right side
 
    rightSideScriptDisplayString: string
    The scripts selected for comparison on the right side
 
    rightSideSelectedConfiguration: ReportedScriptInformationDTO
   The configuration selected for comparison on the right side
 
    skippedDevices: [
      When there was a network span selected, lists the devices whose configurations were not compared for some reason
 
       SkippedDeviceComparisonDTO
   ]
}

{
    backgroundGenerationAnnotation: string
    When the report is being generated in the background, an optional annotation or description that helps identify this particular report; will be truncated to 255 characters if this is too long
 
    backgroundGenerationNotifyViaEmailFlag: boolean
    When the report is being generated in the background, whether or not a notification is emailed to the requesting user when the report generation is finished and the report is ready for retrieval; note that the requesting user must be configured with an email address and system parameters must be configured with an SMTP gateway
 
    foregroundGenerationFlag: boolean
    Whether or not the report is to be generated in the foreground; when false, the report is generated in the background and stored to the database for later retrieval; when true, the report is generated in the foreground and returned to the caller immediately; ignored for details type reports and the license usage report (which are always foregrounded)
 
    deviceFilter: DeviceFilterDTO
   Specifies which devices are included in the network span; ignored when the leftSide or rightSide component refers to a device
 
    leftSide: ScriptComparisonParametersDTO*
    One of the scripts or types of scripts to be compared, to be visualized as the left-hand side of a side-by-side display; if the component is a network span, it may refer to a device, a group, a combo group, or a realm
 
    rightSide: ScriptComparisonParametersDTO*
    One of the scripts or types of scripts to be compared, to be visualized as the right-hand side of a side-by-side display; if the component is a network span, it may refer to a device, a group, a combo group, or a realm
 
    spanActionGuid: string
    Specifies which span action (deploy to active or deploy to stored) this report is being generated for, when asking for the report as a preview of what the action will do;required when selecting historical trail(s) by date for all applicable trails, so that the trails applicable to the right type of deploy action are found for each device; when null, indicates this report is not being created from a span action context
}

{
    id: string
    A GUID that is a hook for further sorting, paging, exporting, and emailing of the report
 
    abortedByCapacityReachedFlag: boolean
    When the report generation was aborted, whether or not it was aborted by the system due to its content having reached the maximum allowed content size, as defined by global.properties; when true, it indicates you should use different input parameters to generate a smaller report
 
    abortedByUser: string
    When the report generation was aborted, the name of the user who manually aborted it
 
    canAccessSensitiveDataFlag: boolean
    Whether or not the user is allowed to view sensitive data; when false, any sensitive data in this report is masked
 
    canContainSensitiveDataFlag: boolean
    Whether or not this report might include sensitive data; note this does not indicate if the report does or does not contain actual sensitive data, but just that it is possible it could contain such data
 
    defaultEmailSubject: string
    Text that can be used as the subject line of an email containing this report
 
    inputParameters: ReportParametersDTO
   The selections used to generate the content, which can be used to refine or re-generate the report
 
    isAbortedFlag: boolean
    Whether or not the report generation was aborted; a report can be aborted by a user or by the system (when report capacity is reached or when the system is shut down); when true, it indicates the report content is incomplete
 
    subtitle: string
    Brief information about the most important report selection(s) suitable for display as a subtitle of the report
 
    supportsDetailsSubreportsFlag: boolean
    Whether or not this report supports export and email that includes all associated details reports
 
    supportedFormatIds: [
      The formats in which this report can be exported or emailed
 
      integer
    ]
 
    timestamp: date-time
    When this report was generated
     Example: 2017-01-31T13:45:00.000+0000
 
    configuration: ReportedScriptInformationDTO
   The configuration that was searched
 
    errorMessage: string
    Any error that occurred while generating the report
 
    results: [
      Information about each line in the configuration
 
       SearchReportDetailsRowDTO
   ]
}

{
    configuration: ComponentId*
    The configuration to be searched
 
    selectedBlocks: ConfigurationSearchReportDomainBlocksDTO
   The portion of the configuration to be searched for subject matches; when null, the entire configuration is searched
 
    showFullViewFlag: boolean
    Whether or not to show a full view of the configuration; when true, the report shows the entire configuration with the matches indicated; when false, the report shows just the matched lines, with a few lines of surrounding context
 
    subject: SearchReportSubjectDTO*
    What text to search for in the configuration
}

{
    id: string
    A GUID that is a hook for further sorting, paging, exporting, and emailing of the report
 
    abortedByCapacityReachedFlag: boolean
    When the report generation was aborted, whether or not it was aborted by the system due to its content having reached the maximum allowed content size, as defined by global.properties; when true, it indicates you should use different input parameters to generate a smaller report
 
    abortedByUser: string
    When the report generation was aborted, the name of the user who manually aborted it
 
    canAccessSensitiveDataFlag: boolean
    Whether or not the user is allowed to view sensitive data; when false, any sensitive data in this report is masked
 
    canContainSensitiveDataFlag: boolean
    Whether or not this report might include sensitive data; note this does not indicate if the report does or does not contain actual sensitive data, but just that it is possible it could contain such data
 
    defaultEmailSubject: string
    Text that can be used as the subject line of an email containing this report
 
    inputParameters: ReportParametersDTO
   The selections used to generate the content, which can be used to refine or re-generate the report
 
    isAbortedFlag: boolean
    Whether or not the report generation was aborted; a report can be aborted by a user or by the system (when report capacity is reached or when the system is shut down); when true, it indicates the report content is incomplete
 
    subtitle: string
    Brief information about the most important report selection(s) suitable for display as a subtitle of the report
 
    supportsDetailsSubreportsFlag: boolean
    Whether or not this report supports export and email that includes all associated details reports
 
    supportedFormatIds: [
      The formats in which this report can be exported or emailed
 
      integer
    ]
 
    timestamp: date-time
    When this report was generated
     Example: 2017-01-31T13:45:00.000+0000
 
    configurationDisplayString: string
    When searching in a single configuration, the displayable version of the selected configuration
 
    configurationTimePeriodDisplayString: string
    Displayable version of the configuration time period
 
    deviceFilterDisplayString: string
    When the network span is filtered, the displayable version of the device filtering selections
 
    results: [
      The search results for each configuration
 
       PerDevicePerConfigurationSearchResultDTO
   ]
 
    selectedConfiguration: ReportedScriptInformationDTO
   Information about the selected configuration
 
    selectedNetworkSpan: ReportNetworkSpanDTO
   The network span being reported on; a null means the network span is the entire network
 
    skippedDevices: [
      Information about devices that were skipped
 
       SearchReportSkippedDeviceDTO
   ]
}

{
    begin: string*
    The configuration line that starts a block of contiguous lines
 
    beginIsPatternFlag: boolean
    Whether or not the 'begin' field represents a regex pattern (true) or an exact complete line (false)
 
    caseSensitiveFlag: boolean
    Whether or not string matching is case sensitive
 
    end: string*
    The configuration line that ends a block of contiguous lines
 
    endIsPatternFlag: boolean
    Whether or not the 'end' field represents a regex pattern (true) or an exact complete line (false)
 
    ignoreBlocksContainingPattern: string
    Regular expression to select blocks to be removed from the domain; when this pattern is matched by at least one line within a block, then that block is ignored
}

{
    backgroundGenerationAnnotation: string
    When the report is being generated in the background, an optional annotation or description that helps identify this particular report; will be truncated to 255 characters if this is too long
 
    backgroundGenerationNotifyViaEmailFlag: boolean
    When the report is being generated in the background, whether or not a notification is emailed to the requesting user when the report generation is finished and the report is ready for retrieval; note that the requesting user must be configured with an email address and system parameters must be configured with an SMTP gateway
 
    foregroundGenerationFlag: boolean
    Whether or not the report is to be generated in the foreground; when false, the report is generated in the background and stored to the database for later retrieval; when true, the report is generated in the foreground and returned to the caller immediately; ignored for details type reports and the license usage report (which are always foregrounded)
 
    annotationMatch: string
    Search for configurations whose annotation matches this wildcard-enabled string
 
    changeIdMatch: string
    Search for configurations whose change ID matches this wildcard-enabled string
 
    configuration: ComponentId
   When configurationTypeId is for a keyed configuration and when networkSpan is a single device, selects the one specific configuration to be searched
 
    configurationTimePeriod: TimePeriodDTO
   When searching multiple configurations, selects configurations that were created within this time period
 
    configurationTimestamp: date-time
    When configurationTypeId is historical, the date/time of the configurations to be searched
     Example: 2017-01-31T13:45:00.000+0000
 
    configurationTrail: ComponentId
   The selected configuration trail to be searched; required when searching multiple configurations
 
    configurationTypeId: integer
    Which configuration is to be searched in each device; required when searching a single configuration
 
    deviceFilter: DeviceFilterDTO
   Specifies which devices are included in the network span; must be null when the networkSpan refers to a single device
 
    jobIdMatch: string
    Search for configurations whose job ID matches this wildcard-enabled string
 
    networkSpan: ComponentId
   Selects the devices to be reported on; a null means to report on all accessible devices in the system
 
    searchMultipleConfigurationsFlag: boolean
    Whether or not to search multiple configurations in each device in the selected network span
 
    selectedBlocks: ConfigurationSearchReportDomainBlocksDTO
   The portion of the configuration to search for subject matches; when null the entire configuration is considered
 
    showMatchingDevicesFlag: boolean
    Whether or not show the devices that match the search criteria
 
    showMatchingLinesFlag: boolean
    Whether or not the lines in the configuration that match the search criteria are included in the results
 
    showNonMatchingDevicesFlag: boolean
    Whether or not to show the devices that do not match the search criteria
 
    subject: SearchReportSubjectDTO
   The text to search for
}

{
    commitFlag: boolean
    Whether or not to commit changes after running the commands in the custom action
 
    guid: string*
    The GUID that identifies the type of action
 
    markAsTrustedFlag: boolean
    Whether or not any changed configurations resulting from running this action should be marked as trusted
 
    name: string
    The type of action referred to by the GUID (read-only)
 
    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
    }
 
    runtimePropertiesMasked: {
      Name/value pairs for any runtime parameters, with passwords masked for display; this is a map where the key is the property name string and the value is the property value string (masked if it is a password; read-only)
    }
}

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

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

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

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

{
}

{
    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
 
    summary: string
    Brief summary of what this action does (read-only)
 
    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)
 
    hasActionLevelResultsFlag: boolean
    Whether or not this action has executed and has action-level results available for review (read-only)
 
    subactions: [
      Any sub-actions generated at execution time, ordered by sub-action number (read-only)
 
       ActionDTO
   ]
 
    transcriptSections: {
      When this action accesses devices, which sections can appear in device interaction transcripts; the map key is the string name of the transcript section; the map value is the string GUID of the transcript section; when null, indicates that this type of action does not access devices (does not log in to devices nor make changes to their configurations)
    }
 
    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
    }
 
    runtimePropertiesMasked: {
      Name/value pairs for any runtime parameters, with passwords masked for display; this is a map where the key is the property name string and the value is the property value string (masked if it is a password; read-only)
    }
}