Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Report templates hold all configurable information that reports can have. This includes the report title, instructions, logos, included project fields, and sort orders. In order to know which template_id to use, you may need to query all reports and choose which template to use from the list of results. To do so, you should first make a GET request to /resources/reports/templates.

You should see something similar to the following result:

Code Block
{
    "success": true,
    "message": "3 record(s) found",
    "data": [
        {
            "options": {
                "sort": [
                    "groupName",
                    "reviewType",
                    "reviewerName"
                ],
                "includedProjectFields": [
                    "projectNumber",
                    "address",
                    "projectName",
                    "dueDate",
                    "startDate",
                    "notes",
                    "scopeOfWork",
 
                  "dates"
                ]
            },
            "id": 2,
            "jsReport_id": "H1ls_En1OH",
            "name": "Irvine Report Template",
            "title": "EPR Corrections Report",
            "logo": "https://epr-qa.s3-us-west-2.amazonaws.com/reportLogo/1570148452674Orange.jpg",
            "instructions": "Example Instructions",
            "createdAt": "2019-10-08T21:07:30.000Z",
            "updatedAt": "2019-11-13T16:42:16.000Z"
        },
        ...]
}

...

  • projectName

  • contact

  • projectType

  • submittal

  • occupancy

  • constructionType

  • squareFootage

  • buildingHeight

  • applicationType

  • serviceArea

  • site

...

For additional information please refer to the swagger documentation at <portal>.eplansoftreview.com/api/core/ under Reports.