Use cases for managing placement scenarios

This sections discusses the following use cases related to managing placement advice scenarios for the Capacity-Aware Placement Advice service:

Use Case

Description

Create a scenario

Create a placement advice scenario

Update a scenario

Update an existing placement advice scenario

Delete a scenario

Delete an existing placement advice scenario

Add a list of candidates to a scenario

Add a list of existing candidates to a placement advice scenario

Add a list of targets to a scenario

Add a list of existing targets to a placement advice scenario

Remove a list of candidates from a scenario

Remove a list of candidates from a placement advice scenario

Remove a list of targets from a scenario

Remove a list of targets from a placement advice scenario

Search for a candidate inside a scenario

Search inside a placement advice scenario for a candidate matching a set of properties

Search for a target inside a scenario

Search inside a placement advice scenario for a target matching a set of properties

Get the status of a scenario

Obtain the complete status of a placement advice scenario

Create a scenario

Description

Create a placement advice scenario

URL

dh-services/placementAdvice/scenario

HTTP Method

POST

Path Parameters

None

HTTP Body

ScenarioInput

Output

ManagementOutput

Update scenario

Description

Update an existing placement advice scenario

URL

dh-services/placementAdvice/scenario/{scenarioid}

HTTP Method

POST

Path Parameters

scenarioid: the BMC TrueSight Capacity Optimization placement advice scenario identifier

HTTP Body

ScenarioInput

Output

ManagementOutput

Delete a scenario

Description

Delete an existing placement advice scenario

URL

dh-services/placementAdvice/scenario/{scenarioid}

HTTP Method

DELETE

Path Parameters

scenarioid: the BMC TrueSight Capacity Optimization placement advice scenario identifier

HTTP Body

None

Output

ManagementOutput

Add candidates to a scenario

Description

Add a list of existing candidates to a placement advice scenario

URL

dh-services/placementAdvice/candidate/scenario/{scenarioId}

HTTP Method

PUT

Path Parameters

scenarioid: the BMC TrueSight Capacity Optimization placement advice scenario identifier

HTTP Body

MachinesInput

Output

ManagementOutput

Add targets to a scenario

Description

Add a list of existing targets to a placement advice scenario

URL

dh-services/placementAdvice/target/scenario/{scenarioId}

HTTP Method

PUT

Path Parameters

scenarioid: the BMC TrueSight Capacity Optimization placement advice scenario identifier

HTTP Body

MachinesInput

Output

ManagementOutput

Remove candidates from a scenario

Description

Remove a list of candidates from a placement advice scenario

URL

dh-services/placementAdvice/candidate/scenario/{scenarioId}

HTTP Method

DELETE

Path Parameters

scenarioid: the BMC TrueSight Capacity Optimization placement advice scenario identifier

HTTP Body

MachinesInput

Output

ManagementOutput

Remove targets from a scenario

Description

Remove a list of targets from a placement advice scenario

URL

dh-services/placementAdvice/target/scenario/{scenarioId}

HTTP Method

DELETE

Path Parameters

scenarioid: the BMC TrueSight Capacity Optimization placement advice scenario identifier

HTTP Body

MachinesInput

Output

ManagementOutput

Search for a candidate in a scenario

Description

Search inside a placement advice scenario for a candidate matching input properties

URL

dh-services/placementAdvice/candidate/search/{scenarioId}

HTTP Method

POST

Path Parameters

scenarioid: the BMC TrueSight Capacity Optimization placement advice scenario identifier

HTTP Body

CandidateLookupInfo

Output

CandidateManagementOutput

Search for a target in a scenario

Description

Search inside a placement advice scenario for a target matching input properties

URL

dh-services/placementAdvice/target/search/{scenarioId}

HTTP Method

POST

Path Parameters

scenarioid: the BMC TrueSight Capacity Optimization placement advice scenario identifier

HTTP Body

TargetLookupInfo

Output

TargetManagementOutput

Get the status of a scenario

Description

Obtain the complete status of a placement advice scenario, including contained candidates and targets with data, scenario options and properties

URL

dh-services/placementAdvice/scenarioStatus/{scenarioId}

HTTP Method

GET

Path Parameters

scenarioid: the BMC TrueSight Capacity Optimization placement advice scenario identifier

HTTP Body

None

Output

ScenarioStatusOutput

Was this page helpful? Yes No Submitting... Thank you

Comments