Getting Started

Accessing the API

DEVICES

Cameras
Bridges
PTZ
Speakers
Device I/O
Switches
Multi Cameras
Available Devices
- /availableDevicesget

MEDIA

Media
Feeds
- /feedsget
Exports
- /exportspost
- /exports/{jobId}:copypost
Jobs
Files
Downloads

EVENTS

Events
Event Types
- /eventTypesget
Event Metrics
- /eventMetricsget
Event Subscriptions
Alerts
- /alertsget
- /alerts/{id}get
Notifications

AUTOMATIONS

Event Alert Rules
Action Rules
Actions

VIDEO SEARCH

Video Analytics Events

VEHICLE SURVEILLANCE PACKAGE

LPR Events
LPR Rules
LPR Vehicle Lists

USER & ACCOUNTS

Users
Accounts
- /accountsget
- /accounts/{id}/credentials/{credentialId}delete
Roles
Auditlog
- /auditLogsget
Resource Grants
Editions
- /editionsget
- /editions/{id}get

RESELLERS ACCOUNT SWITCHING

Tokens
- /authorizationTokenspost

ACCOUNT SETTINGS

SSO
- /accounts/self/ssoAuthSettingsget
- /accounts/self/ssoAuthSettingspatch
Client Settings
- /clientSettingsget

GROUPING

Layouts
Tags
- /tagsget
Locations
Floors
Floor Plans

SYSTEM

Applications
Application OAuth Clients

/jobs/{jobId}

get https://{BaseUrl}/api/v3.0/jobs/{jobId}

Get a single Job

Path Params

jobId

uuid

required

Responses

Response body

object

code

integer

required

HTTP code defined in EEN Standard Code Values

status

string

required

A string enum describing the code

cancelled unknown invalidArgument deadlineExceeded notFound conflict permissionDenied resourceExhausted failedPrecondition aborted outOfRange unimplemented internal unavailable dataLoss unauthenticated mediaTypeNotSupported acceptNotSupported methodNotSupported tooManyRequests

message

string

required

Developer friendly human readable error message in English

details

array of objects

required

An array of extensible objects that define error information

details*

Response body

object

code

integer

required

HTTP code defined in EEN Standard Code Values

status

string

required

A string enum describing the code

message

string

required

Developer friendly human readable error message in English

details

array of objects

required

An array of extensible objects that define error information

details*

Response body

object

code

integer

required

HTTP code defined in EEN Standard Code Values

status

string

required

A string enum describing the code

message

string

required

Developer friendly human readable error message in English

details

array of objects

required

An array of extensible objects that define error information

details*

Response body

object

code

integer

required

HTTP code defined in EEN Standard Code Values

status

string

required

A string enum describing the code

message

string

required

Developer friendly human readable error message in English

details

array of objects

required

An array of extensible objects that define error information

details*

Response body

object

code

integer

required

HTTP code defined in EEN Standard Code Values

status

string

required

A string enum describing the code

message

string

required

Developer friendly human readable error message in English

details

array of objects

required

An array of extensible objects that define error information

details*

Updated 5 months ago

/jobs

/jobs/{jobId}

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.cxxx.eagleeyenetworks.com/api/v3.0/jobs/jobId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 5 months ago

/jobs

/jobs/{jobId}

Getting Started
Accessing the API

DEVICES
Cameras
/cameras/{cameraId}/io/ports/{portId}patch
/cameras/{cameraId}/io/ports/{portId}get
/cameras/{cameraId}/settingspatch
/cameras/{cameraId}/io/portsget
/cameras/{cameraId}/settingsget
/cameras/{cameraId}:swappatch
/cameras/{cameraId}/metricsget
/cameras/{cameraId}/tunneldelete
/cameras/{cameraId}/tunnelput
/cameras/{cameraId}patch
/cameras/{cameraId}delete
/cameras/{cameraId}get
/cameras:bulkUpdatepost
/cameraspost
/camerasget
Bridges
/bridges/{id}/settings/patch
/bridges/{id}/settings/get
/bridges/{bridgeId}/actionspost
/devices/{deviceId}/io/ports/{portId}patch
/bridges/{bridgeId}:swappatch
/bridges/{bridgeId}/metricsget
/bridges/{bridgeId}delete
/bridges/{bridgeId}get
/bridges/{bridgeId}patch
/bridges:bulkUpdatepost
/bridgespost
/bridgesget
Bridges
PTZ
/cameras/{cameraId}/ptz/settingspatch
/cameras/{cameraId}/ptz/settingsget
/cameras/{cameraId}/ptz/positionput
/cameras/{cameraId}/ptz/positionget
Speakers
/speakers/{speakerId}/settingspatch
/speakers/{speakerId}/settingsget
/speakers/{speakerId}delete
/speakers/{speakerId}patch
/speakers/{speakerId}get
/speakerspost
/speakersget
Device I/O
/devices/{deviceId}/io/ports/{portId}/recordingActions/{cameraId}patch
/devices/{deviceId}/io/ports/{portId}/recordingActions/{cameraId}get
/devices/{deviceId}/io/ports/{portId}/recordingActionsget
/devices/{deviceId}/io/ports/{portId}get
/devices/{deviceId}/io/portsget
Switches
/switches/{switchId}/ports/all/actionspost
/switches/{switchId}/ports/{portId}/actionspost
/switches/{switchId}patch
/switches/{switchId}get
/switchesget
Multi Cameras
/multiCameras/{multiCameraId}/channelsget
/multiCameras/{multiCameraId}patch
/multiCameras/{multiCameraId}delete
/multiCameras/{multiCameraId}get
/multiCameraspost
/multiCamerasget
Available Devices
/availableDevicesget

MEDIA
Media
/media/sessionget
/media/recordedImage.jpeg:listFieldValuesget
/media/liveImage.jpegget
/media/recordedImage.jpegget
/mediaget
Feeds
/feedsget
Exports
/exports/{jobId}:copypost
/exportspost
Jobs
/jobs/{jobId}delete
/jobs/{jobId}get
/jobsget
Files
/deletedFiles/{id}:restorepost
/deletedFiles/alldelete
/deletedFiles/{id}delete
/deletedFiles/{id}get
/deletedFilesget
/files/{id}:downloadget
/files/{id}delete
/files/{id}patch
/files/{id}get
/filespost
/filesget
Downloads
/downloads/{id}:downloadget
/downloads/{id}patch
/downloads/{id}get
/downloadsget

EVENTS
Events
/events:listFieldValuesget
/eventspost
/eventsget
Event Types
/eventTypesget
Event Metrics
/eventMetricsget
Event Subscriptions
/eventSubscriptions/{eventSubscriptionId}/filters/{filterId}delete
/eventSubscriptions/{eventSubscriptionId}/filters/{filterId}get
/eventSubscriptions/{eventSubscriptionId}/filterspost
/eventSubscriptions/{eventSubscriptionId}/filtersget
/eventSubscriptions/{eventSubscriptionId}delete
/eventSubscriptions/{eventSubscriptionId}get
/eventSubscriptionspost
/eventSubscriptionsget
Alerts
/alerts/{id}get
/alertsget
Notifications
/notifications/{id}patch
/notifications/{id}get
/notificationsget

AUTOMATIONS
Event Alert Rules
/eventAlertConditionRules/{id}delete
/eventAlertConditionRules/{id}patch
/eventAlertConditionRules/{id}get
/eventAlertConditionRules:listFieldValuesget
/eventAlertConditionRulespost
/eventAlertConditionRulesget
Action Rules
/alertActionRules/{actionRuleId}delete
/alertActionRules/{actionRuleId}patch
/alertActionRules/{actionRuleId}get
/alertActionRulespost
/alertActionRulesget
Actions
/alertActions/{actionId}delete
/alertActions/{actionId}patch
/alertActions/{actionId}get
/alertActionspost
/alertActionsget

VIDEO SEARCH
Video Analytics Events
/videoAnalyticEvents/{id}get
/videoAnalyticEvents:listObjectValuesget
/videoAnalyticEvents:listFieldValuespost
/videoAnalyticEvents:deepSearchGroupByTimepost
/videoAnalyticEvents:deepSearchGroupByResourcepost
/videoAnalyticEvents:deepSearchpost
/videoAnalyticEvents:parsepost

VEHICLE SURVEILLANCE PACKAGE
LPR Events
/lprEvents:listFieldValuesget
/lprEvents:summaryget
/lprEvents/{id}get
/lprEventsget
LPR Rules
/lprAlertConditionRules/{id}delete
/lprAlertConditionRules/{id}patch
/lprAlertConditionRules/{id}get
/lprAlertConditionRules:listFieldValuesget
/lprAlertConditionRulesget
/lprAlertConditionRulespost
LPR Vehicle Lists
/lprVehicleLists:searchget
/lprVehicleLists/{id}/vehicles/{recordId}delete
/lprVehicleLists/{id}/vehicles/{recordId}patch
/lprVehicleLists/{id}/vehicles/{recordId}get
/lprVehicleLists/{id}/vehicles:bulkCreatepost
/lprVehicleLists/{id}/vehiclespost
/lprVehicleLists/{id}/vehiclesget
/lprVehicleLists/{id}delete
/lprVehicleLists/{id}patch
/lprVehicleLists/{id}get
/lprVehicleLists:listFieldValuesget
/lprVehicleLists:listFieldsget
/lprVehicleListspost
/lprVehicleListsget

USER & ACCOUNTS
Users
/users/self/trustedClients/{trustedClientId}delete
/users/self/trustedClientsget
/users/selfpatch
/users/selfget
/users/{userId}patch
/users/{userId}delete
/users/{userId}get
/userspost
/usersget
Accounts
/accounts/{id}/credentials/{credentialId}delete
/accountsget
Roles
/roleAssignments:bulkdeletepost
/roleAssignments:bulkcreatepost
/roleAssignmentsget
/roles/{roleId}patch
/roles/{roleId}get
/roles/{roleId}delete
/rolespost
/rolesget
Auditlog
/auditLogsget
Resource Grants
/resourceGrants:bulkDeletepost
/resourceGrants:bulkCreatepost
/resourceGrantsget
Editions
/editions/{id}get
/editionsget

RESELLERS ACCOUNT SWITCHING
Tokens
/authorizationTokenspost

ACCOUNT SETTINGS
SSO
/accounts/self/ssoAuthSettingspatch
/accounts/self/ssoAuthSettingsget
Client Settings
/clientSettingsget

GROUPING
Layouts
/layouts/{layoutId}patch
/layouts/{layoutId}get
/layouts/{layoutId}delete
/layoutspost
/layoutsget
Tags
/tagsget
Locations
/locations/{id}/locationsget
/locations/{id}delete
/locations/{id}patch
/locations/{id}get
/locationspost
/locationsget
Floors
/locations/{locationId}/floors/{id}.{type}get
/locations/{locationId}/floors/{id}delete
/locations/{locationId}/floors/{id}patch
/locations/{locationId}/floors/{id}get
/locations/{locationId}/floorspost
/locations/{locationId}/floorsget
Floor Plans
/locations/{locationId}/floors/{id}/plans/{planId}delete
/locations/{locationId}/floors/{id}/planspost
/locations/{locationId}/floors/{id}/plansget

SYSTEM
Applications
/timeZonesget
/languagesget
/applications/{applicationId}delete
/applications/{applicationId}patch
/applications/{applicationId}get
/applicationspost
/applicationsget
Application OAuth Clients
/applications/{applicationId}/oauthClients/{clientId}delete
/applications/{applicationId}/oauthClients/{clientId}patch
/applications/{applicationId}/oauthClients/{clientId}get
/applications/{applicationId}/oauthClientspost
/applications/{applicationId}/oauthClientsget

200Get a single Job

400The supplied object is invalid. Error detail will contain the validation error.

401You are not authenticated. Please authenticate and try again.

403You have no permission to access the specified resource.

404Referenced resource could not be found.

500Something went wrong in the server. Please try again.