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

Annotation Interface WebApiInfo

@Target(TYPE) @Retention(RUNTIME) public @interface WebApiInfo
Indicates a class is a WebApi. Describes the WebAPI.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    apiGroup
    Retrieves the API group allowed to access this WebAPI.
    String
    endpointName
    Retrieves the name of a WebAPI endpoint.
    String
    minimumVersion
    Retrieves the minimum API version allowed to use this WebAPI.

  • Element Details

    • endpointName

      String endpointName
      Retrieves the name of a WebAPI endpoint.
      Returns:
      the name of this WebAPI endpoint

    • minimumVersion

      String minimumVersion
      Retrieves the minimum API version allowed to use this WebAPI. For example, "v24.3".
      Returns:
      the minimum API version

    • apiGroup

      String apiGroup
      Retrieves the API group allowed to access this WebAPI.
      Returns:
      the API group that may access this WebAPI