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.

post

Generate pdfs and return their filestoreids

Query parameters

tenantIdstringrequired

tenantId for pdf

keystringrequired

key to identify correct PDF configurarion

Body

ResponseInfoobjectoptional

moduleObjectWithNameobjectoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/pdf-service/v1//_create?tenantId=text&key=text' \
  --header 'Content-Type: */*' \
  --data '{
    "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": {}
  }'

201

400

404

500

201

{
  "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"
}

PDF successfully created and response sent back

Generates pdf without storing any information on filestore or in DB. The generated pdf would be returned as binary response

post

Generate pdf and return as binary response

Query parameters

tenantIdstringrequired

tenantId for pdf

keystringrequired

key to identify correct PDF configurarion

Body

ResponseInfoobjectoptional

moduleObjectWithNameobjectoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/pdf-service/v1//_createnosave?tenantId=text&key=text' \
  --header 'Content-Type: */*' \
  --data '{
    "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": {}
  }'

201

400

500

201

No body

PDF created and returned in binary

Get filestoreids and other information about already generated pdf by searching on jobid or entityid with other optional search parameters

post

Get details for already generated PDF

Query parameters

tenantidstringoptional

tenantId for pdf

jobidstringrequired

search based on unique id of pdf job.

entityidstringrequired

search based on unique id of a document

isconsolidatedstringoptional

Whether single object or multiobject pdf required

Body

apiIdstringrequired

verstringrequired

tsinteger · int64required

actionstringrequired

didstringrequired

keystringrequired

msgIdstringrequired

authTokenstringrequired

correlationIdstringrequired

userInfoobjectrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/pdf-service/v1//_search?jobid=text&entityid=text' \
  --header 'Content-Type: */*' \
  --data '{
    "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"
    }
  }'

200

400

404

500

200

{
  "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"
}

Pdf information successfully retrieved