Versions Compared

Key

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

...

Table of Contents
maxLevel3
typeflat

...

Overview

The following operations allow you to work with data uploads. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with data uploads, see Sample configuration.

OperationDescription

Working with Data Uploads in GoodData2getDataset

Retrieves the status of data uploads for a specific dataset.

Working with Data Uploads in GoodData2getUploadStatusRetrieves the status of the upload pull request. 
Working with Data Uploads in GoodData2uploadData

Executes a pull request to an already uploaded dataset.

Operation details

This section provides details on the operations.

Anchor
getDataset
getDataset
Retrieving a dataset

The getDataset operation helps you identify datasets in your project.

Code Block
languagexml
titlegetDataset
<gooddata.getDataset>
	<projectId>{$ctx:projectId}</projectId>
</gooddata.getDataset> 
Properties
  • projectId: Required - The project ID.
Anchor
request
request
Sample request

Following is a sample REST request that can be handled by the getDataset operation.

Code Block
languagexml
titleSample Request for getDataset
{
	"apiUrl":"https://secure.gooddata.com",
	"username":"user@gmail.com",
	"password":"user@123",
	"remember":"1",
	"projectId":"qy48iv4flikdlcwpwioizuip74wt8nb5"
} 
Related GoodData documentation

http://docs.gooddata.apiary.io/#get-%2Fgdc%2Fmd%2F%7Bproject-id%7D%2Fquery%2Fdatasets

Anchor
getUploadStatus
getUploadStatus
Retrieving the upload status

The getUploadStatus operation retrieves the status of the upload pull request. 

Code Block
languagexml
titlegetUploadStatus
<gooddata.getUploadStatus>
	<taskId>{$ctx:taskId}</taskId>
    <projectId>{$ctx:projectId}</projectId>
</gooddata.getUploadStatus> 
Properties
  • taskId: Required - The ID of the upload task.
  • projectId: Required - The ID of the project.
Sample request

Following is a sample REST request that can be handled by the getUploadStatus operation.

Code Block
languagexml
titleSample Request for getUploadStatus
{
	"apiUrl":"https://secure.gooddata.com",
	"username":"user@gmail.com",
	"password":"user@123",
	"remember":1,
	"projectId":"qy48iv4flikdlcwpwioizuip74wt8nb5",
	"taskId":"15"
} 
Related GoodData documentation

http://docs.gooddata.apiary.io/#get-%2Fgdc%2Fmd%2F%7Bproject-id%7D%2Fetl%2Ftask%2F%7Btask-id%7D

Anchor
uploadData
uploadData
Uploading data

The uploadData operation executes a pull request to an upload archive you have uploaded to a WebDav directory. The upload archive should be named upload.zip and must contain upload_info.json (SLI manifest) and a CSV file with the data. 

Code Block
languagexml
titleuploadData
<gooddata.uploadData>
	<pullIntegration>{$ctx:pullIntegration}</pullIntegration>
    <projectId>{$ctx:projectId}</projectId>
</gooddata.uploadData> 
Properties
  • pullIntegration: The WebDav directory with the upload archive.
  • projectId: Required - The project ID.
Sample request

Following is a sample REST request that can be handled by the uploadData operation.

Code Block
languagexml
titleSample Request for uploadData
{
	"apiUrl":"https://secure.gooddata.com",
	"username":"user@gmail.com",
	"password":"user@123",
	"remember":1,
	"projectId":"qy48iv4flikdlcwpwioizuip74wt8nb5",
	"pullIntegration":"sarindu"
} 
Related GoodData documentation

http://docs.gooddata.apiary.io/#post-%2Fgdc%2Fmd%2F%7Bproject-id%7D%2Fetl%2Fpull

Anchor
sample
sample

Sample configuration

Following is a sample proxy service that illustrates how to connect to GoodData with the init operation and use the getDataset operation. The sample request for this proxy can be found in getDataset sample request. You can use the sample below as a template for using other operations in this category.

...