/
Drivers

Drivers

The Drivers end point allows you to retrieve the name and IDs of drivers, update drivers, create drivers, and delete drivers.   This endpoint performs the same function as the Protocols endpoint.

URI Definition

Method        

URI and Fields

GET




/iap/drivers

Returns a set of drivers that match the search criteria.  

Body Parameters

Parameter                   Description                                                                                                                                                  
systemName 

Specifies the driver.

userNameSpecifies the name of the driver.
idID of the driver.

Query Parameters

You can specify a query parameter appended to the end of your URI, preceded with a "?" character. 

Parameter        Type           Description                                                                                                                                  
sortOrderStringSpecifies the sort order.  Either ascending or descending (asc or desc).
Default is asc.
sortByStringSpecifies the name of a parameter.  Either:  typeName, type, protocol, or xifName.
Default is typeName.
pgIntegerSpecifies the page number (1-0x7fffffff).
Default is null.
szIntegerSpecifies the page size (1-0x7fffffff).

Default is null.

Syntax Example

/iap/drivers?sortOrder={asc/desc}&sortBy={field_name}&pg={page_number}&sz={page_siz