Versions Compared

Key

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

Overview


This web service retrieves the report output (PwsReport) for a specified report (PwsReportRef)

Request Format


Panel
titlePwsGetReportOutput Request
  • PwsGetReportOutput
    • serviceRequest: PwsGetReportOutputRq
      • RequestId: Int32
      • SessionTicket: String
      • AamGantt: String
      • ColumnHeaders: String
      • DateFormat: String
      • Delimiter: String
      • ExplicitFieldsOnly: String
      • Format: String
      • Function: String
      • IncludeMetadata: String
      • ReportIdentity: PwsReportRef
      • AccountCode: String
      • AuthToken: String
      • UserName: String

...

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.

1

SessionTicket

String

Yes 


Click here for more information.

AVkEBhpRgyZRD+KUKYoZCQ==

AamGantt

String

No

 NO???

This affects only CSV output and only for the Task Analysis report. It causes task hierarchy level fields to be suppressed. Since the number of task hierarchy fields depends on the task depth, the number of report fields can change between report runs. The variability of the number of report fields is not handled well by AAM.

NO

ColumnHeaders

String

No???

firstrow

Affects CSV and XML output only. If "firstrow" then the first row will have column headers (field names). If "none" then column headers will not be present.


DateFormat

String

No


The date formats in the report output

UTC

Delimiter

String

No


The data delimiter in the report output 

COMMA or TAB

TAB

ExplicitFieldsOnly

String

No

 NONO

If set to 'trueNO', only explicitly requested fields will be included in the report output

NO

Format

String

No???

JSON

Output format: XLS. MDB, JSON, JSONP, or CSV. If the report is XLS or MDB then we return a byte array. Otherwise we return a string.


Function

String

No ???


This is the JSONP function.


IncludeMetadata

String

No 

YES YES

If set to 'trueYES', metadata as well as requested fields will be included in the report output


ReportIdentity

PwsReportRef

Yes


The report identity 


AccountCode

String

No 


The account code associated with the report


AuthToken

String

No


The authorization token associated with the report


UserName

String

No


The user name when acting on behalf of another user


...

Panel
titlePwsGetReportOutput Response

...

Element

Data Type

Description

Sample Data

Messages

PwsMessage[]

Click here for more information


ResponseId

Int32

Click here for more information


Status

RequestStatus

Click here for more information


ServerTimestampUtc

DateTime

Click here for more information


Report

PwsReport

The full details of the report


RedirectUrl

String

 The redirect URL when access the report via a browser


...


ErrorNumber

ErrorCode

ErrorText

22001InvalidValueForReportFormatInvalid value for Format parameter.
22003InvalidValueForReportColumnHeadersInvalid value for ColumnHeaders parameter.
22006InvalidValueForReportDelimiterThe value specified for delimiter is invalid. Valid values are COMMA and TAB.
51006ReportRequestNotFoundThe specified report request was not found or you are not on the distribution list for this report.