ReportId

The id of the report you wish to return. The ReportId is equal to the id parameter in the report’s Permanent link e.g. in this example I am returning a report with URL: https://uat.icasework.com/report?id=50521&db=[youriCaseworkAccount]

Open

“50521”

Yes.

Format

The format for the report output. Default is "xml"

“csv” or “json” or “xml”

No.

CSVHeader

Specifies whether a comma separated header should be included the data; this will define the column headers if this file is imported. This is only relevant if Format is equal to “csv”.

“yes” or “true”

No.

CSVFooter

Specifies a comma separated footer to be placed after the data; this will output the number of rows in the response. This is only relevant if Format is equal to “csv”.

“yes” or “true”

No.

CSVFields

Allows the report output to be filtered to only return details from a specific column; the values to use can be obtained from the header that can be included in the response when CSVHeader is true or from the Attribute column of the data dictionary. This is only relevant if Format is equal to “csv”.

“casedetailscomplaint.details”

No.

CSVDelimitor

Specifies the delimiter character to be used when generating the csv. This is only relevant if Format is equal to “csv”.

“*”

No.

Compression

Pass the value "gzip" to compress the output of the report

"gzip"

No.

Units

Used to override the default report timeframes and defines the unit to be used in conjunction with Multiples or periodMultiples; its default is Quarter.

The start date of the period being queried is equal to:

• Units*Multiples before today if Units is in the past

• today if Units is in the future.

The end date of the period being queried is equal to:

• Units*Multiples after today if Units is in the future

• today if Units is in the past.

“Year to date” or “Month to date” or “Week to date” or “Next weeks” or “Next days“ or “Previous year” or “Previous month” or “Previous quarter” or “Previous financial year” or “Previous municipal year” or “Today”

No.

periodUnits

Used to override the default report timeframes and defines the unit to be used in conjunction with Multiples or periodMultiples. This will override the value passed for Units if a value is passed.

The start date of the period being queried is equal to:

• periodUnits*periodMultiples before today if periodUnits is in the past

• today if periodUnits is in the future.

The end date of the period being queried is equal to:

• periodUnits*periodMultiples after today if periodUnits is in the future

• today if periodUnits is in the past.

“Year to date” or “Month to date” or “Week to date” or “Next weeks” or “Next days“ or “Previous year” or “Previous month” or “Previous quarter” or “Previous financial year” or “Previous municipal year” or “Today”

No.

Multiples

Used to override the default report timeframes and defines the magnitude to be used in conjunction with periodUnits or Units; its default is 1.

“5”

No.

periodMultiples

Used to override the default report timeframes and defines the magnitude to be used in conjunction with periodUnits or Units. This will override the value passed for Multiples.

“2”

No.

FromTime

Used to override the default report timeframes. This defines the starting date time of the period being queried and should be in YYYY-MM-DD hh:mm:ss format. This overrides the period’s starting date time as calculated by periodMultiples/Multiples/Units/periodUnits.

“2022-09-21 00:00:01”

No.

From

Used to override the default report timeframes. This defines the starting date of the period being queried and should be in YYYY-MM-DD format. This will override the value passed for FromTime if a value is passed. This overrides the period’s starting date as calculated by periodMultiples/Multiples/Units/periodUnits.

“2022-09-21”

No.

periodFrom

Used to override the default report timeframes. This defines the starting date of the period being queried and should be in YYYY-MM-DD format. This will override the value passed for FromTime and From if a value is passed. This overrides the period’s starting date as calculated by periodMultiples/Multiples/Units/periodUnits.

“2022-09-21”

No.

UntilTime

Used to override the default report timeframes. This defines the end date time of the period being queried and should be in YYYY-MM-DD hh:mm:ss format. This overrides the period’s starting date time as calculated by periodMultiples/Multiples/Units/periodUnits.

“2022-09-21 23:59:59”

No.

Until

Used to override the default report timeframes. This defines the end date of the period being queried and should be in YYYY-MM-DD format. This overrides the period’s starting date as calculated by periodMultiples/Multiples/Units/periodUnits.

“2022-09-21”

No.

periodUntil

Used to override the default report timeframes. This defines the end date of the period being queried and should be in YYYY-MM-DD format. This overrides the period’s starting date as calculated by periodMultiples/Multiples/Units/periodUnits. This overrides the value passed into Until.

“2022-09-21”

No.

AttributeFilter

Used to override the default report filters. You should specify an attribute filtering rule on the ad hoc report;the value passed into this parameter will override the value(s) in the first attribute filtering rule’s Value field.

“36512”

No.

AttributeFilter2

Used to override the default report filters. You should specify an attribute filtering rule on the ad hoc report;the value passed into this parameter will override the value(s) in the second attribute filtering rule’s Value field.

“36512”

No.

AttributeFilter3

Used to override the default report filters. You should specify an attribute filtering rule on the ad hoc report;the value passed into this parameter will override the value(s) in the third attribute filtering rule’s Value field.

“36512”

No.

Keywords

Used to override the default report filters. Overrides the keyword filters specified for the ad hoc report.

“icasework,civica,great”

No.

8000

Invalid HTTP Method.

Check the HTTP method; this should be a GET

8001

API not available here - please use [[correct endpoint]]

Check the endpoint of the request

8002

API not available here - please use [[correct endpoint]]

Check the endpoint of the request

8003

Required parameter ReportId was not supplied.

Pass a value for ReportId

8051

Report ReportId does not exist

Pass a valid value for ReportId

8052

Report ReportId is not accessible for this API key

Only shared reports may be authenticated by an API key assigned to a user that doesn’t have reporting access; or an API key that doesn’t have an assigned user. The user assigned to the API key will need reporting access to authenticate access to that user’s unshared reports; other users' unshared reports cannot be accessed.

8061

An unexpected error occurred during XML transformation

Try to make the request again and reach out to iCasework support if the same issue occurs.

8063

An unexpected error occurred during XML transformation

Try to make the request again and reach out to iCasework support if the same issue occurs.

8099

Various

Check the X-Application-Error-Info header for more information.

8021

Incorrect key or signature

Check the authentication method

8021

Invalid token (6)

Check the authentication method