Interface DataCredentialsAPI

interface DataCredentialsAPI {
    clearCache: () => void;
    deleteDataCredential: (
        qID: string,
        query: { byCredentialName?: boolean },
        options?: ApiCallOptions,
    ) => Promise<DeleteDataCredentialHttpResponse>;
    filterOrphanedDataCredentials: (
        body: ActionFilterOrphanRequest,
        options?: ApiCallOptions,
    ) => Promise<FilterOrphanedDataCredentialsHttpResponse>;
    getDataCredential: (
        qID: string,
        query: { byCredentialName?: boolean },
        options?: ApiCallOptions,
    ) => Promise<GetDataCredentialHttpResponse>;
    patchDataCredential: (
        qID: string,
        query: { byCredentialName?: boolean },
        body: PatchRequest,
        options?: ApiCallOptions,
    ) => Promise<PatchDataCredentialHttpResponse>;
    updateDataCredential: (
        qID: string,
        query: { byCredentialName?: boolean },
        body: CredentialCreate,
        options?: ApiCallOptions,
    ) => Promise<UpdateDataCredentialHttpResponse>;
}
Index

Properties

clearCache deleteDataCredential filterOrphanedDataCredentials getDataCredential patchDataCredential updateDataCredential

Properties

clearCache: () => void

Clears the cache for data-credentials api requests.

Type declaration

    • (): void

    • Clears the cache for data-credentials api requests.

      Returns void

deleteDataCredential: (
    qID: string,
    query: { byCredentialName?: boolean },
    options?: ApiCallOptions,
) => Promise<DeleteDataCredentialHttpResponse>

Deletes the specified credential by ID (or by name when type=credentialname is set in query)

Type declaration

    • (
          qID: string,
          query: { byCredentialName?: boolean },
          options?: ApiCallOptions,
      ): Promise<DeleteDataCredentialHttpResponse>

    • Deletes the specified credential by ID (or by name when type=credentialname is set in query)

      Parameters

      • qID: string

        Credential ID

      • query: { byCredentialName?: boolean }

        an object with query parameters

        • OptionalbyCredentialName?: boolean

          If set to true, credentialId in the query will be interpreted as credential's name

      • Optionaloptions: ApiCallOptions

      Returns Promise<DeleteDataCredentialHttpResponse>

      deleteDataCredential(
        "027d2703-e745-43ec-8876-a2e6ac341700",
        {
          byCredentialName: false
        }
      )

      DeleteDataCredentialHttpError

deleteDataCredential(
  "027d2703-e745-43ec-8876-a2e6ac341700",
  {
    byCredentialName: false
  }
)

Credential ID

an object with query parameters

DeleteDataCredentialHttpError

filterOrphanedDataCredentials: (
    body: ActionFilterOrphanRequest,
    options?: ApiCallOptions,
) => Promise<FilterOrphanedDataCredentialsHttpResponse>

Gets list of orphan data credentials (i.e. credentials that are not associated to any data connection) filtering on properties defined in request body

Type declaration

Param: body

an object with the body content

FilterOrphanedDataCredentialsHttpError

getDataCredential: (
    qID: string,
    query: { byCredentialName?: boolean },
    options?: ApiCallOptions,
) => Promise<GetDataCredentialHttpResponse>

Gets a credential by ID (or by name when bycredentialname=true is set in query)

Type declaration

    • (
          qID: string,
          query: { byCredentialName?: boolean },
          options?: ApiCallOptions,
      ): Promise<GetDataCredentialHttpResponse>

    • Gets a credential by ID (or by name when bycredentialname=true is set in query)

      Parameters

      • qID: string

        Credential ID

      • query: { byCredentialName?: boolean }

        an object with query parameters

        • OptionalbyCredentialName?: boolean

          If set to true, credentialId in the query will be interpreted as credential's name

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetDataCredentialHttpResponse>

      getDataCredential(
        "027d2703-e745-43ec-8876-a2e6ac341700",
        {
          byCredentialName: false
        }
      )

      GetDataCredentialHttpError

getDataCredential(
  "027d2703-e745-43ec-8876-a2e6ac341700",
  {
    byCredentialName: false
  }
)

Credential ID

an object with query parameters

GetDataCredentialHttpError

patchDataCredential: (
    qID: string,
    query: { byCredentialName?: boolean },
    body: PatchRequest,
    options?: ApiCallOptions,
) => Promise<PatchDataCredentialHttpResponse>

Patches a credential specified by ID (or by name when bycredentialname=true is set in query)

Type declaration

    • (
          qID: string,
          query: { byCredentialName?: boolean },
          body: PatchRequest,
          options?: ApiCallOptions,
      ): Promise<PatchDataCredentialHttpResponse>

    • Patches a credential specified by ID (or by name when bycredentialname=true is set in query)

      Parameters

      • qID: string

        Credential ID

      • query: { byCredentialName?: boolean }

        an object with query parameters

        • OptionalbyCredentialName?: boolean

          If set to true, credentialId in the query will be interpreted as credential's name

      • body: PatchRequest

        an object with the body content

      • Optionaloptions: ApiCallOptions

      Returns Promise<PatchDataCredentialHttpResponse>

      PatchDataCredentialHttpError

Credential ID

an object with query parameters

Param: body

an object with the body content

PatchDataCredentialHttpError

updateDataCredential: (
    qID: string,
    query: { byCredentialName?: boolean },
    body: CredentialCreate,
    options?: ApiCallOptions,
) => Promise<UpdateDataCredentialHttpResponse>

Updates a credential specified by ID (or by name when bycredentialname=true is set in query)

Type declaration

    • (
          qID: string,
          query: { byCredentialName?: boolean },
          body: CredentialCreate,
          options?: ApiCallOptions,
      ): Promise<UpdateDataCredentialHttpResponse>

    • Updates a credential specified by ID (or by name when bycredentialname=true is set in query)

      Parameters

      • qID: string

        Credential ID

      • query: { byCredentialName?: boolean }

        an object with query parameters

        • OptionalbyCredentialName?: boolean

          If set to true, credentialId in the query will be interpreted as credential's name

      • body: CredentialCreate

        an object with the body content

      • Optionaloptions: ApiCallOptions

      Returns Promise<UpdateDataCredentialHttpResponse>

      UpdateDataCredentialHttpError

Credential ID

an object with query parameters

Param: body

an object with the body content

UpdateDataCredentialHttpError

Settings

Member Visibility

On This Page

Properties