Namespace LookupApi

Index

Interfaces

Functions

Functions

getPlatformAPIList

getPlatformAPIList(builder: RequestBuilder): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/lookup-api.ts:111
Return the list of the HERE APIs. This response is valid for the time specified by 'Cache-Control' header.

summary
Return the list of the HERE APIs.

Parameters
- builder: RequestBuilder
Returns Promise<Response>

getResourceAPIList

getResourceAPIList(builder: RequestBuilder, params: { hrn: string; region?: string }): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/lookup-api.ts:169
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: { hrn: string; region?: string }
  - hrn: string
  - Optional region?: string
Returns Promise<Response>

platformAPI

platformAPI(builder: RequestBuilder, params: { api: string; version: string }): Promise<API[] | ApiNotFoundError>

- Defined in @here/olp-sdk-dataservice-api/lib/lookup-api.ts:87
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: { api: string; version: string }
  - api: string
  - version: string
Returns Promise<API[] | ApiNotFoundError>

resourceAPI

resourceAPI(builder: RequestBuilder, params: { api: string; hrn: string; region?: string; version: string }): Promise<API[] | ApiNotFoundError>

- Defined in @here/olp-sdk-dataservice-api/lib/lookup-api.ts:141
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: { api: string; hrn: string; region?: string; version: string }
  - api: string
  - hrn: string
  - Optional region?: string
  - version: string
Returns Promise<API[] | ApiNotFoundError>

Generated using TypeDoc