Interface IOrganizationsActionBatches

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface IOrganizationsActionBatches

Methods

CreateOrganizationActionBatchAsync(string, ActionBatchCreationRequest, CancellationToken)

Create an action batch

[Post("/organizations/{organizationId}/actionBatches")]
Task<ActionBatch> CreateOrganizationActionBatchAsync(string organizationId, ActionBatchCreationRequest createOrganizationActionBatch, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

createOrganizationActionBatch ActionBatchCreationRequest

Body for creating organization action batch

cancellationToken CancellationToken

Returns

Task<ActionBatch>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationActionBatchAsync(string, string, CancellationToken)

Delete an action batch

[Delete("/organizations/{organizationId}/actionBatches/{actionBatchId}")]
Task DeleteOrganizationActionBatchAsync(string organizationId, string actionBatchId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

actionBatchId string

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationActionBatchAsync(string, string, CancellationToken)

Return an action batch

[Get("/organizations/{organizationId}/actionBatches/{actionBatchId}")]
Task<ActionBatch> GetOrganizationActionBatchAsync(string organizationId, string actionBatchId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

actionBatchId string

The action batch id

cancellationToken CancellationToken

Returns

Task<ActionBatch>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationActionBatchesAsync(string, string?, CancellationToken)

Return the list of action batches in the organization

[Get("/organizations/{organizationId}/actionBatches")]
Task<List<ActionBatch>> GetOrganizationActionBatchesAsync(string organizationId, string? status = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

status string

Filter batches by status. Valid types are pending, completed, and failed.

cancellationToken CancellationToken

Returns

Task<List<ActionBatch>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationActionBatchAsync(string, string, ActionBatchUpdateRequest, CancellationToken)

Update an action batch

[Put("/organizations/{organizationId}/actionBatches/{actionBatchId}")]
Task<ActionBatch> UpdateOrganizationActionBatchAsync(string organizationId, string actionBatchId, ActionBatchUpdateRequest updateOrganizationActionBatch = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

actionBatchId string

The action batch id

updateOrganizationActionBatch ActionBatchUpdateRequest

Body for updating organization action batch

cancellationToken CancellationToken

Returns

Task<ActionBatch>

Exceptions

ApiException

Thrown when fails to make API call