Request Types and Data Transfers

The SAP Fieldglass Web Service Technical Specification supports both upload request and download request types.

Upload Requests

Upload requests are used to upload data from a client system to SAP Fieldglass. Upload requests support multiple data formats, including text, XML, and cXML.

When using an API version of a connector set to asynchronous, or any BULK upload, the client system receives a response from SAP Fieldglass once it's confirmed that SAP Fieldglass has successfully received the file. The response specifies the success or failure in initiating the upload, but it doesn't specify the success or failure of individual data records processed. For more information, see the Asynchronous Data Transfers section.

Download Requests

Download requests are used to download data from SAP Fieldglass to a client system. Consult the connector documentation for information on the various data formats supported. To view connector documentation, refer to the Fieldglass Connector Library.

Synchronous Data Transfers

Synchronous data transfers are used to execute the entirety of a transaction within a single Web service call. Synchronous data transfers are suitable when the underlying connector execution isn't complex or time consuming due to volume.

Asynchronous Data Transfers

Asynchronous data transfers are used to initiate the transaction at one given time, but complete the transaction cycle later. Asynchronous data transfers are suitable when the connector request is complex and may take longer to complete (this can help accommodate shorter connection/read timeouts).

Asynchronous data transfers executed via the4 following steps and associated operations:
  1. A data transfer request is submitted using the dataTransfer operation. You can generate a unique Client Reference ID and associate it with the request (see dataTransfer operation elements). Optionally, you can use the unique SAP Fieldglass Transaction ID to associate with the request.

  2. (Optional) The status of the data transfer request can be verified using the dataTransferStatus operation, which accepts both client reference ID and SAP Fieldglass transaction ID. If you associated a client reference ID with the data transfer request, you can specify that client reference ID or the SAP Fieldglass transaction ID that was generated. If you didn't associate a client reference ID with the data transfer request, you must specify the SAP Fieldglass transaction ID. The status response indicates whether the associated transaction completed successfully, is in progress, or failed.

  3. Upon completion of the associated transaction, you can invoke the getDataByTransactionId operation to receive the transaction detail. This operation accepts both client reference ID and SAP Fieldglass transaction ID. If you associated a client reference ID with the data transfer, you can specify a client reference ID or SAP Fieldglass transaction ID. If you didn't associate a client reference ID with the download request, you must specify the SAP Fieldglass transaction ID.