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

POST/pdf-service/v1//_create

Query parameters

Body

*/*

requestinfo object with input json for pdf

ResponseInfoRequestInfo (object)

moduleObjectWithNameobject

Response

201400404500

PDF successfully created and response sent back

Body

*/*

ResponseInfoResponseInfo (object)

messagestring

filestoreIdsarray of string

filestoreids of PDFs from filestore service

jobidstring

jobid of pdf create reques

createdtimenumber

start time of job

endtimenumber

end time of job

tenantidstring

totalcountnumber

keystring

key to be used to pick pdf configs

documentTypestring

documentype defined in pdf config

moduleNamestring

modulename defined in pdf config

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/pdf-service/v1//_create?tenantId=text&key=text', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "resMsgId": "text",
    "msgId": "text",
    "status": "text",
    "correlationId": "text",
    "userInfo": {
      "id": 0,
      "userName": "text",
      "name": "text",
      "type": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "roles": [
        {
          "id": 0,
          "name": "text",
          "code": "text"
        }
      ],
      "tenantId": "text",
      "uuid": "text"
    }
  },
  "message": "text",
  "filestoreIds": [
    "text"
  ],
  "jobid": "text",
  "createdtime": 0,
  "endtime": 0,
  "tenantid": "text",
  "totalcount": 0,
  "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

POST/pdf-service/v1//_createnosave

Query parameters

Body

*/*

requestinfo object with input json for pdf

ResponseInfoRequestInfo (object)

moduleObjectWithNameobject

Response

201400500

PDF created and returned in binary

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/pdf-service/v1//_createnosave?tenantId=text&key=text', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

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

POST/pdf-service/v1//_search

Query parameters

Body

*/*

requestinfo object

apiId*string

ver*string

ts*integer (int64)

action*string

did*string

key*string

msgId*string

authToken*string

correlationId*string

userInfo*User (object)

Response

200400404500

Pdf information successfully retrieved

Body

*/*

ResponseInfoResponseInfo (object)

messagestring

filestoreIdsarray of string

filestoreids of PDFs from filestore service

jobidstring

jobid of pdf create reques

createdtimenumber

start time of job

endtimenumber

end time of job

tenantidstring

totalcountnumber

keystring

key to be used to pick pdf configs

documentTypestring

documentype defined in pdf config

moduleNamestring

modulename defined in pdf config

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/pdf-service/v1//_search?jobid=text&entityid=text', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "action": "text",
      "apiId": "text",
      "authToken": "text",
      "correlationId": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "ts": 0,
      "userInfo": {
        "emailId": "text",
        "id": 0,
        "mobileNumber": "text",
        "name": "text",
        "roles": [
          {
            "code": "text",
            "id": 0,
            "name": "text"
          }
        ],
        "tenantId": "text",
        "type": "text",
        "userName": "text",
        "uuid": "text"
      },
      "ver": "text"
    }),
});
const data = await response.json();

Response

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "resMsgId": "text",
    "msgId": "text",
    "status": "text",
    "correlationId": "text",
    "userInfo": {
      "id": 0,
      "userName": "text",
      "name": "text",
      "type": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "roles": [
        {
          "id": 0,
          "name": "text",
          "code": "text"
        }
      ],
      "tenantId": "text",
      "uuid": "text"
    }
  },
  "message": "text",
  "filestoreIds": [
    "text"
  ],
  "jobid": "text",
  "createdtime": 0,
  "endtime": 0,
  "tenantid": "text",
  "totalcount": 0,
  "key": "text",
  "documentType": "text",
  "moduleName": "text"
}