PDF Generation
PDF Service APIs
Generate output in PDF format and return its filestore ids.
Generate PDF and store output pdfs to filestore and return their filestoreids. The information is also saved into DB so that using _search endpoint we can retrieve already generated pdfs.
Generate pdfs and return their filestoreids
tenantId for pdf
key to identify correct PDF configurarion
PDF successfully created and response sent back
Incorrect request
PDF with search parameters was not found
Error happened at server
POST / HTTP/1.1
Host: _create?tenantId=text&key=text
Content-Type: */*
Accept: */*
Content-Length: 362
{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"authToken": "text",
"correlationId": "text",
"userInfo": {
"id": 1,
"userName": "text",
"name": "text",
"type": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"id": 1,
"name": "text",
"code": "text"
}
],
"tenantId": "text",
"uuid": "text"
}
},
"moduleObjectWithName": {}
}
{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "text",
"correlationId": "text",
"userInfo": {
"id": 1,
"userName": "text",
"name": "text",
"type": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"id": 1,
"name": "text",
"code": "text"
}
],
"tenantId": "text",
"uuid": "text"
}
},
"message": "text",
"filestoreIds": [
"text"
],
"jobid": "text",
"createdtime": 1,
"endtime": 1,
"tenantid": "text",
"totalcount": 1,
"key": "text",
"documentType": "text",
"moduleName": "text"
}
Generates pdf without storing any information on filestore or in DB. The generated pdf would be returned as binary response
Generate pdf and return as binary response
tenantId for pdf
key to identify correct PDF configurarion
PDF created and returned in binary
If correct request not sent
Error occurred at server
POST / HTTP/1.1
Host: _createnosave?tenantId=text&key=text
Content-Type: */*
Accept: */*
Content-Length: 362
{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"authToken": "text",
"correlationId": "text",
"userInfo": {
"id": 1,
"userName": "text",
"name": "text",
"type": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"id": 1,
"name": "text",
"code": "text"
}
],
"tenantId": "text",
"uuid": "text"
}
},
"moduleObjectWithName": {}
}
No content
Get filestoreids and other information about already generated pdf by searching on jobid or entityid with other optional search parameters
Get details for already generated PDF
tenantId for pdf
search based on unique id of pdf job.
search based on unique id of a document
Whether single object or multiobject pdf required
Pdf information successfully retrieved
Incorrect request
PDF with search parameters was not found
Error happened at server
POST / HTTP/1.1
Host: _search?jobid=text&entityid=text
Content-Type: */*
Accept: */*
Content-Length: 319
{
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"authToken": "text",
"correlationId": "text",
"userInfo": {
"id": 1,
"userName": "text",
"name": "text",
"type": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"id": 1,
"name": "text",
"code": "text"
}
],
"tenantId": "text",
"uuid": "text"
}
}
{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "text",
"correlationId": "text",
"userInfo": {
"id": 1,
"userName": "text",
"name": "text",
"type": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"id": 1,
"name": "text",
"code": "text"
}
],
"tenantId": "text",
"uuid": "text"
}
},
"message": "text",
"filestoreIds": [
"text"
],
"jobid": "text",
"createdtime": 1,
"endtime": 1,
"tenantid": "text",
"totalcount": 1,
"key": "text",
"documentType": "text",
"moduleName": "text"
}
Last updated
Was this helpful?