Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ General Security Application/ Exporting a Data Object

Updated on 2025-12-18 GMT+08:00

Online Debugging

CLI Examples

View PDF

Exporting a Data Object

Function

This API is used to export data objects.

Calling Method

For details, see Calling APIs.

URI

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

**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 Range N/A Default Value N/A
workspace_id	Yes	String	Definition Workspace ID. Constraints N/A Range N/A Default Value N/A
dataclass_name	Yes	String	Name of the data class the association subject data object belongs to. The value must be plural and written in lowercase, for example, "alerts" and "incidents".

Request Parameters

**Table 2** 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
content-type	Yes	String	Definition Content type. application/json;charset=UTF-8: common API request type Constraints N/A Range application/json;charset=UTF-8 Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
data_object_filters_form	No	DataobjectSearch object	Search criteria.
action	No	String	Export action. exportDataObject: exports data. exportTemplate: exports a template.
title	No	Array of strings	Exported field list.

**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

Object returned upon a successful response.

Status code: 400

**Table 7** 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	Object returned upon a successful response.
400	Object returned upon a response error.

Error Codes

See Error Codes.

Parent topic: General Security Application

Previous topic: Editing a Data Object

Next topic: Importing a Data Object

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.