Package com.veeva.vault.sdk.api.webapi

Interface WebApiContext

public interface WebApiContext
Input to a WebApi. Includes the contextual information needed to invoke a WebAPI.

  • Method Details

    • getApiVersion

      String getApiVersion()
      Retrieves the API version of the request. For example, "v24.3".
      Returns:
      the request API version

    • getWebApiRequest

      WebApiRequest getWebApiRequest()
      Retrieves the request that invoked this WebAPI.
      Returns:
      a WebAPI request

    • newWebApiResponseBuilder

      WebApiResponse.Builder newWebApiResponseBuilder()
      Returns a builder to create the response for this WebAPI request.
      Returns:
      a new WebAPI response builder

    • newWebApiFailureResponseBuilder

      WebApiResponse.FailureBuilder newWebApiFailureResponseBuilder()
      Returns a builder to create the failure response for this WebAPI request.
      Returns:
      a new WebAPI failure response builder

    • newWebApiFileResponseDataBuilder

      WebApiFileResponseData.Builder newWebApiFileResponseDataBuilder()
      Returns a builder to create a WebApiFileResponseData.
      Returns:
      a new WebAPI file response builder

    • newWebApiErrorBuilder

      WebApiError.Builder newWebApiErrorBuilder()
      Returns a builder to create a WebApiError.
      Returns:
      a new WebAPI error builder