REST endpoints
These REST endpoints are available:
POST /ca/api/distribution/v1/submit
Submit
can generate documents, retrieve documents from Document Management, merge documents, and distribute the output to different targets. Example of targets are email, print, or stored back to Document Management.Submit
is an asynchronous method that puts the job in a queue. The job is picked up as soon as possible.POST /ca/api/distribution/v1/retrieve/stream
You can use
retrieve
to generate one document or retrieve a document and return it to the client.Data is sent in json structure.
GET /ca/api/distribution/v1/status
You can use
status
to query the status of an ongoing job.The status of the job is stored for two days until the job is archived.
GET /ca/api/distribution/v1/batchStatus
You can use
batchStatus
to query the status of several ongoing jobs with the same batchId set.The status of the job is stored for two days until the job is archived. After the job is archived, the data remains for 14 more days until it is deleted. After the data is deleted, it remains for six more days until it is purged.
GET /ca/api/distribution/v1/printer/search
This method returns a list of all printers. If a printer name is specified, the method returns a subset of printers.