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
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. |
|
workspace_id |
Yes |
String |
Workspace ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. |
|
content-type |
Yes |
String |
application/json;charset=UTF-8 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
data_object_filters_form |
No |
DataobjectSearch object |
Search criteria. |
|
title |
No |
Array of strings |
Exported field list. |
|
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. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
conditions |
No |
Array of conditions objects |
Expression list. |
|
logics |
No |
Array of strings |
Expression name list. |
Response Parameters
Status code: 200
Object returned upon a successful response.
Status code: 400
|
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot