Copyright | (c) 2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Retrieves a list of inventory items, possibly filtered.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.inventoryItems.list
.
- type InventoryItemsListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("projects" :> (Capture "projectId" (Textual Int64) :> ("inventoryItems" :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" InventoryItemsListSortOrder :> (QueryParam "inPlan" Bool :> (QueryParam "pageToken" Text :> (QueryParam "sortField" InventoryItemsListSortField :> (QueryParams "orderId" (Textual Int64) :> (QueryParams "siteId" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` InventoryItemsListResponse)))))))))))))))
- inventoryItemsList :: Int64 -> Int64 -> InventoryItemsList
- data InventoryItemsList
- iilIds :: Lens' InventoryItemsList [Int64]
- iilProFileId :: Lens' InventoryItemsList Int64
- iilSortOrder :: Lens' InventoryItemsList (Maybe InventoryItemsListSortOrder)
- iilInPlan :: Lens' InventoryItemsList (Maybe Bool)
- iilPageToken :: Lens' InventoryItemsList (Maybe Text)
- iilProjectId :: Lens' InventoryItemsList Int64
- iilSortField :: Lens' InventoryItemsList (Maybe InventoryItemsListSortField)
- iilOrderId :: Lens' InventoryItemsList [Int64]
- iilSiteId :: Lens' InventoryItemsList [Int64]
- iilMaxResults :: Lens' InventoryItemsList (Maybe Int32)
REST Resource
type InventoryItemsListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("projects" :> (Capture "projectId" (Textual Int64) :> ("inventoryItems" :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" InventoryItemsListSortOrder :> (QueryParam "inPlan" Bool :> (QueryParam "pageToken" Text :> (QueryParam "sortField" InventoryItemsListSortField :> (QueryParams "orderId" (Textual Int64) :> (QueryParams "siteId" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` InventoryItemsListResponse))))))))))))))) Source
A resource alias for dfareporting.inventoryItems.list
method which the
InventoryItemsList
request conforms to.
Creating a Request
Creates a value of InventoryItemsList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data InventoryItemsList Source
Retrieves a list of inventory items, possibly filtered.
See: inventoryItemsList
smart constructor.
Request Lenses
iilIds :: Lens' InventoryItemsList [Int64] Source
Select only inventory items with these IDs.
iilProFileId :: Lens' InventoryItemsList Int64 Source
User profile ID associated with this request.
iilSortOrder :: Lens' InventoryItemsList (Maybe InventoryItemsListSortOrder) Source
Order of sorted results, default is ASCENDING.
iilInPlan :: Lens' InventoryItemsList (Maybe Bool) Source
Select only inventory items that are in plan.
iilPageToken :: Lens' InventoryItemsList (Maybe Text) Source
Value of the nextPageToken from the previous result page.
iilProjectId :: Lens' InventoryItemsList Int64 Source
Project ID for order documents.
iilSortField :: Lens' InventoryItemsList (Maybe InventoryItemsListSortField) Source
Field by which to sort the list.
iilOrderId :: Lens' InventoryItemsList [Int64] Source
Select only inventory items that belong to specified orders.
iilSiteId :: Lens' InventoryItemsList [Int64] Source
Select only inventory items that are associated with these sites.
iilMaxResults :: Lens' InventoryItemsList (Maybe Int32) Source
Maximum number of results to return.