Use cases for managing candidates and targets

This section discusses the following set of use cases related to the management of candidates and targets for the Capacity-Aware Placement Advice service:

Use Case

Description

Create a candidate

Create a candidate template with input configuration

Update a candidate

Update an existing candidate template with input configuration

Create a target

Create a target template with input configuration

Update a target

Update an existing target template with input configuration

Search for a candidate

Search for an existing candidate matching a set of properties

Search for a target

Search for an existing target matching a set of properties

Delete a candidate

Delete a list of existing candidates

Delete a target

Delete a list of existing targets

Create a candidate

Description

Create a candidate template with input configuration

URL

dh-services/placementAdvice/candidate

HTTP Method

POST

Path Parameters

None

HTTP Body

CandidateTemplateInfo

Output

ManagementOutput

Update a candidate

Description

Update an existing candidate template with input configuration

URL

dh-services/placementAdvice/candidate/{candidateid}

HTTP Method

POST

Path Parameters

candidateid: the BMC TrueSight Capacity Optimization placement advice candidate identifier

HTTP Body

CandidateTemplateInfo

Output

ManagementOutput

Create a target

Description

Create a target template with input configuration

URL

dh-services/placementAdvice/target

HTTP Method

POST

Path Parameters

None

HTTP Body

TargetTemplateInfo

Output

ManagementOutput

Update a target

Description

Update an existing target template with input configuration

URL

dh-services/placementAdvice/target/{targetid}

HTTP Method

POST

Path Parameters

targetid: the BMC TrueSight Capacity Optimization placement advice target identifier

HTTP Body

TargetTemplateInfo

Output

ManagementOutput

Search for a candidate

Description

Search for an existing candidate matching input properties

URL

dh-services/placementAdvice/candidate/search

HTTP Method

POST

Path Parameters

None

HTTP Body

CandidateLookupInfo

Output

CandidateManagementOutput

Search for a target

Description

Search for an existing target matching input properties

URL

dh-services/placementAdvice/target/search

HTTP Method

POST

Path Parameters

None

HTTP Body

TargetLookupInfo

Output

TargetManagementOutput

Delete a candidate

Description

Delete the input list of existing candidates

URL

dh-services/placementAdvice/candidate

HTTP Method

DELETE

Path Parameters

None

HTTP Body

MachinesInput

Output

ManagementOutput

Delete a target

Description

Delete the input list of existing candidates

URL

dh-services/placementAdvice/target

HTTP Method

DELETE

Path Parameters

None

HTTP Body

MachinesInput

Output

ManagementOutput

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

Comments