Create Report

Creates a report based on the report id and report parameters.

Resource Information

Scopereports

Deprecated scope name:   create_report

App TypeAll
Authorization TypeAccess token
URI /v4/reports/{reportId}?lang={lang}&module={module}
HTTP MethodPOST
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
langStringNo Indicates the language applied.7.3.2
modulestringYes Get All Modules Use to filter by the module.7.3.2
reportIdstringYes Get All Report Definitions A unique system-generated identification number for a report.7.3.2
entityIdstringNo The unique ID of the entity or record.7.3.2
entityTypestringNo The type of entity.7.3.2
parametersparameters{}No Contains the fields that define report parameters.7.3.2
parameters.<customType>stringNo A custom field name and value pair.7.3.2

Example

Sample Request Head

POST https://apis.accela.com/v4/reports/4271?module=Licenses

Sample Request Body

{
  "parameters": {
    "PUBLICUSERID": "PUBLICUSER12345",
    "Param_Date": "04/27/2015"
  }
}

Notes

The example requests a report for reportId=4271 in the Licenses module with the given report parameters. (The report parameters are configured in Report Manager.)

Response Information

FieldTypeDescriptionAutomation Version
resultvoidThe returned object is not JSON data.7.3.2
statusintegerThe record status.7.3.3

Example

Sample Response Body

%PDF-1.7
%����
1 0 obj
<<
/Type /Catalog
/Pages 2 0 R
/PageMode /UseNone
/ViewerPreferences <<
/FitWindow true
/PageLayout /SinglePage
/NonFullScreenPageMode /UseNone
>>
>>
endobj
5 0 obj
<<
/Length 37
/Filter [ /FlateDecode ]
>>
stream
x�3T0BC0�� �  �ҹ � w( (�� Ε� ی 3endstream
endobj
2 0 obj
<<
/Type /Pages
/Kids [ 8 0 R ]
/Count 1
/MediaBox 3 0 R
/CropBox 4 0 R
>>
endobj
3 0 obj
[ 0 0 0 0 ]
endobj
4 0 obj
[ 0 0 0 0 ]
endobj
6 0 obj
<<
/ProcSet 7 0 R
>>
endobj
7 0 obj
[ /PDF /Text  ]
endobj
8 0 obj
<<
/Type /Page
/Parent 2 0 R
/Resources 6 0 R
/Contents [ 5 0 R ]
>>
endobj
9 0 obj
(Powered By Crystal)
endobj
10 0 obj
(Crystal Reports)
endobj
11 0 obj
<<
/Producer (Powered By Crystal)
/Creator (Crystal Reports)
>>
endobj
xref
0 12
0000000000 65535 f
0000000017 00000 n
0000000312 00000 n
0000000411 00000 n
0000000441 00000 n
0000000194 00000 n
0000000471 00000 n
0000000512 00000 n
0000000546 00000 n
0000000638 00000 n
0000000677 00000 n
0000000714 00000 n
trailer
<<
/Size 12
/Root 1 0 R
/Info 11 0 R
>>
startxref
802
%%EOF