scan_compare.rst

scan_compare

POST /users/{uid}/scannedinstances/{siid}/scans/{sid}

Summary

• Method: POST
• Response Code: 201
• Response Formats: application/xml application/json
• Since: UForge 3.4

Provides the differences between two scans.

Security Summary

• Requires Authentication: true
• Entitlements Required: migration_access

URI Parameters

• uid (required): the user name (login name) of the user-object
• siid (required): the id of the scannedinstance-object
• sid (required): the id of the scan-object

HTTP Request Body Parameters

A scanCompare-object object

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

• machinescaninstance-api-resources
• scan-object
• scanFileArchive-download
• scanFile-getAll
• scanInstallProfile-get
• scanOverlay-download
• scanOverlay-upload
• scanOverlay-uploadChunk
• scanPackageBinary-getAll
• scanPackageFile-get
• scanPackage-getAll
• scanPartition-upload
• scan-cancel
• scan-create
• scan-delete
• scan-get
• scan-multipartCreate
• scancompare-object
• scannedInstanceScan-deleteAll
• scannedInstanceScan-getAll
• scannedinstance-object
• userScan-getAll