Canceling Association with a Data Object
Function
Canceling Association with a Data Object
Calling Method
For details, see Calling APIs.
URI
DELETE /v1/{project_id}/workspaces/{workspace_id}/soc/{dataclass_type}/{data_object_id}/{related_dataclass_type}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. |
|
workspace_id |
Yes |
String |
Workspace ID |
|
dataclass_type |
Yes |
String |
Data class to which the associated subject data object belongs. The value is plural in lowercase, for example, "alerts" and "incidents". |
|
data_object_id |
Yes |
String |
ID of the associated data object. |
|
related_dataclass_type |
Yes |
String |
Data class to which the associated subject data object belongs. The value is plural in lowercase, for example, "alerts" and "incidents". |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
|
content-type |
Yes |
String |
Content type. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
ids |
No |
Array of strings |
ID list of associated data objects. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Request ID, in the format request_uuid-timestamp-hostname. |
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Error code |
|
message |
String |
Error Message |
|
data |
BatchOperateDataobjectResult object |
Returned object for batch operation on alerts. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_ids |
Array of strings |
IDs of alerts not transferred to incidents |
|
success_ids |
Array of strings |
IDs of alerts transferred to incidents. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Request ID, in the format request_uuid-timestamp-hostname. |
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Error Code |
|
message |
String |
Error Description |
Example Requests
Delete an incident relationship. Incident ID is f60bf0e7-73b8-4832-8fc4-8c2a12830552.
{
"ids" : [ "f60bf0e7-73b8-4832-8fc4-8c2a12830552" ]
}
Example Responses
Status code: 200
Response body for the request for canceling associating a data object.
{
"code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"message" : "Error message",
"request_id" : "Error message",
"success" : false,
"total" : 41,
"limit" : 3,
"offset" : 10,
"data" : {
"success_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ],
"error_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ]
}
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Response body for the request for canceling associating a data object. |
|
400 |
Response body for failed requests for canceling associating a data object. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.