File

src/api/webApi/classes/executionApi.interface.ts

Index

Methods

Methods

executeAuthenticatedUrl
executeAuthenticatedUrl(url: string)
Parameters :
Name Type Optional
url string No
Returns : Promise<Blob>
executeDistributionFormat
executeDistributionFormat(format: DistributionFormat, params: null | Array, asBlob: boolean)
Parameters :
Name Type Optional
format DistributionFormat No
params null | Array<ParameterValue> No
asBlob boolean No
Returns : Promise<Record | Blob>
executeUrl
executeUrl(url: string)
Parameters :
Name Type Optional
url string No
Returns : Promise<Blob>
getExecuteUrl
getExecuteUrl(format: DistributionFormat, params: null | Array)
Parameters :
Name Type Optional
format DistributionFormat No
params null | Array<ParameterValue> No
Returns : string
getOriginatorUrl
getOriginatorUrl(distribution: DistributionSummary, params: null | Array)

Not for execution, just for reference to the originator (TCS)

Parameters :
Name Type Optional
distribution DistributionSummary No
params null | Array<ParameterValue> No
Returns : Promise<string>
import { DistributionSummary } from '../data/distributionSummary.interface';
import { DistributionFormat } from '../data/distributionFormat.interface';
import { ParameterValue } from '../data/parameterValue.interface';

export interface ExecutionApi {

  executeAuthenticatedUrl(
    url: string,
  ): Promise<Blob>;

  executeUrl(
    url: string,
  ): Promise<Blob>;

  executeDistributionFormat(
    format: DistributionFormat,
    params: null | Array<ParameterValue>,
    asBlob: boolean,
  ): Promise<Record<string, unknown> | Blob>;

  getExecuteUrl(
    format: DistributionFormat,
    params: null | Array<ParameterValue>,
  ): string;


  /**
   * Not for execution, just for reference to the originator (TCS)
   */
  getOriginatorUrl(
    distribution: DistributionSummary,
    params: null | Array<ParameterValue>
  ): Promise<string>;
}

results matching ""

    No results matching ""