Export custom resource

POST 
/api/sase/v1.0/resource/tenant/:tenant_id/export/schedule/custom/query/:feature_name/:resource_name

Creates a job that retrieves custom resource information. The results of this job will differ depending on the feature and resource name that you provide. The following feature/resource name combinations are supported:

• mobileusers/mu_concurrent_connected_status

  Provides data on connected mobile users.

• locations/location_mobilegateways_status

  Provides data on mobile users service availability.

Request

Path Parameters

feature_name stringrequired

Name of the custom feature for which you want to select information.

resource_name stringrequired

Name of the custom resource for which you want to select information.

tenant_id stringrequired

Unique tenant ID.

Header Parameters

Prisma-SubTenant string

Sub-tenant ID. This parameter is required only if a sub-tenant is configured.

application/json

Body

required

The JSON request object

addOnFilter object
Add on data Filter Condition. (The existing property will be replaced)
operator Operator
Possible values: [AND, OR]
Default value: AND
Query operator
rules object[]
Array [
escapeValue booleanrequired
Enable character escaping for value
format object
Number Format function (optional)
function Function
Possible values: [ceil, floor, round, trunc]
value int32
operator Operatorrequired
Possible values: [AND, OR]
Operator
property stringrequired
Resource Property
subQuery object
Subquery (optional)
name string
type SubQueryType
Possible values: [local, pre_defined]
values arrayrequired
Operator
]
computeDataRowsProcessed boolean

Flag to indicate total rows processed for query

count int32

Possible values: >= 1 and <= 10000

Default value: 10000

Maximum number of records

filter object
Filter Condition
operator Operator
Possible values: [AND, OR]
Default value: AND
Query operator
rules object[]
Array [
escapeValue booleanrequired
Enable character escaping for value
format object
Number Format function (optional)
function Function
Possible values: [ceil, floor, round, trunc]
value int32
operator Operatorrequired
Possible values: [AND, OR]
Operator
property stringrequired
Resource Property
subQuery object
Subquery (optional)
name string
type SubQueryType
Possible values: [local, pre_defined]
values arrayrequired
Operator
]
histogram object

Histogram Condition

alias string

Property Alias

enableEmptyInterval boolean

Enable filling empty record for intervals with no data

property stringrequired

Property

range Rangerequired

Possible values: [day, hour, minute, month, week, year]

Histogram Range

sort object

Sort Condition (optional)

order Order

Possible values: [asc, desc]

sequence int32

value int32

Histogram range value (only 1 is supported)

includeRecordNumber boolean

Flag to indicate add row number to response

properties object[]
Resource properties
Array [
alias string
Property Alias (Name to include in response)
format object
Number Format function (optional)
function Function
Possible values: [ceil, floor, round, trunc]
value int32
function Function
Possible values: [ceil, floor, round, trunc]
Aggregation function (Applicable only to metric properties)
property stringrequired
Property
sort object
Sort Condition (optional)
order Order
Possible values: [asc, desc]
sequence int32
]

Responses

200

List of data objects

application/json

Schema

Schema

data object[]
Response Data
Array [
empty boolean
]
header object
Response header
empty boolean

Example (from schema)

{
  "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"
  }
}

400

Invalid Resource Query request responses

1. Invalid Resource property name (Error code: DATA10002)
2. Invalid Resource request parameter (Error code: DATA10003)
3. The resource or property is not licensed (Error code: DATA10004)

application/json

Schema

Schema

details stringrequired

Error details

errorCode stringrequired

Error code

message stringrequired

Error Message

values object

Values in error details. Used to construct error in different language

Example (from schema)

{
  "details": "Resource property 'property1' is not valid",
  "errorCode": "DATA10002",
  "message": "Invalid Resource property name",
  "values": [
    "property1"
  ]
}

403

Permission response

1. Permission Denied (Error code: REST10003)

application/json

Schema

Schema

details stringrequired

Error details

errorCode stringrequired

Error code

message stringrequired

Error Message

values object

Values in error details. Used to construct error in different language

Example (from schema)

{
  "details": "Permission Denied",
  "errorCode": "REST10003",
  "message": "Permission Denied",
  "values": [
    "value1"
  ]
}

404

Resource not available response

1. Resource not found (Error code: REST10002)

application/json

Schema

Schema

details stringrequired

Error details

errorCode stringrequired

Error code

message stringrequired

Error Message

values object

Values in error details. Used to construct error in different language

Example (from schema)

{
  "details": "Resource not found",
  "errorCode": "REST10002",
  "message": "Resource not found",
  "values": [
    "value1"
  ]
}

500

Unexpected server error response

1. Unexpected server error (Error code: REST10001)

application/json

Schema

Schema

details stringrequired

Error details

errorCode stringrequired

Error code

message stringrequired

Error Message

values object

Values in error details. Used to construct error in different language

Example (from schema)

{
  "details": "Failed to process request",
  "errorCode": "REST10001",
  "message": "Unexpected server error",
  "values": [
    "value1"
  ]
}

Loading...