Hilfe

Hinweis:

Wenn bei der Nutzung dieser Web-Service-Operation mit dem Process Development Kit (PDK) Probleme auftreten, kontaktieren Sie Ihren Systembetreuer.

Mit den Web-Service-Operationen startReportSync und startReportAsync können Sie Reports synchron oder asynchron generieren.

Parameter der Web-Service-Operationen startReportSync und startReportAsync können innerhalb einer variablen Argumentliste definiert werden. Die in der folgenden Tabelle aufgelisteten Parameter sind die Standardparameter, die beim Aufruf der Web-Service-Operation verwendet werden können. Weitere Parameter können mithilfe von vorhandenen Reports definiert werden, zum Beispiel mit der Web-Service-Operation getAvailableReports (Web-Service-Operation).

Für die Web-Service-Operation startReportSync wird, wenn der Parameter fileTargetPath nicht als Teil der REST-URL definiert ist, der Pfad des Reports zurückgegeben. Wenn der Parameter fileTargetPath in der REST-URL definiert wird, wird als Ergebnis der Reportgenerierung der Status DONE zurückgegeben.

Für die Web-Service-Operation startReportAsync wird eine ID zurückgegeben, die mit der Web-Service-Operation checkResult (ReportsService, Web-Service-Operation) weiterverarbeitet werden kann, um den Status der Reportgenerierung zu prüfen. Das Ergebnis des mit startReportAsync generierten Reports kann mit der Web-Service-Operation getResult (ReportsService, Web-Service-Operation) abgefragt werden.

Parameter	Datentyp	Verwendung	Beschreibung
`id`	Long	Erforderlich	Die ID des Reports.
`params`	String	Erforderlich, wenn ein Report mit Pflichtparametern generiert wird.	Die variable Argumentliste. Wenn der Parameter nicht angegeben wird oder ein leerer Wert angegeben ist, wird die URL des Reports generiert. Es können weitere Parameter und Werte innerhalb der variablen Argumentliste definiert werden.
`respondAsURL`	String	Optional	Eine URL des Reports kann zurückgegeben werden oder nicht: `true`: Der Report wird als URL zurückgegeben. `false`: Der Report wird nicht als URL zurückgegeben.
`respondAsAttachment`	String	Optional	Der Report kann als SOAP-Anhang zurückgegeben werden oder nicht: `true`: Der Report wird als SOAP-Anhang zurückgegeben. `false`: Der Report wird nicht als SOAP-Anhang zurückgegeben. Der Anhang kann nicht über REST gesendet werden.
`respondAsEncoded`	String	Optional	Der Report kann verschlüsselt zurückgegeben werden: `true`: Der Report wird verschlüsselt zurückgegeben. `false`: Es wird kein Report zurückgegeben. Wenn der Parameter `fileTargetPath` verwendet wird, kann der Report nicht verschlüsselt zurückgegeben werden.
`fileTargetName`	String	Optional	Der Name der Zieldatei. Die Dateiendung muss nicht angegeben werden, da das Ausgabeformat mit dem Parameter `p_sOutputFormat` definiert wird. Wenn der Parameter `fileTargetPath` nicht verwendet wird, wird der Pfad der Zieldatei hier angegeben.
`fileTargetPath`	String	Optional	Der Pfad der Zieldatei. Der Pfad muss auf dem Server existieren. Wenn der Parameter `fileTargetName` nicht verwendet wird, wird ein Name für die Zieldatei generiert.
`p_sOutputFormat`	Integer	Erforderlich	Das Ausgabeformat des Reports. Mögliche Werte: `1`: CSV `2`: XML `3`: HTML `4`: PDF

startReportSync, startReportAsync (Web-Service-Operationen)

REST-URLs für die synchrone Generierung von Reports können wie folgt definiert werden:

ReportsService: http://<SERVERNAME>:5555/axis2/services/ReportsService/startReportSync?id=9&params=p_sOutputFormat=2&params=respondAsURL=true&params=respondAsEncoded=true&params=fileTargetPath=../vmreports/user/&params=fileTargetName=TranslationReportEncoded

ReportsServiceJSON: http://<SERVERNAME>:5555/axis2/services/ReportsServiceJSON/startReportSync?id=9&params=p_sOutputFormat=2&params=respondAsURL=true&params=respondAsEncoded=true&params=fileTargetPath=../vmreports/user/&params=fileTargetName=TranslationReportEncoded

REST-URLs für die asynchrone Generierung von Reports können wie folgt definiert werden:

ReportsService: http://<SERVERNAME>:5555/axis2/services/ReportsService/startReportAsync?id=9&params=p_sOutputFormat=2&params=respondAsURL=true&params=respondAsEncoded=true&params=fileTargetPath=../vmreports/user/&params=fileTargetName=TranslationReportEncoded

ReportsServiceJSON: http://<SERVERNAME>:5555/axis2/services/ReportsServiceJSON/startReportAsync?id=9&params=p_sOutputFormat=2&params=respondAsURL=true&params=respondAsEncoded=true&params=fileTargetPath=../vmreports/user/&params=fileTargetName=TranslationReportEncoded