Interface ICameraCustomAnalyticsArtifacts

Namespace

Meraki.Api.Interfaces.Products.Camera

Assembly

Meraki.Api.dll

public interface ICameraCustomAnalyticsArtifacts

Methods

CreateOrganizationCameraCustomAnalyticsArtifactAsync(string, CameraCustomAnalyticsArtifactCreateRequest, CancellationToken)

Create custom analytics artifact. Returns an artifact upload URL with expiry time. Upload the artifact file with a put request to the returned upload URL before its expiry.

[Post("/organizations/{organizationId}/camera/customAnalytics/artifacts")]
Task<CameraCustomAnalyticsArtifactCreateResponse> CreateOrganizationCameraCustomAnalyticsArtifactAsync(string serial, CameraCustomAnalyticsArtifactCreateRequest cameraCustomAnalyticsArtifactCreateRequest, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

cameraCustomAnalyticsArtifactCreateRequest CameraCustomAnalyticsArtifactCreateRequest

Body for updating camera custom analytics

cancellationToken CancellationToken

Returns

Task<CameraCustomAnalyticsArtifactCreateResponse>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationCameraCustomAnalyticsArtifactAsync(string, string, CancellationToken)

Delete Custom Analytics Artifact

[Delete("/organizations/{organizationId}/camera/customAnalytics/artifacts/{artifactId}")]
Task DeleteOrganizationCameraCustomAnalyticsArtifactAsync(string organizationId, string artifactId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

artifactId string

The artifact id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationCameraCustomAnalyticsArtifactAsync(string, string, CancellationToken)

Get Custom Analytics Artifact

[Get("/organizations/{organizationId}/camera/customAnalytics/artifacts/{artifactId}")]
Task<CameraCustomAnalyticsArtifact> GetOrganizationCameraCustomAnalyticsArtifactAsync(string organizationId, string artifactId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization Id

artifactId string

The artifact Id

cancellationToken CancellationToken

Returns

Task<CameraCustomAnalyticsArtifact>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationCameraCustomAnalyticsArtifactsAsync(string, CancellationToken)

List Custom Analytics Artifacts

[Get("/organizations/{organizationId}/camera/customAnalytics/artifacts")]
Task<List<CameraCustomAnalyticsArtifact>> GetOrganizationCameraCustomAnalyticsArtifactsAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization Id

cancellationToken CancellationToken

Returns

Task<List<CameraCustomAnalyticsArtifact>>

Exceptions

ApiException

Thrown when fails to make API call