Class ProviderService

constructor

• new ProviderService(httpRequest): ActivityApi.ProviderService

• Parameters

  • httpRequest: ActivityApi.BaseHttpRequest

  Returns ActivityApi.ProviderService

Readonly httpRequest

collectActivityEvents

• collectActivityEvents(appSessionId?, afterTimestamp?, timeout?, maxEvents?): ActivityApi.CancelablePromise<{
      activityId: string;
      agreementId: string;
      eventDate: string;
      eventType: string;
  }[]>

• Fetch Requestor command events.

  Parameters

  • Optional appSessionId: string

    A correlation/session identifier used for querying events related to an action where this appSessionId has been specified
  • Optional afterTimestamp: string

    Apply only to records created later than the specified timestamp
  • timeout: number = 5

    Timeout used in long-polling calls (in seconds). How many seconds server should wait for response containing new events (0.0 means it should return immediately if there are no events)
  • maxEvents: number = 10

    Maximum number of events that server should return at once.

  Returns ActivityApi.CancelablePromise<{
      activityId: string;
      agreementId: string;
      eventDate: string;
      eventType: string;
  }[]>

  any OK

  Throws

  ApiError

getActivityAgreement

• getActivityAgreement(activityId): ActivityApi.CancelablePromise<string>

• Returns agreement_id corresponding to the activity 'This call shall return id of the agreement that lead to the creation of this activity'

  Parameters

  • activityId: string

  Returns ActivityApi.CancelablePromise<string>

  string Agreement.

  Throws

  ApiError

getActivityState

• getActivityState(activityId): ActivityApi.CancelablePromise<{
      errorMessage?: string;
      reason?: string;
      state: (null | "Terminated" | "New" | "Initialized" | "Deployed" | "Ready" | "Unresponsive")[];
  }>

• Get state of specified Activity.

  Parameters

  • activityId: string

  Returns ActivityApi.CancelablePromise<{
      errorMessage?: string;
      reason?: string;
      state: (null | "Terminated" | "New" | "Initialized" | "Deployed" | "Ready" | "Unresponsive")[];
  }>

  any Success

  Throws

  ApiError

getActivityUsage

• getActivityUsage(activityId): ActivityApi.CancelablePromise<{
      currentUsage?: number[];
      timestamp: number;
  }>

• Get usage of specified Activity.

  Parameters

  • activityId: string

  Returns ActivityApi.CancelablePromise<{
      currentUsage?: number[];
      timestamp: number;
  }>

  any Success

  Throws

  ApiError

setActivityState

• setActivityState(activityId, requestBody): ActivityApi.CancelablePromise<any>

• Set state of specified Activity.

  Parameters

  • activityId: string
  • requestBody: {
        errorMessage?: string;
        reason?: string;
        state: (null | "Terminated" | "New" | "Initialized" | "Deployed" | "Ready" | "Unresponsive")[];
    }

    • Optional errorMessage?: string

      If error caused state change - error message shall be provided.

    • Optional reason?: string

      Reason for Activity termination (specified when Activity in Terminated state).

    • state: (null | "Terminated" | "New" | "Initialized" | "Deployed" | "Ready" | "Unresponsive")[]

      State pair tuple (CurrentState, NextState). NextState is equal to null if there is no pending transition between states.

  Returns ActivityApi.CancelablePromise<any>

  any Success

  Throws

  ApiError