OptimizeProfiles Resource

This resource represents the settings used when optimizing a Document.

GET /qoppapdf/v1/optimize-profiles

Get a List of Optimize Profiles.

Sample Request

GET http://{host}:{port}/qoppapdf/v1/optimize-profiles

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
Response Body
media type data type description
application/json OptimizeProfilesModel (JSON) A List of Optimize Profiles.
application/xml OptimizeProfiles (XML)

DELETE /qoppapdf/v1/optimize-profiles/{profileName}

Delete an OptimizeProfile.

Sample Request

DELETE http://{host}:{port}/qoppapdf/v1/optimize-profiles/myprofile

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
profileName path The name of the profile to delete. n/a
Response Body
media type data type description
application/json object (JSON) 204 on success.
application/xml anyType (XML)

GET /qoppapdf/v1/optimize-profiles/{profileName}

Get an OptimizeProfile by name.

Sample Request

GET http://{host}:{port}/qoppapdf/v1/optimize-profiles/myprofile

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
profileName path The name of the optimize profile. n/a
Response Body
media type data type description
application/json OptimizeProfileModel (JSON) The Optimize Profile.
application/xml OptimizeProfile (XML)

PUT /qoppapdf/v1/optimize-profiles/{profileName}

Add an optimize profile.

The message body is an OptimizeProfile JSON object.

Sample Request

 PUT http://{host}:{port}/qoppapdf/v1/optimize-profiles/myprofile
 Content-Type: application/json
 (sample JSON in message body)
 {
 "discardAnnotations" : true,
 "discardUnusedResources" : true,
 "mergeDuplicateFonts" : true,
 "mergeDuplicateImages" : true,
 "colorImageHandler": {
     "colorSpace": 1,
     "compression": 1,
     "dpi": 150,
     "jpegQuality": 0.8
   },
   "grayImageHandler": {
     "colorSpace": 1,
     "compression": 1,
     "dpi": 150,
     "jpegQuality": 0.7
   },
   "bwImageHandler": {
     "colorSpace": 2,
     "compression": 2,
     "dpi": 150,
    "jpegQuality": 0.6
   }
 }

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
profileName path The name of the profile. n/a
Request Body
media type data type description
application/json OptimizeProfileModel (JSON) The OptimizeProfile to add.
application/xml OptimizeProfile (XML)
Response Body
media type data type description
application/json OptimizeProfileModel (JSON) The Optimize Profile.
application/xml OptimizeProfile (XML)