Querying the Search Criteria List

This API is used to query the search criteria list.

For details, see Calling APIs.

GET /v1/{project_id}/workspaces/{workspace_id}/siem/search/conditions

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Value Range N/A Default value N/A
workspace_id	Yes	String	Workspace ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
pipe_id	Yes	String	Pipeline ID.
offset	No	Long	Page number.
limit	No	Long	Number of records on each page.
sort_key	No	String	Sorting field.
sort_dir	No	String	Sorting order.

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
count	Long	Number of search criteria.
records	Array of ListSearchConditionsDetail objects	Search criteria set.

**Table 5** ListSearchConditionsDetail
Parameter	Type	Description
condition_id	String	Search criterion ID.
condition_name	String	Search criterion name.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

None

Status code: 200

Successful.

{
  "count" : 1,
  "records" : [ {
    "condition_id" : "a00106ba-bede-453c-8488-b60c70bd6aed",
    "condition_name" : "search-test"
  } ]
}

Status Code	Description
200	Successful.
400	Error response.

Parent topic: Query Conditions

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.