Export a collection of inventory preload records

post

https://yourServer.jamfcloud.com/api/v2/inventory-preload/export

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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:asc. Multiple sort criteria are supported and must be separated with
a comma. All inventory preload fields are supported, however fields added by
extension attributes are not supported. If sorting by deviceType, use 0 for
Computer and 1 for Mobile Device.

Example: sort=date:desc,name:asc.

sort

filter

string

Allowing to filter inventory preload records.
Default search is empty query - returning all results for the requested page.
All inventory preload fields are supported, however fields added by extension
attributes are not supported. If filtering by deviceType, use 0 for Computer
and 1 for Mobile Device.

Query in the RSQL format, allowing ==, !=, >, <, and =in=.

Example: filter=categoryName=="Category"

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 application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Choose an example:

text/csv

application/json

200Export successful

503Unable to perform export operation.