API Reference

Export history object collection in specified format for specified Packages

post
https://{region}.api.jamfcloud.com/pro/v1/packages//history/export

Export history object collection in specified format for specified Packages

Required Permissions: packages:read

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Instance ID of package history note

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
integer
Defaults to 0
integer
Defaults to 100
sort
array of strings
Defaults to date:desc

Sorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.

sort
string

Filters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.

Body Params

Optional. Can be used to override query parameters so that the URI does not exceed the 2,000 character limit.

integer | null
Defaults to 0
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
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
uuid
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The tenant UUID identifier. Send it to address tenant scope. This API is also published at environment scope — send that scope's header instead. Send exactly one scope header per request.

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

The environment UUID identifier. Send it to address environment scope. This API is also published at tenant scope — send that scope's header instead. Send exactly one scope header per request.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 15 days ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
text/csv
application/json

Updated 15 days ago

Did this page help you?