ActionResourceImpactStatApiInputDTO

Description

Model to describe an input for Action Resource Impact Stats

Required Parameters

actionResourceImpactStatList

• type: array

• description: List of Action Resource Impact Stat Inputs

• • reference: ActionResourceImpactStatInput

Optional Parameters

actionStateList

• type: array

• description: List of States to filter.

• • type: string

  • enum: ['ACCEPTED', 'REJECTED', 'PRE_IN_PROGRESS', 'POST_IN_PROGRESS', 'IN_PROGRESS', 'SUCCEEDED', 'FAILED', 'DISABLED', 'QUEUED', 'CLEARED', 'ACCOUNTING', 'READY', 'FAILING', 'BEFORE_EXEC', 'IN_PROGRESS_NON_CRITICAL']

actionModeList

• type: array

• description: List of Modes to filter

• • type: string

  • enum: ['DISABLED', 'RECOMMEND', 'EXTERNAL_APPROVAL', 'MANUAL', 'AUTOMATIC', 'COLLECTION']

riskSeverityList

• type: array

• description: List of Risk Severities to filter

• • type: string

riskSubCategoryList

• type: array

• description: List of Risk Severities to filter

• • type: string

actionRelationTypeFilter

• type: array

• description: Filters the main list of actions based on the types of relationships they have to other actions.

• • type: string

  • enum: ['NONE', 'BLOCKED_BY', 'BLOCKING', 'CAUSED_BY', 'CAUSING']

environmentType

• type: string

• description: Filter the actions by Environment Type

• enum: ['ONPREM', 'CLOUD']

costType

• type: string

• description: Filter the actions by cost Type

• enum: ['SAVING', 'INVESTMENT']

descriptionQuery

• description: This query will match the details field of the ActionApiDTO to return actions that match the specified expression.

• reference: QueryInputApiDTO

riskQuery

• description: This query will match the risk description field of the ActionApiDTO to return actions that match the specified expression.

• reference: QueryInputApiDTO

executionCharacteristics

• description: Characteristics of the execution of the action, including disruptiveness and reversibility.

• reference: ActionExecutionCharacteristicInputApiDTO

savingsAmountRange

• description: This field will match the costPrice statistic field of the ActionApiDTO to return actions that have a costPrice amount between minValue and maxValue, inclusive

• reference: RangeInputApiDTO

effectiveCostSavingsAmountRange

• description: This field will match the effectiveCost statistic field of the ActionApiDTO to return actions that have an effectiveCost amount between minValue and maxValue, inclusive

• reference: RangeInputApiDTO

unattachedDays

• description: This field will match the unattachedDays resource impacts field of the ActionResourceImpactStatApiInputDTO to return actions that have a unattachedDays count between minValue and maxValue, inclusive

• reference: RangeInputApiDTO

hasSchedule

• type: boolean

• description: If true, only actions that have an associated execution schedule will be returned.

hasPrerequisites

• type: boolean

• description: If true, only actions that have a prerequisite preventing execution of the action will be returned.