jamf.MobileDevicePrestagesApi

All URIs are relative to https://tryitout.jamfcloud.com/uapi

Method	HTTP request	Description
v1_mobile_device_prestages_get	GET /v1/mobile-device-prestages	Search for sorted and paged Mobile Device Prestages
v1_mobile_device_prestages_id_attachments_delete	DELETE /v1/mobile-device-prestages/{id}/attachments	Remove an attachment for a Mobile Device Prestage
v1_mobile_device_prestages_id_attachments_get	GET /v1/mobile-device-prestages/{id}/attachments	Get attachments for a Mobile Device Prestage
v1_mobile_device_prestages_id_attachments_post	POST /v1/mobile-device-prestages/{id}/attachments	Add an attachment to a Mobile Device Prestage
v1_mobile_device_prestages_id_delete	DELETE /v1/mobile-device-prestages/{id}	Delete a Mobile Device Prestage with the supplied id
v1_mobile_device_prestages_id_get	GET /v1/mobile-device-prestages/{id}	Retrieve a Mobile Device Prestage with the supplied id
v1_mobile_device_prestages_id_history_get	GET /v1/mobile-device-prestages/{id}/history	Get sorted and paged Mobile Device Prestage history objects
v1_mobile_device_prestages_id_history_post	POST /v1/mobile-device-prestages/{id}/history	Add Mobile Device Prestage history object notes
v1_mobile_device_prestages_id_put	PUT /v1/mobile-device-prestages/{id}	Update a Mobile Device Prestage
v1_mobile_device_prestages_id_scope_delete	DELETE /v1/mobile-device-prestages/{id}/scope	Remove Device Scope for a specific Mobile Device Prestage
v1_mobile_device_prestages_id_scope_get	GET /v1/mobile-device-prestages/{id}/scope	Get Device Scope for a specific Mobile Device Prestage
v1_mobile_device_prestages_id_scope_post	POST /v1/mobile-device-prestages/{id}/scope	Add Device Scope for a specific Mobile Device Prestage
v1_mobile_device_prestages_id_scope_put	PUT /v1/mobile-device-prestages/{id}/scope	Replace Device Scope for a specific Mobile Device Prestage
v1_mobile_device_prestages_post	POST /v1/mobile-device-prestages	Create a Mobile Device Prestage
v1_mobile_device_prestages_scope_get	GET /v1/mobile-device-prestages/scope	Get all Device Scope for all Mobile Device Prestages
v1_mobile_device_prestages_sync_get	GET /v1/mobile-device-prestages/sync	Get all Prestage sync States for all prestages
v1_mobile_device_prestages_sync_id_get	GET /v1/mobile-device-prestages/sync/{id}	Get all prestage sync states for a single prestage
v1_mobile_device_prestages_sync_id_latest_get	GET /v1/mobile-device-prestages/sync/{id}/latest	Get the latest Sync State for a single Prestage
v2_mobile_device_prestages_get	GET /v2/mobile-device-prestages	Get sorted and paged Mobile Device Prestages
v2_mobile_device_prestages_id_attachments_delete_multiple_post	POST /v2/mobile-device-prestages/{id}/attachments/delete-multiple	Remove an attachment for a Mobile Device Prestage
v2_mobile_device_prestages_id_attachments_get	GET /v2/mobile-device-prestages/{id}/attachments	Get attachments for a Mobile Device Prestage
v2_mobile_device_prestages_id_attachments_post	POST /v2/mobile-device-prestages/{id}/attachments	Add an attachment to a Mobile Device Prestage
v2_mobile_device_prestages_id_delete	DELETE /v2/mobile-device-prestages/{id}	Delete a Mobile Device Prestage with the supplied id
v2_mobile_device_prestages_id_get	GET /v2/mobile-device-prestages/{id}	Retrieve a Mobile Device Prestage with the supplied id
v2_mobile_device_prestages_id_history_get	GET /v2/mobile-device-prestages/{id}/history	Get sorted and paged Mobile Device Prestage history objects
v2_mobile_device_prestages_id_history_post	POST /v2/mobile-device-prestages/{id}/history	Add Mobile Device Prestage history object notes
v2_mobile_device_prestages_id_put	PUT /v2/mobile-device-prestages/{id}	Update a Mobile Device Prestage
v2_mobile_device_prestages_id_scope_delete_multiple_post	POST /v2/mobile-device-prestages/{id}/scope/delete-multiple	Remove Device Scope for a specific Mobile Device Prestage
v2_mobile_device_prestages_id_scope_get	GET /v2/mobile-device-prestages/{id}/scope	Get Device Scope for a specific Mobile Device Prestage
v2_mobile_device_prestages_id_scope_post	POST /v2/mobile-device-prestages/{id}/scope	Add Device Scope for a specific Mobile Device Prestage
v2_mobile_device_prestages_id_scope_put	PUT /v2/mobile-device-prestages/{id}/scope	Replace Device Scope for a specific Mobile Device Prestage
v2_mobile_device_prestages_id_syncs_get	GET /v2/mobile-device-prestages/{id}/syncs	Get all prestage sync states for a single prestage
v2_mobile_device_prestages_id_syncs_latest_get	GET /v2/mobile-device-prestages/{id}/syncs/latest	Get the latest Sync State for a single Prestage
v2_mobile_device_prestages_post	POST /v2/mobile-device-prestages	Create a Mobile Device Prestage
v2_mobile_device_prestages_scope_get	GET /v2/mobile-device-prestages/scope	Get all Device Scope for all Mobile Device Prestages
v2_mobile_device_prestages_syncs_get	GET /v2/mobile-device-prestages/syncs	Get all Prestage sync States for all prestages

v1_mobile_device_prestages_get

MobileDevicePrestageSearchResults v1_mobile_device_prestages_get(page=page, size=size, pagesize=pagesize, page_size=page_size, sort=sort)

Search for sorted and paged Mobile Device Prestages

Search for sorted and paged mobile device prestages

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    page = 0 # int |  (optional) (default to 0)
size = 100 # int |  (optional) (default to 100)
pagesize = 100 # int |  (optional) (default to 100)
page_size = 100 # int |  (optional) (default to 100)
sort = 'id:asc' # str | Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc  (optional) (default to 'id:asc')

    try:
        # Search for sorted and paged Mobile Device Prestages 
        api_response = api_instance.v1_mobile_device_prestages_get(page=page, size=size, pagesize=pagesize, page_size=page_size, sort=sort)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v1_mobile_device_prestages_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
page	int		[optional] [default to 0]
size	int		[optional] [default to 100]
pagesize	int		[optional] [default to 100]
page_size	int		[optional] [default to 100]
sort	str	Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc	[optional] [default to 'id:asc']

Return type

MobileDevicePrestageSearchResults

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_mobile_device_prestages_id_attachments_delete

v1_mobile_device_prestages_id_attachments_delete(id, file_attachment_delete)

Remove an attachment for a Mobile Device Prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 56 # int | Mobile Device Prestage identifier
file_attachment_delete = jamf.FileAttachmentDelete() # FileAttachmentDelete | 

    try:
        # Remove an attachment for a Mobile Device Prestage 
        api_instance.v1_mobile_device_prestages_id_attachments_delete(id, file_attachment_delete)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v1_mobile_device_prestages_id_attachments_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Mobile Device Prestage identifier
file_attachment_delete	FileAttachmentDelete

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Success	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_mobile_device_prestages_id_attachments_get

list[FileAttachment] v1_mobile_device_prestages_id_attachments_get(id)

Get attachments for a Mobile Device Prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 56 # int | Mobile Device Prestage identifier

    try:
        # Get attachments for a Mobile Device Prestage 
        api_response = api_instance.v1_mobile_device_prestages_id_attachments_get(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v1_mobile_device_prestages_id_attachments_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Mobile Device Prestage identifier

Return type

list[FileAttachment]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
404	Mobile Device Prestage with that id does not exist	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_mobile_device_prestages_id_attachments_post

PrestageFileAttachment v1_mobile_device_prestages_id_attachments_post(id, file)

Add an attachment to a Mobile Device Prestage

Add an attachment to a Mobile Device prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 56 # int | Identifier of the Mobile Device Prestage the attachment should be assigned to
file = '/path/to/file' # file | The file to upload

    try:
        # Add an attachment to a Mobile Device Prestage 
        api_response = api_instance.v1_mobile_device_prestages_id_attachments_post(id, file)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v1_mobile_device_prestages_id_attachments_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Identifier of the Mobile Device Prestage the attachment should be assigned to
file	file	The file to upload

Return type

PrestageFileAttachment

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Success	-
404	Mobile Device Prestage with that id does not exist	-
413	Payload Too Large	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_mobile_device_prestages_id_delete

v1_mobile_device_prestages_id_delete(id)

Delete a Mobile Device Prestage with the supplied id

Deletes a Mobile Device Prestage with the supplied id

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 56 # int | Mobile Device Prestage identifier

    try:
        # Delete a Mobile Device Prestage with the supplied id 
        api_instance.v1_mobile_device_prestages_id_delete(id)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v1_mobile_device_prestages_id_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Mobile Device Prestage identifier

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Success	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_mobile_device_prestages_id_get

GetMobileDevicePrestage v1_mobile_device_prestages_id_get(id)

Retrieve a Mobile Device Prestage with the supplied id

Retrieves a Mobile Device Prestage with the supplied id

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 56 # int | Mobile Device Prestage identifier

    try:
        # Retrieve a Mobile Device Prestage with the supplied id 
        api_response = api_instance.v1_mobile_device_prestages_id_get(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v1_mobile_device_prestages_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Mobile Device Prestage identifier

Return type

GetMobileDevicePrestage

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
404	Mobile Device Prestage with that id does not exist	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_mobile_device_prestages_id_history_get

HistorySearchResults v1_mobile_device_prestages_id_history_get(id, page=page, size=size, pagesize=pagesize, page_size=page_size, sort=sort)

Get sorted and paged Mobile Device Prestage history objects

Gets sorted and paged mobile device prestage history objects

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 56 # int | Mobile Device Prestage identifier
page = 0 # int |  (optional) (default to 0)
size = 100 # int |  (optional) (default to 100)
pagesize = 100 # int |  (optional) (default to 100)
page_size = 100 # int |  (optional) (default to 100)
sort = ["date:desc"] # list[str] | Sorting criteria in the format: property,asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is duplicated for each sort criterion, e.g., ...&sort=name%2Casc&sort=date%2Cdesc (optional) (default to ["date:desc"])

    try:
        # Get sorted and paged Mobile Device Prestage history objects 
        api_response = api_instance.v1_mobile_device_prestages_id_history_get(id, page=page, size=size, pagesize=pagesize, page_size=page_size, sort=sort)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v1_mobile_device_prestages_id_history_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Mobile Device Prestage identifier
page	int		[optional] [default to 0]
size	int		[optional] [default to 100]
pagesize	int		[optional] [default to 100]
page_size	int		[optional] [default to 100]
sort	list[str]	Sorting criteria in the format: property,asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is duplicated for each sort criterion, e.g., ...&sort=name%2Casc&sort=date%2Cdesc	[optional] [default to ["date:desc"]]

Return type

HistorySearchResults

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Details of mobile device prestage history were found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_mobile_device_prestages_id_history_post

ObjectHistory v1_mobile_device_prestages_id_history_post(id, object_history_note)

Add Mobile Device Prestage history object notes

Adds mobile device prestage history object notes

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 56 # int | Mobile Device Prestage identifier
object_history_note = jamf.ObjectHistoryNote() # ObjectHistoryNote | History notes to create

    try:
        # Add Mobile Device Prestage history object notes 
        api_response = api_instance.v1_mobile_device_prestages_id_history_post(id, object_history_note)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v1_mobile_device_prestages_id_history_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Mobile Device Prestage identifier
object_history_note	ObjectHistoryNote	History notes to create

Return type

ObjectHistory

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Notes of mobile deivce prestage history were added	-
503	Mobile device prestage history can not be saved	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_mobile_device_prestages_id_put

GetMobileDevicePrestage v1_mobile_device_prestages_id_put(id, put_mobile_device_prestage)

Update a Mobile Device Prestage

Updates a Mobile Device Prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 56 # int | Mobile Device Prestage identifier
put_mobile_device_prestage = jamf.PutMobileDevicePrestage() # PutMobileDevicePrestage | Mobile Device Prestage to update

    try:
        # Update a Mobile Device Prestage 
        api_response = api_instance.v1_mobile_device_prestages_id_put(id, put_mobile_device_prestage)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v1_mobile_device_prestages_id_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Mobile Device Prestage identifier
put_mobile_device_prestage	PutMobileDevicePrestage	Mobile Device Prestage to update

Return type

GetMobileDevicePrestage

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
404	Mobile Device Prestage with that id does not exist	-
409	The Mobile Device Prestage was modified by another process. Read the Mobile Device Prestage again for updated changes.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_mobile_device_prestages_id_scope_delete

PrestageScopeResponse v1_mobile_device_prestages_id_scope_delete(id, prestage_scope_update)

Remove Device Scope for a specific Mobile Device Prestage

Remove device scope for a specific mobile device prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 56 # int | Mobile Device Prestage identifier
prestage_scope_update = jamf.PrestageScopeUpdate() # PrestageScopeUpdate | Serial Numbers to remove from scope

    try:
        # Remove Device Scope for a specific Mobile Device Prestage 
        api_response = api_instance.v1_mobile_device_prestages_id_scope_delete(id, prestage_scope_update)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v1_mobile_device_prestages_id_scope_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Mobile Device Prestage identifier
prestage_scope_update	PrestageScopeUpdate	Serial Numbers to remove from scope

Return type

PrestageScopeResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	One or more serial numbers are not valid	-
404	Mobile Device Prestage with that id does not exist	-
409	Optimistic Lock Error - The prestage you are trying to update has been updated by another process	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_mobile_device_prestages_id_scope_get

PrestageScopeResponse v1_mobile_device_prestages_id_scope_get(id)

Get Device Scope for a specific Mobile Device Prestage

Get device scope for a specific mobile device prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 56 # int | Mobile Device Prestage identifier

    try:
        # Get Device Scope for a specific Mobile Device Prestage 
        api_response = api_instance.v1_mobile_device_prestages_id_scope_get(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v1_mobile_device_prestages_id_scope_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Mobile Device Prestage identifier

Return type

PrestageScopeResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	Mobile Device Prestage with that id does not exist	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_mobile_device_prestages_id_scope_post

PrestageScopeResponse v1_mobile_device_prestages_id_scope_post(id, prestage_scope_update)

Add Device Scope for a specific Mobile Device Prestage

Add device scope for a specific mobile device prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 56 # int | Mobile Device Prestage identifier
prestage_scope_update = jamf.PrestageScopeUpdate() # PrestageScopeUpdate | Serial Numbers to scope

    try:
        # Add Device Scope for a specific Mobile Device Prestage 
        api_response = api_instance.v1_mobile_device_prestages_id_scope_post(id, prestage_scope_update)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v1_mobile_device_prestages_id_scope_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Mobile Device Prestage identifier
prestage_scope_update	PrestageScopeUpdate	Serial Numbers to scope

Return type

PrestageScopeResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	One or more serial numbers are not valid	-
404	Mobile Device Prestage with that id does not exist	-
409	Optimistic Lock Error - The prestage you are trying to update has been updated by another process	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_mobile_device_prestages_id_scope_put

PrestageScopeResponse v1_mobile_device_prestages_id_scope_put(id, prestage_scope_update)

Replace Device Scope for a specific Mobile Device Prestage

Replace device scope for a specific mobile device prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 56 # int | Mobile Device Prestage identifier
prestage_scope_update = jamf.PrestageScopeUpdate() # PrestageScopeUpdate | Serial Numbers to scope

    try:
        # Replace Device Scope for a specific Mobile Device Prestage 
        api_response = api_instance.v1_mobile_device_prestages_id_scope_put(id, prestage_scope_update)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v1_mobile_device_prestages_id_scope_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Mobile Device Prestage identifier
prestage_scope_update	PrestageScopeUpdate	Serial Numbers to scope

Return type

PrestageScopeResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	One or more serial numbers are not valid	-
404	Mobile Device Prestage with that id does not exist	-
409	Optimistic Lock Error - The prestage you are trying to update has been updated by another process	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_mobile_device_prestages_post

GetMobileDevicePrestage v1_mobile_device_prestages_post(mobile_device_prestage)

Create a Mobile Device Prestage

Create a mobile device prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    mobile_device_prestage = jamf.MobileDevicePrestage() # MobileDevicePrestage | Mobile Device Prestage to create. ids defined in this body will be ignored

    try:
        # Create a Mobile Device Prestage 
        api_response = api_instance.v1_mobile_device_prestages_post(mobile_device_prestage)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v1_mobile_device_prestages_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
mobile_device_prestage	MobileDevicePrestage	Mobile Device Prestage to create. ids defined in this body will be ignored

Return type

GetMobileDevicePrestage

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Mobile Device Prestage was created	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_mobile_device_prestages_scope_get

PrestageScope v1_mobile_device_prestages_scope_get()

Get all Device Scope for all Mobile Device Prestages

Get all device scope for all mobile device prestages

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    
    try:
        # Get all Device Scope for all Mobile Device Prestages 
        api_response = api_instance.v1_mobile_device_prestages_scope_get()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v1_mobile_device_prestages_scope_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

PrestageScope

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_mobile_device_prestages_sync_get

list[PrestageSyncStatus] v1_mobile_device_prestages_sync_get()

Get all Prestage sync States for all prestages

Get all prestage sync states for all prestages

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    
    try:
        # Get all Prestage sync States for all prestages 
        api_response = api_instance.v1_mobile_device_prestages_sync_get()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v1_mobile_device_prestages_sync_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[PrestageSyncStatus]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_mobile_device_prestages_sync_id_get

list[PrestageSyncStatus] v1_mobile_device_prestages_sync_id_get(id)

Get all prestage sync states for a single prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 56 # int | Mobile Device Prestage identifier

    try:
        # Get all prestage sync states for a single prestage 
        api_response = api_instance.v1_mobile_device_prestages_sync_id_get(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v1_mobile_device_prestages_sync_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Mobile Device Prestage identifier

Return type

list[PrestageSyncStatus]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v1_mobile_device_prestages_sync_id_latest_get

PrestageSyncStatus v1_mobile_device_prestages_sync_id_latest_get(id)

Get the latest Sync State for a single Prestage

Get the latest sync state for a single prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 56 # int | Mobile Device Prestage identifier

    try:
        # Get the latest Sync State for a single Prestage 
        api_response = api_instance.v1_mobile_device_prestages_sync_id_latest_get(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v1_mobile_device_prestages_sync_id_latest_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Mobile Device Prestage identifier

Return type

PrestageSyncStatus

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_mobile_device_prestages_get

MobileDevicePrestageSearchResultsV2 v2_mobile_device_prestages_get(page=page, page_size=page_size, sort=sort)

Get sorted and paged Mobile Device Prestages

Gets sorted and paged mobile device prestages

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    page = 0 # int |  (optional) (default to 0)
page_size = 100 # int |  (optional) (default to 100)
sort = ["id:desc"] # list[str] | Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc  (optional) (default to ["id:desc"])

    try:
        # Get sorted and paged Mobile Device Prestages 
        api_response = api_instance.v2_mobile_device_prestages_get(page=page, page_size=page_size, sort=sort)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v2_mobile_device_prestages_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
page	int		[optional] [default to 0]
page_size	int		[optional] [default to 100]
sort	list[str]	Sorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc	[optional] [default to ["id:desc"]]

Return type

MobileDevicePrestageSearchResultsV2

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_mobile_device_prestages_id_attachments_delete_multiple_post

v2_mobile_device_prestages_id_attachments_delete_multiple_post(id, ids)

Remove an attachment for a Mobile Device Prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 'id_example' # str | Mobile Device Prestage identifier
ids = jamf.Ids() # Ids | 

    try:
        # Remove an attachment for a Mobile Device Prestage 
        api_instance.v2_mobile_device_prestages_id_attachments_delete_multiple_post(id, ids)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v2_mobile_device_prestages_id_attachments_delete_multiple_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Mobile Device Prestage identifier
ids	Ids

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Success	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_mobile_device_prestages_id_attachments_get

list[FileAttachmentV2] v2_mobile_device_prestages_id_attachments_get(id)

Get attachments for a Mobile Device Prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 'id_example' # str | Mobile Device Prestage identifier

    try:
        # Get attachments for a Mobile Device Prestage 
        api_response = api_instance.v2_mobile_device_prestages_id_attachments_get(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v2_mobile_device_prestages_id_attachments_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Mobile Device Prestage identifier

Return type

list[FileAttachmentV2]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
404	Mobile Device Prestage with that id does not exist	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_mobile_device_prestages_id_attachments_post

PrestageFileAttachmentV2 v2_mobile_device_prestages_id_attachments_post(id, file)

Add an attachment to a Mobile Device Prestage

Add an attachment to a Mobile Device prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 'id_example' # str | Identifier of the Mobile Device Prestage the attachment should be assigned to
file = '/path/to/file' # file | The file to upload

    try:
        # Add an attachment to a Mobile Device Prestage 
        api_response = api_instance.v2_mobile_device_prestages_id_attachments_post(id, file)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v2_mobile_device_prestages_id_attachments_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Identifier of the Mobile Device Prestage the attachment should be assigned to
file	file	The file to upload

Return type

PrestageFileAttachmentV2

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Success	-
404	Mobile Device Prestage with that id does not exist	-
413	Payload Too Large	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_mobile_device_prestages_id_delete

v2_mobile_device_prestages_id_delete(id)

Delete a Mobile Device Prestage with the supplied id

Deletes a Mobile Device Prestage with the supplied id

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 'id_example' # str | Mobile Device Prestage identifier

    try:
        # Delete a Mobile Device Prestage with the supplied id 
        api_instance.v2_mobile_device_prestages_id_delete(id)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v2_mobile_device_prestages_id_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Mobile Device Prestage identifier

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Success	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_mobile_device_prestages_id_get

GetMobileDevicePrestageV2 v2_mobile_device_prestages_id_get(id)

Retrieve a Mobile Device Prestage with the supplied id

Retrieves a Mobile Device Prestage with the supplied id

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 'id_example' # str | Mobile Device Prestage identifier

    try:
        # Retrieve a Mobile Device Prestage with the supplied id 
        api_response = api_instance.v2_mobile_device_prestages_id_get(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v2_mobile_device_prestages_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Mobile Device Prestage identifier

Return type

GetMobileDevicePrestageV2

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
404	Mobile Device Prestage with that id does not exist	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_mobile_device_prestages_id_history_get

HistorySearchResults v2_mobile_device_prestages_id_history_get(id, page=page, page_size=page_size, sort=sort)

Get sorted and paged Mobile Device Prestage history objects

Gets sorted and paged mobile device prestage history objects

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 'id_example' # str | Mobile Device Prestage identifier
page = 0 # int |  (optional) (default to 0)
page_size = 100 # int |  (optional) (default to 100)
sort = ["date:desc"] # list[str] | Sorting criteria in the format: property,asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is duplicated for each sort criterion, e.g., ...&sort=name%2Casc&sort=date%2Cdesc (optional) (default to ["date:desc"])

    try:
        # Get sorted and paged Mobile Device Prestage history objects 
        api_response = api_instance.v2_mobile_device_prestages_id_history_get(id, page=page, page_size=page_size, sort=sort)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v2_mobile_device_prestages_id_history_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Mobile Device Prestage identifier
page	int		[optional] [default to 0]
page_size	int		[optional] [default to 100]
sort	list[str]	Sorting criteria in the format: property,asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is duplicated for each sort criterion, e.g., ...&sort=name%2Casc&sort=date%2Cdesc	[optional] [default to ["date:desc"]]

Return type

HistorySearchResults

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Details of mobile device prestage history were found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_mobile_device_prestages_id_history_post

HrefResponse v2_mobile_device_prestages_id_history_post(id, object_history_note)

Add Mobile Device Prestage history object notes

Adds mobile device prestage history object notes

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 'id_example' # str | Mobile Device Prestage identifier
object_history_note = jamf.ObjectHistoryNote() # ObjectHistoryNote | History notes to create

    try:
        # Add Mobile Device Prestage history object notes 
        api_response = api_instance.v2_mobile_device_prestages_id_history_post(id, object_history_note)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v2_mobile_device_prestages_id_history_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Mobile Device Prestage identifier
object_history_note	ObjectHistoryNote	History notes to create

Return type

HrefResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Notes of mobile deivce prestage history were added	-
503	Mobile device prestage history can not be saved	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_mobile_device_prestages_id_put

GetMobileDevicePrestageV2 v2_mobile_device_prestages_id_put(id, put_mobile_device_prestage_v2)

Update a Mobile Device Prestage

Updates a Mobile Device Prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 'id_example' # str | Mobile Device Prestage identifier
put_mobile_device_prestage_v2 = jamf.PutMobileDevicePrestageV2() # PutMobileDevicePrestageV2 | Mobile Device Prestage to update

    try:
        # Update a Mobile Device Prestage 
        api_response = api_instance.v2_mobile_device_prestages_id_put(id, put_mobile_device_prestage_v2)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v2_mobile_device_prestages_id_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Mobile Device Prestage identifier
put_mobile_device_prestage_v2	PutMobileDevicePrestageV2	Mobile Device Prestage to update

Return type

GetMobileDevicePrestageV2

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
404	Mobile Device Prestage with that id does not exist	-
409	The Mobile Device Prestage was modified by another process. Read the Mobile Device Prestage again for updated changes.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_mobile_device_prestages_id_scope_delete_multiple_post

PrestageScopeResponseV2 v2_mobile_device_prestages_id_scope_delete_multiple_post(id, prestage_scope_update)

Remove Device Scope for a specific Mobile Device Prestage

Remove device scope for a specific mobile device prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 'id_example' # str | Mobile Device Prestage identifier
prestage_scope_update = jamf.PrestageScopeUpdate() # PrestageScopeUpdate | Serial Numbers to remove from scope

    try:
        # Remove Device Scope for a specific Mobile Device Prestage 
        api_response = api_instance.v2_mobile_device_prestages_id_scope_delete_multiple_post(id, prestage_scope_update)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v2_mobile_device_prestages_id_scope_delete_multiple_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Mobile Device Prestage identifier
prestage_scope_update	PrestageScopeUpdate	Serial Numbers to remove from scope

Return type

PrestageScopeResponseV2

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	One or more serial numbers are not valid	-
404	Mobile Device Prestage with that id does not exist	-
409	Optimistic Lock Error - The prestage you are trying to update has been updated by another process	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_mobile_device_prestages_id_scope_get

PrestageScopeResponseV2 v2_mobile_device_prestages_id_scope_get(id)

Get Device Scope for a specific Mobile Device Prestage

Get device scope for a specific mobile device prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 'id_example' # str | Mobile Device Prestage identifier

    try:
        # Get Device Scope for a specific Mobile Device Prestage 
        api_response = api_instance.v2_mobile_device_prestages_id_scope_get(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v2_mobile_device_prestages_id_scope_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Mobile Device Prestage identifier

Return type

PrestageScopeResponseV2

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	Mobile Device Prestage with that id does not exist	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_mobile_device_prestages_id_scope_post

PrestageScopeResponseV2 v2_mobile_device_prestages_id_scope_post(id, prestage_scope_update)

Add Device Scope for a specific Mobile Device Prestage

Add device scope for a specific mobile device prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 'id_example' # str | Mobile Device Prestage identifier
prestage_scope_update = jamf.PrestageScopeUpdate() # PrestageScopeUpdate | Serial Numbers to scope

    try:
        # Add Device Scope for a specific Mobile Device Prestage 
        api_response = api_instance.v2_mobile_device_prestages_id_scope_post(id, prestage_scope_update)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v2_mobile_device_prestages_id_scope_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Mobile Device Prestage identifier
prestage_scope_update	PrestageScopeUpdate	Serial Numbers to scope

Return type

PrestageScopeResponseV2

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	One or more serial numbers are not valid	-
404	Mobile Device Prestage with that id does not exist	-
409	Optimistic Lock Error - The prestage you are trying to update has been updated by another process	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_mobile_device_prestages_id_scope_put

PrestageScopeResponseV2 v2_mobile_device_prestages_id_scope_put(id, prestage_scope_update)

Replace Device Scope for a specific Mobile Device Prestage

Replace device scope for a specific mobile device prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 'id_example' # str | Mobile Device Prestage identifier
prestage_scope_update = jamf.PrestageScopeUpdate() # PrestageScopeUpdate | Serial Numbers to scope

    try:
        # Replace Device Scope for a specific Mobile Device Prestage 
        api_response = api_instance.v2_mobile_device_prestages_id_scope_put(id, prestage_scope_update)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v2_mobile_device_prestages_id_scope_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Mobile Device Prestage identifier
prestage_scope_update	PrestageScopeUpdate	Serial Numbers to scope

Return type

PrestageScopeResponseV2

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	One or more serial numbers are not valid	-
404	Mobile Device Prestage with that id does not exist	-
409	Optimistic Lock Error - The prestage you are trying to update has been updated by another process	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_mobile_device_prestages_id_syncs_get

list[PrestageSyncStatusV2] v2_mobile_device_prestages_id_syncs_get(id)

Get all prestage sync states for a single prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 'id_example' # str | Mobile Device Prestage identifier

    try:
        # Get all prestage sync states for a single prestage 
        api_response = api_instance.v2_mobile_device_prestages_id_syncs_get(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v2_mobile_device_prestages_id_syncs_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Mobile Device Prestage identifier

Return type

list[PrestageSyncStatusV2]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_mobile_device_prestages_id_syncs_latest_get

PrestageSyncStatusV2 v2_mobile_device_prestages_id_syncs_latest_get(id)

Get the latest Sync State for a single Prestage

Get the latest sync state for a single prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    id = 'id_example' # str | Mobile Device Prestage identifier

    try:
        # Get the latest Sync State for a single Prestage 
        api_response = api_instance.v2_mobile_device_prestages_id_syncs_latest_get(id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v2_mobile_device_prestages_id_syncs_latest_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Mobile Device Prestage identifier

Return type

PrestageSyncStatusV2

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_mobile_device_prestages_post

HrefResponse v2_mobile_device_prestages_post(mobile_device_prestage_v2)

Create a Mobile Device Prestage

Create a mobile device prestage

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    mobile_device_prestage_v2 = jamf.MobileDevicePrestageV2() # MobileDevicePrestageV2 | Mobile Device Prestage to create. ids defined in this body will be ignored

    try:
        # Create a Mobile Device Prestage 
        api_response = api_instance.v2_mobile_device_prestages_post(mobile_device_prestage_v2)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v2_mobile_device_prestages_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
mobile_device_prestage_v2	MobileDevicePrestageV2	Mobile Device Prestage to create. ids defined in this body will be ignored

Return type

HrefResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Mobile Device Prestage was created	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_mobile_device_prestages_scope_get

PrestageScopeV2 v2_mobile_device_prestages_scope_get()

Get all Device Scope for all Mobile Device Prestages

Get all device scope for all mobile device prestages

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    
    try:
        # Get all Device Scope for all Mobile Device Prestages 
        api_response = api_instance.v2_mobile_device_prestages_scope_get()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v2_mobile_device_prestages_scope_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

PrestageScopeV2

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

v2_mobile_device_prestages_syncs_get

list[PrestageSyncStatusV2] v2_mobile_device_prestages_syncs_get()

Get all Prestage sync States for all prestages

Get all prestage sync states for all prestages

Example

from __future__ import print_function
import time
import jamf
from jamf.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://tryitout.jamfcloud.com/uapi
# See configuration.py for a list of all supported configuration parameters.
configuration = jamf.Configuration(
    host = "https://tryitout.jamfcloud.com/uapi"
)


# Enter a context with an instance of the API client
with jamf.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jamf.MobileDevicePrestagesApi(api_client)
    
    try:
        # Get all Prestage sync States for all prestages 
        api_response = api_instance.v2_mobile_device_prestages_syncs_get()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MobileDevicePrestagesApi->v2_mobile_device_prestages_syncs_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[PrestageSyncStatusV2]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

MobileDevicePrestagesApi.md

Latest commit

History

MobileDevicePrestagesApi.md

File metadata and controls

jamf.MobileDevicePrestagesApi

v1_mobile_device_prestages_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_mobile_device_prestages_id_attachments_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_mobile_device_prestages_id_attachments_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_mobile_device_prestages_id_attachments_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_mobile_device_prestages_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_mobile_device_prestages_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_mobile_device_prestages_id_history_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_mobile_device_prestages_id_history_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_mobile_device_prestages_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_mobile_device_prestages_id_scope_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

v1_mobile_device_prestages_id_scope_get

Example

Parameters