Delete Recommendation Session

• Recommendation

Delete a recommendation session and associated results

Permanently removes a recommendation session from the system.

Notes:

• Side Effect: This is a cascading delete. All associated resources, including generated recommendation results, will be permanently cleaned up.

Request

URI

DELETE

https://{api_host}/intelligence/recommendations/{id}

COPY

Path Parameters

string

id

Required  

The id of the recommendation.

---

Authentication

This operation uses the following authentication methods.

enterprise_admin

security_engineer

Responses

200

Hide Details

The recommendation resource is deleted successfully

Operation doesn't return any data structure

400

Hide Details

Bad Request

Returns BadRequest of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required  

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required  

Message describing the error.

401

Hide Details

Unauthorized

Returns Unauthorized of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required  

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required  

Message describing the error.

403

Hide Details

Forbidden

Returns Forbidden of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required  

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required  

Message describing the error.

412

Hide Details

Precondition Failed

Returns PreconditionFailed of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required  

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required  

Message describing the error.

428

Hide Details

Precondition Required

Returns PreconditionRequired of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required  

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required  

Message describing the error.

429

Hide Details

Too Many Requests

Returns TooManyRequests of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required  

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required  

Message describing the error.

default

Hide Details

Error

Returns Error of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required  

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required  

Message describing the error.

Code Samples

COPY

                    curl -X DELETE -H 'Authorization: <value>' https://{api_host}/intelligence/recommendations/{id}
                

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Recommendation Operations

POST

Create Recommendation Session

GET

Get Recommendation Session

PUT

Update Recommendation Session

DELETE

Delete Recommendation Session

GET

Get Recommendation Session Status

GET

Get Recommendation Monitoring Result

POST

List Recommendation Sessions

GET

Get Recommendation Result

PUT

Update Recommendation Result

GET

Get Recommendation Result Status

GET

Export Recommendation To Csv