Class GeometrySetsApi

GeometrySetsApi - object-oriented interface

export

Hierarchy

BaseAPI
- GeometrySetsApi

Index

Constructors

constructor

Methods

Constructors

constructor

new GeometrySetsApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): GeometrySetsApi

Inherited from BaseAPI.constructor
- Defined in base.ts:51
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns GeometrySetsApi

Methods

createGeometrySet

createGeometrySet(requestParameters: GeometrySetsApiCreateGeometrySetRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<QueuedJob, any>>

- Defined in api.ts:9261
Create a geometry-set. Once created, create scenes via the createScene API. For details, see our Import data guide.

throws
{RequiredError}

memberof
GeometrySetsApi

Parameters
- requestParameters: GeometrySetsApiCreateGeometrySetRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<QueuedJob, any>>

getGeometrySet

getGeometrySet(requestParameters: GeometrySetsApiGetGeometrySetRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<GeometrySet, any>>

- Defined in api.ts:9277
Get a geometry-set by ID.

throws
{RequiredError}

memberof
GeometrySetsApi

Parameters
- requestParameters: GeometrySetsApiGetGeometrySetRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<GeometrySet, any>>

getGeometrySets

getGeometrySets(requestParameters?: GeometrySetsApiGetGeometrySetsRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<GeometrySetList, any>>

- Defined in api.ts:9293
Get geometry-sets.

throws
{RequiredError}

memberof
GeometrySetsApi

Parameters
- requestParameters: GeometrySetsApiGetGeometrySetsRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<GeometrySetList, any>>