Class TypesAPI

The TypesAPI retrieves information on document types from Veeva

Hierarchy

  • TypesAPI

Constructors

constructor

Properties

restAPI

Methods

getDocumentTypes getRelationshipTypes

Constructors

constructor

  • Class which communicates with Veeva to retrieve metadata information on document types.

    Parameters

    • restAPI: RestAPI

      Rest API instance

    Returns TypesAPI

Properties

Private restAPI

restAPI: RestAPI

Methods

getDocumentTypes

  • Get a list of document types in Veeva

    const service = new VeevaService(credentials)
    await service.document.types.getDocumentTypes()

    Returns

    An array of document types

    Returns Promise<IDocumentType[]>

getRelationshipTypes

  • Retrieve a list of relationship types from Veeva.

    const service = new VeevaService(credentials)
    await service.document.types.getRelationshipTypes('slide__v')

    Returns

    An array of relationships

    Parameters

    • type: string

      The document type to retrieve relationships for

    Returns Promise<IRelationship[]>

Settings

Member Visibility

Theme

Generated using TypeDoc