Download custom resource
POST/api/sase/v1.0/resource/tenant/:tenant_id/download
Download a CSV file containing the results of a request for custom resources. The query for this information is created using Export Custom Resource.
Request
Path Parameters
Unique tenant ID.
Header Parameters
Sub-tenant ID. This parameter is required only if a sub-tenant is configured.
- application/json
Body
required
The JSON request object
object
Responses
- 200
- 400
- 403
- 404
- 500
List of data objects
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
data object[]
Response Data
header object
Response header
{
"data": [
{
"average_property3": 10.75,
"property1": "value1",
"property2": 10
},
{
"average_property3": 20.99,
"property1": "value2",
"property2": 25
}
],
"header": {
"createdAt": "Fri Jan 1 00:00:00 PST 2021",
"name": "Response Name",
"requestId": "123e4567-e89b-12d3-a456-426614174000"
}
}
Invalid Resource Query request responses
- Invalid Resource property name (Error code: DATA10002)
- Invalid Resource request parameter (Error code: DATA10003)
- The resource or property is not licensed (Error code: DATA10004)
- application/json
- Schema
- Example (from schema)
Schema
Error details
Error code
Error Message
Values in error details. Used to construct error in different language
{
"details": "Resource property 'property1' is not valid",
"errorCode": "DATA10002",
"message": "Invalid Resource property name",
"values": [
"property1"
]
}
Permission response
- Permission Denied (Error code: REST10003)
- application/json
- Schema
- Example (from schema)
Schema
Error details
Error code
Error Message
Values in error details. Used to construct error in different language
{
"details": "Permission Denied",
"errorCode": "REST10003",
"message": "Permission Denied",
"values": [
"value1"
]
}
Resource not available response
- Resource not found (Error code: REST10002)
- application/json
- Schema
- Example (from schema)
Schema
Error details
Error code
Error Message
Values in error details. Used to construct error in different language
{
"details": "Resource not found",
"errorCode": "REST10002",
"message": "Resource not found",
"values": [
"value1"
]
}
Unexpected server error response
- Unexpected server error (Error code: REST10001)
- application/json
- Schema
- Example (from schema)
Schema
Error details
Error code
Error Message
Values in error details. Used to construct error in different language
{
"details": "Failed to process request",
"errorCode": "REST10001",
"message": "Unexpected server error",
"values": [
"value1"
]
}