GuidesChangelogTypeScript API ReferencePython v2 API Reference

LookupApi

Index

Interfaces

Functions

Functions

getPlatformAPIList

getResourceAPIList

  • getResourceAPIList(builder: RequestBuilder, params: {</span>hrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>region<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<Response>

  • Return the list of APIs for a given resource identified by hrn. This response is valid for the time specified by 'Cache-Control' header.

    summary
    Return the list of APIs for a given resource.

    Parameters

    • builder: RequestBuilder
    • params: {</span>hrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>region<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}
      • hrn: string
      • Optional region?: string

    Returns Promise<Response>

platformAPI

  • platformAPI(builder: RequestBuilder, params: {</span>api<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>version<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<API[] | ApiNotFoundError>

  • Return details of a single platform API. This response is valid for the time specified by 'Cache-Control' header.

    summary
    Return details of a single platform API.

    Parameters

    • builder: RequestBuilder
    • params: {</span>api<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>version<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}
      • api: string
      • version: string

    Returns Promise<API[] | ApiNotFoundError>

resourceAPI

  • resourceAPI(builder: RequestBuilder, params: {</span>api<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>hrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>region<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>version<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}): Promise<API[] | ApiNotFoundError>

  • Return details of a single API for a given resource identified by hrn, api and version. This response is valid for the time specified by 'Cache-Control' header.

    summary
    Return details of a single API for a given resource.

    Parameters

    • builder: RequestBuilder
    • params: {</span>api<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>hrn<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>region<span class="typedoc-tsd-signature-symbol">?: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">; </span>version<span class="typedoc-tsd-signature-symbol">: </span><span class="typedoc-tsd-signature-type">string</span><span class="typedoc-tsd-signature-symbol">}
      • api: string
      • hrn: string
      • Optional region?: string
      • version: string

    Returns Promise<API[] | ApiNotFoundError>

olp- sdk- dataservice- api

On this page