IOrganizationGeoCollectionsService

Home > @gooddata/sdk-backend-spi > IOrganizationGeoCollectionsService

IOrganizationGeoCollectionsService interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Service for managing organization-level custom geo collections.

Signature:

export interface IOrganizationGeoCollectionsService 

Remarks

Importing geo data into a collection follows a three-step workflow: 1. Upload a file via IOrganizationGeoCollectionsService.uploadGeoCollectionFile() 2. Convert it via IOrganizationGeoCollectionsService.convertGeoCollectionFile() 3. Import it via IOrganizationGeoCollectionsService.importGeoCollectionFile()

Methods

Method	Description
convertGeoCollectionFile(location)	(ALPHA) Convert a staged geo file into an importable format.
createGeoCollection(definition)	(ALPHA) Create a new custom geo collection.
deleteGeoCollection(id)	(ALPHA) Delete a custom geo collection.
getAll()	(ALPHA) Get all custom geo collections.
getGeoCollection(id)	(ALPHA) Get a single custom geo collection by its identifier.
importGeoCollectionFile(collectionId, location)	(ALPHA) Import a staged and converted file into a geo collection.
updateGeoCollection(geoCollection)	(ALPHA) Update an existing custom geo collection.
uploadGeoCollectionFile(file)	(ALPHA) Upload a file to staging for subsequent import into a geo collection.