Exporting Indicators

Function

This API is used to export indicators. If the field is of the object type, the content of the entire subobject will be exported.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/indicators/export

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
workspace_id	Yes	String	Workspace ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.
content-type	Yes	String	application/json;charset=UTF-8

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
data_object_filters_form	No	DataobjectSearch object	Search criteria.
title	No	Array of strings	Exported fields.

**Table 4** DataobjectSearch
Parameter	Mandatory	Type	Description
limit	No	Integer	The number of records on each page.
offset	No	Integer	Offset.
sort_by	No	String	Sorting field: create_time \| update_time
order	No	String	Sorting order. Options: DESC and ASC.
from_date	No	String	Search start time, for example, 2023-02-20T00:00:00.000Z.
to_date	No	String	Search end time, for example, 2023-02-27T23:59:59.999Z.
condition	No	condition object	Search condition expression.

**Table 5** condition
Parameter	Mandatory	Type	Description
conditions	No	Array of conditions objects	Expression list.
logics	No	Array of strings	Expression name list.

**Table 6** conditions
Parameter	Mandatory	Type	Description
name	No	String	Expression name.
data	No	Array of strings	Expression content list.

Response Parameters

Status code: 200

Response of export indicator

Status code: 400

**Table 7** Response header parameters
Parameter	Type	Description
X-request-id	String	This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.

**Table 8** Response body parameters
Parameter	Type	Description
code	String	Definition Error code. Range N/A
message	String	Definition Error description. Range N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code	Description
200	Response of export indicator
400	Error response

Error Codes

See Error Codes.

Parent topic: Indicator Management

Previous topic: Downloading an Indicator Template

Next topic: Importing Indicators

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

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.

Chatbot