Retrieves a resource list by device ids or esns list, resource type, and account id.

get https://qa.connect.calamp.com/connect/services/deviceresources/resources/{deviceIdsOrEsns}/{resourceType}/{accountId}

Returns the resource list or null if no resources for the given parameters was found.

time	status	user agent
Retrieving recent requests…

Loading…

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

required

Name of the resource. Maxlength:128 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.

type

string

required

Defaults to 'Firmware'. Maxlength:32

Firmware Configuration BootLoader RadioFirmware Script ODPApplication PEGScript JPOD1Firmware JPOD1Config JPOD2Firmware JPOD2Config VPOD2FirmwareDatabase

path

string

required

If remoteHosted == false, it should contain the file name and its extension. Example: 'filename.xml'. Maxlength:192

file

object

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

password

string

The password for secure download protocols. Maxlength:44 characters

downloadProtocol

string

Defaults to 'HTTP'. Maxlength:32 characters

UDP HTTP FTP HTTPS

availableToSubaccounts

boolean

required

Indicates if this resource is available or not to subaccounts. Defaults to false.

true

deviceTypeCode

string

required

Defaults to 'LMU'

LMU JPOD OBDII Reserved Router TrainRadio Viper Fusion Vanguard3000 Vanguard5000 ViperRadio ViperBaseStationController RMU PTC TTU GPR Unknown

description

string

Description of the resource. Max Length = 255 characters

server

string

The server of the resource. Maxlength:128 characters

username

string

The username for secure download protocols. Maxlength:44 characters

status

string

Enabled Disabled Suspended Deleted Pending_Delete

appId

int64

The application id for devices managed by PULS.

mimeType

string

MIME type of the resource. Maxlength:128 characters

baseResource

object

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

remoteHosted

boolean

required

Indicates if this file is hosted on a third party server. Defaults to false.

true

retiredOn

date

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

deviceTypes

array of objects

required

Set of deviceType Links that this Resource owns to. Maxlength:32 characters

deviceTypes*

object

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

fileDetails

object

Map with (key, value) data of the attributes read from Base64 string decoded file that this Resource owns to.

Has additional fields

checksum

string

The checksum of the resource. Maxlength:32 characters

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 Device was deleted. Maintained by system based on status change. Read-only

scriptVersion

int64

The script version for devices managed by PULS.

configVersion

int64

The config version for devices managed by PULS.

activationDate

date

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

firmwareVersion

string

The firmware version for devices managed by PULS. Maxlength:20 characters

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

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

Resources not found.

500

Server error

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://qa.connect.calamp.com/connect/services/deviceresources/resources/deviceIdsOrEsns/resourceType/accountId \
3
     --header 'accept: */*'

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

*/*

200successful operation