Class ClobApi

Hierarchy (view full)

Constructors

constructor

Properties

configuration

Methods

deleteClobsWithClobId deleteClobsWithClobIdRaw getClobs getClobsRaw getClobsWithClobId getClobsWithClobIdRaw isJsonMime patchClobsWithClobId patchClobsWithClobIdRaw postClobs postClobsRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

Properties

Protected configuration

configuration: Configuration = DefaultConfig

Methods

deleteClobsWithClobId

  • deleteClobsWithClobId(requestParameters, initOverrides?): Promise<void>

  • Delete clob Delete cwmsData clobs with clobId

    Parameters

    Returns Promise<void>

deleteClobsWithClobIdRaw

getClobs

  • getClobs(requestParameters?, initOverrides?): Promise<Clobs>

  • Get cwmsData clobs

    Parameters

    Returns Promise<Clobs>

getClobsRaw

getClobsWithClobId

  • getClobsWithClobId(requestParameters, initOverrides?): Promise<Clob>

  • Get a single clob. If the accept header is set to text/plain, the raw value is returned as the response body. Responses to text/plain requests are streamed and support the Range header. When the accept header is set to application/json;version=2 the clob will be returned as a serialized Clob object with fields for office-id, id, description and value. Get cwmsData clobs with clobId

    Parameters

    Returns Promise<Clob>

getClobsWithClobIdRaw

  • getClobsWithClobIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<Clob>>

  • Get a single clob. If the accept header is set to text/plain, the raw value is returned as the response body. Responses to text/plain requests are streamed and support the Range header. When the accept header is set to application/json;version=2 the clob will be returned as a serialized Clob object with fields for office-id, id, description and value. Get cwmsData clobs with clobId

    Parameters

    Returns Promise<ApiResponse<Clob>>

Protected isJsonMime

  • isJsonMime(mime): boolean

  • Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json

    Parameters

    • mime: string

      MIME (Multipurpose Internet Mail Extensions)

    Returns boolean

    True if the given MIME is JSON, false otherwise.

patchClobsWithClobId

  • patchClobsWithClobId(requestParameters, initOverrides?): Promise<void>

  • Update clob Patch cwmsData clobs with clobId

    Parameters

    Returns Promise<void>

patchClobsWithClobIdRaw

postClobs

  • postClobs(requestParameters, initOverrides?): Promise<void>

  • Create new Clob Post cwmsData clobs

    Parameters

    Returns Promise<void>

postClobsRaw

Protected request

  • request(context, initOverrides?): Promise<Response>

  • Parameters

    Returns Promise<Response>

withMiddleware

withPostMiddleware

  • withPostMiddleware<T>(this, ...postMiddlewares): T

  • Type Parameters

    Parameters

    • this: T
    • Rest ...postMiddlewares: ((context) => Promise<void | Response>)[]

    Returns T

withPreMiddleware

  • withPreMiddleware<T>(this, ...preMiddlewares): T

  • Type Parameters

    Parameters

    • this: T
    • Rest ...preMiddlewares: ((context) => Promise<void | FetchParams>)[]

    Returns T

Settings

Member Visibility

Theme

On This Page

constructorconfigurationdeleteClobsWithClobIddeleteClobsWithClobIdRawgetClobsgetClobsRawgetClobsWithClobIdgetClobsWithClobIdRawisJsonMimepatchClobsWithClobIdpatchClobsWithClobIdRawpostClobspostClobsRawrequestwithMiddlewarewithPostMiddlewarewithPreMiddleware