Interface IOrganizationsInventoryDevices

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

I Organizations Inventory Devices

public interface IOrganizationsInventoryDevices

Extension Methods

IOrganizationsInventoryDevicesExtensions.GetOrganizationInventoryDevicesAllAsync(IOrganizationsInventoryDevices, string, string?, string?, List<string>?, List<string>?, List<string>?, List<string>?, List<string>?, List<string>?, TagsFilterType?, List<ProductType>?, CancellationToken)

Methods

ClaimIntoOrganizationInventoryAsync(string, OrganizationInventoryClaimRequest, CancellationToken)

Claim a list of devices, licenses, and/or orders into an organization

[Post("/organizations/{organizationId}/inventory/claim")]
Task<OrganizationInventoryClaimResponse> ClaimIntoOrganizationInventoryAsync(string organizationId, OrganizationInventoryClaimRequest organizationInventoryClaimRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

organizationInventoryClaimRequest OrganizationInventoryClaimRequest

Body for making an inventory claim request

cancellationToken CancellationToken

Returns

Task<OrganizationInventoryClaimResponse>

Exceptions

ApiException

Thrown when fails to make API call

CreateOrganizationInventoryDevicesSwapsBulkAsync(string, OrganizationInventorySwapCreateRequest, CancellationToken)

Swap the devices identified by devices.old with a devices.new, then perform the :afterAction on the devices.old.

[Post("/organizations/{organizationId}/inventory/devices/swaps/bulk")]
Task<OrganizationInventorySwapResponse> CreateOrganizationInventoryDevicesSwapsBulkAsync(string organizationId, OrganizationInventorySwapCreateRequest request, CancellationToken cancellationToken = default)

Parameters

organizationId string

request OrganizationInventorySwapCreateRequest

cancellationToken CancellationToken

Returns

Task<OrganizationInventorySwapResponse>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizaitonInventoryDevicesSwapsBulkAsync(string, string, CancellationToken)

List of device swaps for a given request ID ({id}).

[Get("/organizations/{organizationId}/inventory/devices/swaps/bulk/{id}")]
Task<OrganizationInventorySwapResponse> GetOrganizaitonInventoryDevicesSwapsBulkAsync(string organizationId, string id, CancellationToken cancellationToken = default)

Parameters

organizationId string

id string

cancellationToken CancellationToken

Returns

Task<OrganizationInventorySwapResponse>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationInventoryDeviceAsync(string, string, CancellationToken)

Return the device inventory for an organization

[Get("/organizations/{organizationId}/inventory/devices/{serial}")]
Task<InventoryDevice> GetOrganizationInventoryDeviceAsync(string organizationId, string serial, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

serial string

The serial number

cancellationToken CancellationToken

Returns

Task<InventoryDevice>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationInventoryDevicesAsync(string, int?, string?, string?, string?, string?, List<string>?, List<string>?, List<string>?, List<string>?, List<string>?, List<string>?, TagsFilterType?, List<ProductType>?, CancellationToken)

Return the device inventory for an organization

[Get("/organizations/{organizationId}/inventory/devices")]
Task<List<InventoryDevice>> GetOrganizationInventoryDevicesAsync(string organizationId, int? perPage = 1000, string? startingAfter = null, string? endingBefore = null, string? usedState = null, string? search = null, List<string>? macs = null, List<string>? networkIds = null, List<string>? serials = null, List<string>? models = null, List<string>? orderNumbers = null, List<string>? tags = null, TagsFilterType? tagsFilterType = null, List<ProductType>? productTypes = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

perPage int?

The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.

startingAfter string

A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

endingBefore string

A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

usedState string

Filter results by used or unused inventory. Accepted values are "used" or "unused".

search string

Search for devices in inventory based on serial number, mac address, or model.

macs List<string>

Search for devices in inventory based on mac addresses.

networkIds List<string>

Search for devices in inventory based on network ids.

serials List<string>

Search for devices in inventory based on serials.

models List<string>

Search for devices in inventory based on model.

orderNumbers List<string>

tags List<string>

An optional parameter to filter devices by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).

tagsFilterType TagsFilterType?

An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return devices which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.

productTypes List<ProductType>

Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.

cancellationToken CancellationToken

Returns

Task<List<InventoryDevice>>

Exceptions

ApiException

Thrown when fails to make API call

ReleaseFromOrganizationInventoryAsync(string, OrganizationInventoryReleaseRequest, CancellationToken)

Release a list of claimed devices from an organization

[Post("/organizations/{organizationId}/inventory/release")]
Task<OrganizationInventoryReleaseResponse> ReleaseFromOrganizationInventoryAsync(string organizationId, OrganizationInventoryReleaseRequest organizationInventoryReleaseRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

organizationInventoryReleaseRequest OrganizationInventoryReleaseRequest

Body for making an inventory release request

cancellationToken CancellationToken

Returns

Task<OrganizationInventoryReleaseResponse>

Exceptions

ApiException

Thrown when fails to make API call