Retrieve the full configuration details of a Wallpaper payload item

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

To get Ios Wallpaper policy payload item

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/ioswallpaperpolicy/payloaditems/{payload_id}

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

profile_idstringMandatory

Unique identifier of the profile. Obtain from the Create Profile or Get Profiles response

payload_idstringMandatory

Unique identifier of the payload item. Obtain from the Get Payload Item IDs response

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/ioswallpaperpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
payload_idlong

Unique identifier of the payload item

below_hdpi_wallpaperlong

Below Hdpi Wallpaper. Use the fileID from the File Upload API response

above_hdpi_wallpaperlong

Above Hdpi Wallpaper. Use the fileID from the File Upload API response

below_hdpi_lock_wallpaperlong

Below Hdpi Lock Wallpaper. Use the fileID from the File Upload API response

is_below_hdpi_wall_modifiedboolean

Is Below Hdpi Wall Modified

is_above_hdpi_wall_modifiedboolean

Is Above Hdpi Wall Modified

is_below_hdpi_lock_wall_modifiedboolean

Is Below Hdpi Lock Wall Modified

set_wallpaper_positioninteger

Wallpaper position. Allowed values: 1=Lock Screen, 2=Home Screen, 3=Both Lock Screen and Home Screen are configured with same image, 4=Both Lock screen and Home screen are configured with different images

allow_wallpaper_changeboolean

Allow Wallpaper Change. Default: false

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of Wallpaper payload item

Copied!
  "{                         \"payload_id\": 9007199254741001,                         \"below_hdpi_wallpaper\": \"value\",                         \"above_hdpi_wallpaper\": \"value\",                         \"below_hdpi_lock_wallpaper\": \"value\",                         \"below_hdpi_wallpaper\": \"value\",                         \"above_hdpi_wallpaper\": \"value\",                         \"below_hdpi_lock_wallpaper\": \"value\",                         \"is_below_hdpi_wall_modified\": false,                         \"is_above_hdpi_wall_modified\": false,                         \"is_below_hdpi_lock_wall_modified\": false,                         \"set_wallpaper_position\": 3                         }"
                
Show full

Duration: 1 minute | Threshold: 120 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.