/
SubmitReportSpec

SubmitReportSpec

This service submits an existing report spec. The report spec is identified by its UID, which is a 64 bit integer. The UID is obtained by right clicking on a report and choosing Advanced | Show report spec UID.

The report spec must belong to the user or the error code CouldNotFindReportSpec will be returned. Public reports are not supported, they must belong to the person running the report. 

Downloading the Report

When the report is submitted, the report output's UID and URL are returned. Pass in the UID to the GetReportStatus web service to determine the status of the report. Once the report successfully completes, use the returned URL to get the report output in one of two ways:

HTTP GET

In this case the requestor will be asked to log in to Projector (if not already logged in) before given access to the file.

HTTP POST

In this case the requestor can supply authentication data, AccountName, EmailAddress and Password in the body of the request as shown below.

Retrieve Report via POST
<!DOCTYPE html >
<html>
<head>
	<title>Testing</title>
</head>
<body>
	<form method="POST" action="https://secure.projectorpsa.com/Reports/Output1152921504607426094.xls" >
		<input type="text" value="" name="AccountName" placeholder="Account"  />
		<input type="text" value="" name="EmailAddress" placeholder="Email"  />
		<input type="text" value="" name="Password" placeholder="Password" />
		<input type="submit" />
	</form>
</body>
</html>

Rate Limiting

In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm.  When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate.  Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly.  For more information please visit: Projector Rate Limiting Behavior.

Request

The service request contains:

Name

Data Type

Required?

Default Value

Discussion

ReportSpecUid

long

yes


64 bit integer that uniquely identifies the report spec


Response

If the report spec exists and belongs to the user, then the following data is returned:

Name

Data Type

Discussion

ReportOutputUid

long

Uniquely identifies the report output.

ReportOutputFileUrl

string(255)

The URL of the report output file. This is deprecated and doesn't return anything useful. Use RESTful web services and UID to get the report data.

Related content

PwsGetReportOutput
PwsGetReportOutput
More like this
GetWebServiceUrl
GetWebServiceUrl
Read with this
Report Web Services
Report Web Services
More like this
Methods
Read with this
GetReportStatus
GetReportStatus
More like this
PwsAuthenticate
PwsAuthenticate
Read with this