This resource represents the settings used when optimizing a Document.
Get a List of Optimize Profiles.
GET http://{host}:{port}/qoppapdf/v1/optimize-profiles
name | type | description | default |
---|---|---|---|
QSESSIONID | cookie | The session id | n/a |
X-Qoppa-DocumentPassword | header | The document's password. | n/a |
media type | data type | description |
---|---|---|
application/json | OptimizeProfilesModel (JSON) | A List of Optimize Profiles. |
application/xml | OptimizeProfiles (XML) |
Delete an OptimizeProfile.
DELETE http://{host}:{port}/qoppapdf/v1/optimize-profiles/myprofile
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 |
media type | data type | description |
---|---|---|
application/json | object (JSON) | 204 on success. |
application/xml | anyType (XML) |
Get an OptimizeProfile by name.
GET http://{host}:{port}/qoppapdf/v1/optimize-profiles/myprofile
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 |
media type | data type | description |
---|---|---|
application/json | OptimizeProfileModel (JSON) | The Optimize Profile. |
application/xml | OptimizeProfile (XML) |
Add an optimize profile.
The message body is an OptimizeProfile JSON object.
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 } }
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 |
media type | data type | description |
---|---|---|
application/json | OptimizeProfileModel (JSON) | The OptimizeProfile to add. |
application/xml | OptimizeProfile (XML) |
media type | data type | description |
---|---|---|
application/json | OptimizeProfileModel (JSON) | The Optimize Profile. |
application/xml | OptimizeProfile (XML) |