CLI Reference Guide

Table of contents
1 API Introduction ............................................................................................................................................ 1
1.1 Basic and Advanced modes ............................................................................................................................. 1
1.1.1 Basic API ..................................................................................................................................... 1
1.1.2 Advanced API .............................................................................................................................. 1
1.2 Accessing the API on a device (%API_URL%) .................................................................................................. 1
1.2.1 XML encoding ............................................................................................................................. 2
1.2.2 XSD validation ............................................................................................................................ 2
1.2.3 Response codes ......................................................................................................................... 2
2 API security .................................................................................................................................................. 3
2.1 Administrator and API accounts ...................................................................................................................... 3
2.1.1 Admin account ............................................................................................................................ 3
2.1.1.1 “apiuser” user account ......................................................................................... 3
2.1.2 Using the API without authentication ........................................................................................ 3
2.2 Basic access authentication ............................................................................................................................ 4
3 Compatible API .............................................................................................................................................. 5
3.1 Graph and job services ..................................................................................................................................... 5
3.1.1 Put job ........................................................................................................................................ 5
3.1.2 View job ...................................................................................................................................... 8
3.1.3 Delete job ................................................................................................................................. 10
3.1.4 Get files .................................................................................................................................... 11
3.1.5 Set purge settings .................................................................................................................... 12
3.2 Configuration services ................................................................................................................................... 13
3.2.1 Get device info .......................................................................................................................... 13
3.2.2 Get device status ...................................................................................................................... 14
3.2.3 Get solution info ....................................................................................................................... 15
3.2.4 Get solution status ................................................................................................................... 16
3.2.5 Wake up .................................................................................................................................... 17
3.2.6 Cancel scan ............................................................................................................................... 18
3.2.7 Reset Solution .......................................................................................................................... 19
3.3 Extensibility services ..................................................................................................................................... 20
3.3.1 Set button ................................................................................................................................ 20
3.3.2 Remove button ........................................................................................................................ 21
3.4 Accessibility services ..................................................................................................................................... 22
3.4.1 Set API password ..................................................................................................................... 22
iii