IWorkspaceExportDefinitionsService
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Warning: This API is now obsolete.
Not supported for write anymore
Service to query, update or delete exportDefinitions, and other methods related to exportDefinitions. Check IExportDefinitionMetadataObject for more details.
export interface IWorkspaceExportDefinitionsService
Methods
Method | Description |
|---|---|
(ALPHA) Create and save exportDefinition for the provided exportDefinition | |
(ALPHA) Delete exportDefinition with the given reference | |
(ALPHA) Request exportDefinition for the given reference | |
(ALPHA) Queries workspace exportDefinitions, using various criteria and paging settings. | |
(ALPHA) List exportDefinitions | |
(ALPHA) Update provided exportDefinition |
Method details
IWorkspaceExportDefinitionsService.createExportDefinition()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Create and save exportDefinition for the provided exportDefinition
createExportDefinition(exportDefinition: IExportDefinitionMetadataObjectDefinition): Promise<IExportDefinitionMetadataObject>;
Parameters
Parameter | Type | Description |
|---|---|---|
exportDefinition | exportDefinition to create |
Returns
Promise<IExportDefinitionMetadataObject>
promise of created exportDefinition
IWorkspaceExportDefinitionsService.deleteExportDefinition()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Delete exportDefinition with the given reference
deleteExportDefinition(ref: ObjRef): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | ref of the exportDefinition to delete |
Returns
Promise<void>
promise of undefined
IWorkspaceExportDefinitionsService.getExportDefinition()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Request exportDefinition for the given reference
getExportDefinition(ref: ObjRef, options?: IGetExportDefinitionOptions): Promise<IExportDefinitionMetadataObject>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | exportDefinition reference | |
options | (Optional) specify additional options |
Returns
Promise<IExportDefinitionMetadataObject>
promise of exportDefinition
IWorkspaceExportDefinitionsService.getExportDefinitions()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Queries workspace exportDefinitions, using various criteria and paging settings.
getExportDefinitions(options?: IExportDefinitionsQueryOptions): Promise<IExportDefinitionsQueryResult>;
Parameters
Parameter | Type | Description |
|---|---|---|
options | (Optional) query options; if not specified defaults to no sorting, no filtering and 50 items per page |
Returns
Promise<IExportDefinitionsQueryResult>
paged results, empty page with zero total count if there are no exportDefinitions stored in the workspace
IWorkspaceExportDefinitionsService.getExportDefinitionsQuery()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
List exportDefinitions
getExportDefinitionsQuery(): IExportDefinitionsQuery;
Returns
methods for querying exportDefinitions
IWorkspaceExportDefinitionsService.updateExportDefinition()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Update provided exportDefinition
updateExportDefinition(ref: ObjRef, exportDefinition: IExportDefinitionMetadataObjectDefinition): Promise<IExportDefinitionMetadataObject>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | ref of the exportDefinition to update | |
exportDefinition | exportDefinition to update |
Returns
Promise<IExportDefinitionMetadataObject>
promise of updated exportDefinition