Class MetadataApi

Hierarchy

BaseAPI
- MetadataApi

Constructors

constructor

new MetadataApi(configuration?: Configuration): MetadataApi
Parameters
- configuration: Configuration = DefaultConfig
Returns MetadataApi
Inherited from BaseAPI.constructor
- Defined in runtime.ts:96

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

getVEOPStandardContentMetadata

getVEOPStandardContentMetadata(requestParameters: GetVEOPStandardContentMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTMetadataObjectInfo>
Retrieve metadata of a standard content part in a version by document ID, version ID, tab ID, owner ID, and part ID.
Parameters
- requestParameters: GetVEOPStandardContentMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTMetadataObjectInfo>
- Defined in apis/MetadataApi.ts:217

getVEOPStandardContentMetadataRaw

getVEOPStandardContentMetadataRaw(requestParameters: GetVEOPStandardContentMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTMetadataObjectInfo>>
Retrieve metadata of a standard content part in a version by document ID, version ID, tab ID, owner ID, and part ID.
Parameters
- requestParameters: GetVEOPStandardContentMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTMetadataObjectInfo>>
- Defined in apis/MetadataApi.ts:155

getWMVEMetadata

getWMVEMetadata(requestParameters: GetWMVEMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTMetadataObjectInfo>
Retrieve metadata by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetWMVEMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTMetadataObjectInfo>
- Defined in apis/MetadataApi.ts:295

getWMVEMetadataRaw

getWMVEMetadataRaw(requestParameters: GetWMVEMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTMetadataObjectInfo>>
Retrieve metadata by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetWMVEMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTMetadataObjectInfo>>
- Defined in apis/MetadataApi.ts:225

getWMVEPMetadata

getWMVEPMetadata(requestParameters: GetWMVEPMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTMetadataObjectInfo>
Retrieve metadata by document ID, workspace or version or microversion ID, tab ID, and Part ID.
Parameters
- requestParameters: GetWMVEPMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTMetadataObjectInfo>
- Defined in apis/MetadataApi.ts:385

getWMVEPMetadataRaw

getWMVEPMetadataRaw(requestParameters: GetWMVEPMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTMetadataObjectInfo>>
Retrieve metadata by document ID, workspace or version or microversion ID, tab ID, and Part ID.
Parameters
- requestParameters: GetWMVEPMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTMetadataObjectInfo>>
- Defined in apis/MetadataApi.ts:303

getWMVEPsMetadata

getWMVEPsMetadata(requestParameters: GetWMVEPsMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTMetadataObjectListInfoBTMetadataPartInfo>
Retrieve metadata by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetWMVEPsMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTMetadataObjectListInfoBTMetadataPartInfo>
- Defined in apis/MetadataApi.ts:459

getWMVEPsMetadataRaw

getWMVEPsMetadataRaw(requestParameters: GetWMVEPsMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTMetadataObjectListInfoBTMetadataPartInfo>>
Retrieve metadata by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetWMVEPsMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTMetadataObjectListInfoBTMetadataPartInfo>>
- Defined in apis/MetadataApi.ts:393

getWMVEsMetadata

getWMVEsMetadata(requestParameters: GetWMVEsMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTMetadataObjectListInfoBTMetadataElementInfo>
Retrieve metadata by document ID and workspace or version or microversion ID.
Parameters
- requestParameters: GetWMVEsMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTMetadataObjectListInfoBTMetadataElementInfo>
- Defined in apis/MetadataApi.ts:529

getWMVEsMetadataRaw

getWMVEsMetadataRaw(requestParameters: GetWMVEsMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTMetadataObjectListInfoBTMetadataElementInfo>>
Retrieve metadata by document ID and workspace or version or microversion ID.
Parameters
- requestParameters: GetWMVEsMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTMetadataObjectListInfoBTMetadataElementInfo>>
- Defined in apis/MetadataApi.ts:467

getWVMetadata

getWVMetadata(requestParameters: GetWVMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTMetadataObjectInfo>
Retrieve workspace or version metadata by document ID and workspace or version ID.
Parameters
- requestParameters: GetWVMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTMetadataObjectInfo>
- Defined in apis/MetadataApi.ts:599

getWVMetadataRaw

getWVMetadataRaw(requestParameters: GetWVMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTMetadataObjectInfo>>
Retrieve workspace or version metadata by document ID and workspace or version ID.
Parameters
- requestParameters: GetWVMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTMetadataObjectInfo>>
- Defined in apis/MetadataApi.ts:537

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in runtime.ts:116

updateVEOPStandardContentPartMetadata

updateVEOPStandardContentPartMetadata(requestParameters: UpdateVEOPStandardContentPartMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Update metadata of a standard content part in a version by document ID, version ID, tab ID, owner ID, and part ID.
Parameters
- requestParameters: UpdateVEOPStandardContentPartMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/MetadataApi.ts:652

updateVEOPStandardContentPartMetadataRaw

updateVEOPStandardContentPartMetadataRaw(requestParameters: UpdateVEOPStandardContentPartMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Update metadata of a standard content part in a version by document ID, version ID, tab ID, owner ID, and part ID.
Parameters
- requestParameters: UpdateVEOPStandardContentPartMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/MetadataApi.ts:607

updateWVEMetadata

updateWVEMetadata(requestParameters: UpdateWVEMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Update workspace metadata by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: UpdateWVEMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/MetadataApi.ts:713

updateWVEMetadataRaw

updateWVEMetadataRaw(requestParameters: UpdateWVEMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Update workspace metadata by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: UpdateWVEMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/MetadataApi.ts:660

updateWVEPMetadata

updateWVEPMetadata(requestParameters: UpdateWVEPMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Update workspace metadata by document ID, workspace or version or microversion ID, tab ID, and part ID.
Parameters
- requestParameters: UpdateWVEPMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/MetadataApi.ts:794

updateWVEPMetadataRaw

updateWVEPMetadataRaw(requestParameters: UpdateWVEPMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Update workspace metadata by document ID, workspace or version or microversion ID, tab ID, and part ID.
Parameters
- requestParameters: UpdateWVEPMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/MetadataApi.ts:721

updateWVMetadata

updateWVMetadata(requestParameters: UpdateWVMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Update workspace or version metadata by document ID and workspace or version ID.
Parameters
- requestParameters: UpdateWVMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/MetadataApi.ts:847

updateWVMetadataRaw

updateWVMetadataRaw(requestParameters: UpdateWVMetadataRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Update workspace or version metadata by document ID and workspace or version ID.
Parameters
- requestParameters: UpdateWVMetadataRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/MetadataApi.ts:802

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in runtime.ts:100

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in runtime.ts:111

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in runtime.ts:106

Class MetadataApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = DefaultConfig

Returns MetadataApi

Properties

Protected configuration

Methods

getVEOPStandardContentMetadata

Parameters

requestParameters: GetVEOPStandardContentMetadataRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTMetadataObjectInfo>

getVEOPStandardContentMetadataRaw

Parameters

requestParameters: GetVEOPStandardContentMetadataRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTMetadataObjectInfo>>

getWMVEMetadata

Parameters

requestParameters: GetWMVEMetadataRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTMetadataObjectInfo>

getWMVEMetadataRaw

Parameters

requestParameters: GetWMVEMetadataRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTMetadataObjectInfo>>

getWMVEPMetadata

Parameters

requestParameters: GetWMVEPMetadataRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTMetadataObjectInfo>

getWMVEPMetadataRaw

Parameters

requestParameters: GetWMVEPMetadataRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTMetadataObjectInfo>>

getWMVEPsMetadata

Parameters

requestParameters: GetWMVEPsMetadataRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTMetadataObjectListInfoBTMetadataPartInfo>

getWMVEPsMetadataRaw

Parameters

requestParameters: GetWMVEPsMetadataRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTMetadataObjectListInfoBTMetadataPartInfo>>

getWMVEsMetadata

Parameters

requestParameters: GetWMVEsMetadataRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTMetadataObjectListInfoBTMetadataElementInfo>

getWMVEsMetadataRaw

Parameters

requestParameters: GetWMVEsMetadataRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTMetadataObjectListInfoBTMetadataElementInfo>>

getWVMetadata

Parameters

requestParameters: GetWVMetadataRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTMetadataObjectInfo>

getWVMetadataRaw

Parameters

requestParameters: GetWVMetadataRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTMetadataObjectInfo>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<Response>

updateVEOPStandardContentPartMetadata

`Protected` configuration

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Protected` request

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Rest` ...middlewares: Middleware[]

`Rest` ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Rest` ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]