Export enrollment history collection

post

https://{region}.apigw.jamf.com/api/pro/v2/tenant/{tenantId}/enrollment/history/export

Required Permissions: read:pro:user-initiated-enrollment

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

uuid

required

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The tenant UUID identifier

Query Params

export-fields

array of strings

Defaults to []

Export fields parameter, used to change default order or ignore some of the response properties. Default is empty array, which means that all fields of the response entity will be serialized. Example: export-fields=id,username

export-fields

export-labels

array of strings

Defaults to []

Export labels parameter, used to customize fieldnames/columns in the exported file. Default is empty array, which means that response properties names will be used. Number of the provided labels must match the number of export-fields Example: export-labels=identifier,name with matching: export-fields=id,username

export-labels

page

integer

Defaults to 0

page-size

integer

Defaults to 100

sort

array of strings

Defaults to id:asc

Sorting criteria in the format: property:asc/desc. Default sort is id:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=id:desc,name:asc

sort

filter

string

Query in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name. This param can be combined with paging and sorting. Example: name=="script"

Body Params

Optional. Override query parameters since they can make URI exceed 2,000 character limit.

page

integer | null

Defaults to 0

pageSize

integer | null

Defaults to 100

sort

array of strings | null

Defaults to id:desc

Sorting criteria in the format: [[:asc/desc]. Default direction when not stated is ascending.

sort

filter

string | null

fields

array of objects | null

Used to change default order or ignore some of the fields. When null or empty array, all fields will be exported.

fields

Headers

string

enum

Defaults to text/csv,application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

text/csv,application/json

application/json

200Export successful

400Export fields specified incorrectly - non-existing column or duplicate in the list. Supported columns: id,name,categoryName,categoryId,priority.

503Export currently unavailable, all export-related resources are in use. Try again later.