PDFreactor Web Service Monitoring REST API (12.0.2)

PDFreactor Support Team: support@realobjects.com URL: http://www.pdfreactor.com License: PDFreactor Software License Agreement Terms of Service

This is the monitoring REST API definition and documentation of the PDFreactor Web Service. To use the monitoring API, an adminKey has to be configured on the server.

Authentication

adminKeyQueryAuth

The admin key to authenticate the request.

Security Scheme Type	API Key
Query parameter name:	adminKey

Service information

get /server

http://localhost:9423/service/monitor/server

Retrieves information about the PDFreactor Web Service that is currently running.

Authorizations:

adminKeyQueryAuth

Responses

200

Operation successful

401

The client failed an authorization check, e.g. because a supplied API key was invalid.

503

The PDFreactor Web Service is running and reachable, but not in a state to perform the requested operation.

Response samples

Content type

Copy

Expand all Collapse all


{"name": "string",
"id": "string",
"state": "string",
"server": 
{"availableMemory": 0,
"dockerLabel": "string",
"environmentVariables": 
{"property1": "string",
"property2": "string"
},
"maxMemory": 0,
"numberOfCpuCores": 0,
"systemProperties": 
{"property1": "string",
"property2": "string"
},
"usedMemory": 0
},
"plugins": 
[
{"id": "string",
"version": "string",
"vendor": "string",
"type": "string",
"interface": "string",
"used": true
}
],
"parameters": 
[
{"name": "string",
"value": "string",
"values": 
["string"
]
}
],
"version": 
{"build": 0,
"label": "string",
"major": 0,
"micro": 0,
"minor": 0,
"revision": "string"
},
"date": "2024-11-21T08:25:09Z",
"supportsRestart": true
}

Conversion information

get /conversions

http://localhost:9423/service/monitor/conversions

Retrieves information about the conversions on the server.

Authorizations:

adminKeyQueryAuth

Responses

200

Operation successful

401

The client failed an authorization check, e.g. because a supplied API key was invalid.

503

The PDFreactor Web Service is running and reachable, but not in a state to perform the requested operation.

Response samples

Content type

Copy

Expand all Collapse all


{"failedConversions": 0,
"finishedConversions": 0,
"queuedConversions": 
{"amount": 0,
"conversions": 
[
{"contentType": "string",
"conversionTime": 0,
"endData": "2024-11-21T08:25:09Z",
"error": "string",
"id": "string",
"numberOfPages": 0,
"numberOfPagesLiteral": 0,
"requestDate": "2024-11-21T08:25:09Z",
"size": 
[0
],
"startDate": "2024-11-21T08:25:09Z",
"succes": true,
"sync": true
}
],
"serviceId": "string"
},
"runningConversions": 
{"amount": 0,
"conversions": 
[
{"contentType": "string",
"conversionTime": 0,
"endData": "2024-11-21T08:25:09Z",
"error": "string",
"id": "string",
"numberOfPages": 0,
"numberOfPagesLiteral": 0,
"requestDate": "2024-11-21T08:25:09Z",
"size": 
[0
],
"startDate": "2024-11-21T08:25:09Z",
"succes": true,
"sync": true
}
],
"serviceId": "string"
},
"serviceId": "string"
}

Running conversion information

get /conversions/running

http://localhost:9423/service/monitor/conversions/running

Retrieves information about the running conversions on the server.

Authorizations:

adminKeyQueryAuth

Responses

200

Operation successful

401

The client failed an authorization check, e.g. because a supplied API key was invalid.

503

The PDFreactor Web Service is running and reachable, but not in a state to perform the requested operation.

Response samples

Content type

Copy

Expand all Collapse all


{"amount": 0,
"conversions": 
[
{"contentType": "string",
"conversionTime": 0,
"endData": "2024-11-21T08:25:09Z",
"error": "string",
"id": "string",
"numberOfPages": 0,
"numberOfPagesLiteral": 0,
"requestDate": "2024-11-21T08:25:09Z",
"size": 
[0
],
"startDate": "2024-11-21T08:25:09Z",
"succes": true,
"sync": true
}
],
"serviceId": "string"
}

Queued conversion information

get /conversions/queued

http://localhost:9423/service/monitor/conversions/queued

Retrieves information about the queued conversions on the server.

Authorizations:

adminKeyQueryAuth

Responses

200

Operation successful

401

The client failed an authorization check, e.g. because a supplied API key was invalid.

503

The PDFreactor Web Service is running and reachable, but not in a state to perform the requested operation.

Response samples

Content type

Copy

Expand all Collapse all


{"amount": 0,
"conversions": 
[
{"contentType": "string",
"conversionTime": 0,
"endData": "2024-11-21T08:25:09Z",
"error": "string",
"id": "string",
"numberOfPages": 0,
"numberOfPagesLiteral": 0,
"requestDate": "2024-11-21T08:25:09Z",
"size": 
[0
],
"startDate": "2024-11-21T08:25:09Z",
"succes": true,
"sync": true
}
],
"serviceId": "string"
}

Running conversion information

get /conversions/finished

http://localhost:9423/service/monitor/conversions/finished

Retrieves information about the finished conversions on the server.

Authorizations:

adminKeyQueryAuth

Responses

200

Operation successful

401

The client failed an authorization check, e.g. because a supplied API key was invalid.

503

The PDFreactor Web Service is running and reachable, but not in a state to perform the requested operation.

Successful conversion information

get /conversions/finished/successful

http://localhost:9423/service/monitor/conversions/finished/successful

Retrieves information about the successfully finished conversions on the server.

Authorizations:

adminKeyQueryAuth

Responses

200

Operation successful

401

The client failed an authorization check, e.g. because a supplied API key was invalid.

503

The PDFreactor Web Service is running and reachable, but not in a state to perform the requested operation.

Failed conversion information

get /conversions/finished/failed

http://localhost:9423/service/monitor/conversions/finished/failed

Retrieves information about the erroneously finished conversions on the server.

Authorizations:

adminKeyQueryAuth

Responses

200

Operation successful

401

The client failed an authorization check, e.g. because a supplied API key was invalid.

503

The PDFreactor Web Service is running and reachable, but not in a state to perform the requested operation.

Service logs

get /log

http://localhost:9423/service/monitor/log

Retrieves a batch of messages from the service log. The "index" parameter specifies the start index. The response contains the "next" index for the next batch of messages. This resource is designed to be called in regular intervals to get a continuous stream of log output.

Authorizations:

adminKeyQueryAuth

query Parameters

index

integer

The index of the next batch of log messages. If not supplied or less than 0, the most current messages are returned.

Responses

200

Operation successful

401

The client failed an authorization check, e.g. because a supplied API key was invalid.

503

The PDFreactor Web Service is running and reachable, but not in a state to perform the requested operation.

Response samples

Content type

Copy

Expand all Collapse all


{"messages": 
["string"
],
"next": 0
}