MarketApiDTO
Description
Model to describe a Market
Optional Parameters
- uuid
-
-
type: string
-
- displayName
-
-
type: string
-
description: A user readable name of the api object. Cannot be blank. The UTF-8 encoding must be at most 255 bytes.
-
- className
-
-
type: string
-
- state
-
-
type: string
-
description: State
-
enum: ['CREATED', 'READY_TO_START', 'RUNNING', 'COPYING', 'SUCCEEDED', 'STOPPING', 'STOPPED', 'DELETING']
-
- stateProgress
-
-
type: integer
-
format: int32
-
description: State progress indicated by a percentage, used in RUNNING state
-
- scenario
-
-
description: Scenario used to create the Plan, only for Plan Market
-
reference: ScenarioApiDTO
-
- saved
-
-
type: boolean
-
description: Shows if a Plan Market is saved
-
- unplacedEntities
-
-
type: boolean
-
description: Unplaced entities, shows if there are entities that could not be placed in the Plan Market
-
- runDate
-
-
type: string
-
description: Shows when a Plan Market started running
-
- runCompleteDate
-
-
type: string
-
description: Shows when a Plan Market was completed
-
- violations
-
-
type: array
-
description: Violations generated in a Plan Market
-
-
reference: ServiceEntityApiDTO
-
-
- relatedPlanMarkets
-
-
type: array
-
description: Related Plan Markets generated by particular Scenarios
-
-
reference: MarketApiDTO
-
-
- environmentType
-
-
type: string
-
description: Environment type
-
enum: ['HYBRID', 'CLOUD', 'ONPREM']
-
- planDestination
-
-
description: Plan destination where the plan results would be stored, only for Plan Market.
-
reference: BaseApiDTO
-