Class PicklistAPI

The PicklistAPI retreves picklists and their values from Veeva.

Hierarchy

PicklistAPI

Index

Constructors

Properties

Methods

get getPicklistValues

Constructors

constructor

new PicklistAPI(restAPI: RestAPI): PicklistAPI
Parameters
- restAPI: RestAPI
Returns PicklistAPI
- Defined in picklist/PicklistAPI.ts:12

Properties

`Private` restApi

restApi: RestAPI

Methods

get

get(): Promise<IPicklist[]>
Get a list of all picklists within a veeva environment
```
const service = new VeevaService(credentials)
await service.picklist.get()
```
Returns
An array of all picklists in Veeva
Returns Promise<IPicklist[]>
- Defined in picklist/PicklistAPI.ts:26

getPicklistValues

getPicklistValues(picklistName: string): Promise<IPicklistValue[]>
Get a list of pickist values
```
// Get all language__v items
const service = new VeevaService(credentials)
await service.picklist.getPicklistValues('language__v')
```
Returns
An array of labels and values from the picklist
Parameters
- picklistName: string
  
  The name of the picklist to retreive
Returns Promise<IPicklistValue[]>
- Defined in picklist/PicklistAPI.ts:42

Generated using TypeDoc