Retrieve a AEMP Poller Configuration.

get https://qa.connect.calamp.com/connect/services/aemppollerconfigurator/{id}

Returns the AEMP Poller Configuration or null if no AEMP Poller Configuration for the given Id was found.

Responses

Response body

object

_self

object

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

Relation to the resource represented by the Link, within the context of the containing resource. While a Link represents a specific resource in the system, the 'rel' property defines the type of the association between the containing resource and the linked resource.Except for the 'self', 'first', 'last', 'next', 'prev' relations, generally it is the type of the resource at the other end of the association. E.g. 'asset', 'device', 'pegBehavior, 'role', 'primary-operator', etc.

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

name

string

The AEMP Poller Configurator Name. Max Length = 32 characters

int64

Required for PUT requests with resource object in the request body. Forbidden for POST requests with resource object in the request body. Will result in an HTTP 400 - Bad Request response.

password

string

required

Password to access OEMs URL. Max Length = 64 characters

additionalUrlParams

string

Additional URL parameters of AEMP poller configurator. Max Length = 64 characters

pollingInterval

int32

required

Polling interval of AEMP poller configurator in Hours

description

string

The AEMP Poller Configurator Description. Max Length = 255 characters

url

string

required

OEMs URL to poll AEMP data.

username

string

required

Username to access OEMs URL. Max Length = 64 characters

status

string

required

Defaults to 'Enabled'

Enabled Disabled Suspended Deleted Pending_Delete

createdOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only.

deletionDate

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Last time this Configurator was deleted. Maintained by system based on status change. Read-only

lastRunStatus

string

Last run status of AEMP poller configurator. Max Length = 16 characters

lastRunTime

date

yyyy-MM-dd'T'HH:mm:ss.SSSZLast run polling time of AEMP poller configurator

nextPollTime

date

yyyy-MM-dd'T'HH:mm:ss.SSSZNext polling time of AEMP poller configurator

activationDate

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Last time this Configurator was activated. Maintained by system based on status change. Read-only

account

object

required

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

lastModifiedOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the server. Read-only.

version

int64

Defaults to 0

Read-only. Managed by the service. Required for PUT, ignored for POST.

400

Invalid request.

403

Not authorized for this operation.

404

Not found.

417

Link expansion could not be completed.

500

Server error

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://qa.connect.calamp.com/connect/services/aemppollerconfigurator/id \
3
     --header 'accept: */*'

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

*/*

200successful operation