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
moduleObjectWithNameobjectOptional
Responses
201
PDF successfully created and response sent back
*/*
post
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

post

Generate pdf and return as binary response

Query parameters
tenantIdstringRequired

tenantId for pdf

keystringRequired

key to identify correct PDF configurarion

Body
moduleObjectWithNameobjectOptional
Responses
201
PDF created and returned in binary
post
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

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
Responses
200
Pdf information successfully retrieved
*/*
post
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?