Skip to main content

Export general resource

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

Export a general resource. The result of this job is a CSV file that identifies all of the resource's properties.

Request​

Path Parameters

    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.

Body

required

The JSON object used to query the resource. The query consists of four parts, show below.

  1. Properties - Data fields to include in the query output.
  2. Query - Filter conditions to apply to the query.
  3. Sort - Sort order for the the data.
  4. Count - Maximum number of records to retrieve.
    addOnFilter object

    Add on data Filter Condition. (The existing property will be replaced)

    operator Operator (string)

    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 (string)

    Possible values: [ceil, floor, round, trunc]

    value int32
    operator Operator (string)required

    Possible values: [AND, OR]

    Operator

    property stringrequired

    Resource Property

    subQuery object

    Subquery (optional)

    name string
    type SubQueryType (string)

    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 objectrequired

    Filter Condition

    operator Operator (string)

    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 (string)

    Possible values: [ceil, floor, round, trunc]

    value int32
    operator Operator (string)required

    Possible values: [AND, OR]

    Operator

    property stringrequired

    Resource Property

    subQuery object

    Subquery (optional)

    name string
    type SubQueryType (string)

    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 Range (string)required

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

    Histogram Range

    sort object

    Sort Condition (optional)

    order Order (string)

    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[]required

    Resource properties

  • Array [
    • alias string

    Property Alias (Name to include in response)

    format object

    Number Format function (optional)

    function Function (string)

    Possible values: [ceil, floor, round, trunc]

    value int32
    function Function (string)

    Possible values: [ceil, floor, round, trunc]

    Aggregation function (Applicable only to metric properties)

    property stringrequired

    Property

    sort object

    Sort Condition (optional)

    order Order (string)

    Possible values: [asc, desc]

    sequence int32
  • ]

Responses​

Content as attachment

Schema

    object

Loading...