Retreives the PegBehavior for the current user.

get https://qa.connect.calamp.com/connect/services/pegbehaviors/name/{name}

Deleted PegBehavior won't be fetched.

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

groups

array of objects

Links to Groups to which the resource belongs.

groups

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

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.

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

name

string

required

Name of the peg behavior. Maxlength:32 characters

description

string

Description of the peg behavior. Maxlength:255 characters

pegEvents

array of objects

pegEvents

object

_self

object

Represents a resource in the system

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.

eventCode

int32

required

Event code of the pegEvent

pegLabel

object

required

Represents a resource in the system

pegBehavior

object

Represents a resource in the system

pegAccumulators

array of objects

pegAccumulators

object

_self

object

Represents a resource in the system

int64

pegLabel

object

required

Represents a resource in the system

index

int32

required

Index of the pegAccumulator. Use a value between 0 and the max accumulators your device can report.

units

string

Description of the peg Accumulator. Maxlength:100 characters.

conversionFactor

string

Should be prefixed with arithmetic operator(+,-,*,/) followed by digits. Ex: +.0625, /100, -1, +1.5 .
Defaults to Quantity conversion factor.

calculationExpression

string

pegEvent

object

Represents a resource in the system

description

string

Description of the peg Accumulator. Maxlength:255 characters.

createdOn

date

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

lastModifiedOn

date

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

souQuantity

string

Defaults to None

accumulatorFormat

string

Defaults to 'UNSIGNED'

UNSIGNED SIGNED

version

int64

Defaults to 0

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

messageType

string

Message types of the pegEvent. Maxlength:32 characters

USER_DATA APPLICATION_DATA EVENT_REPORT

cost

int32

Cost of the pegEvent

createdOn

date

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

lastModifiedOn

date

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

description

string

Description of the peg event. Max Length = 255 characters

version

int64

Defaults to 0

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

status

string

required

Required for any updates, but should not be provided when creating a new pegBehavior. If present on create pegBehavior, it is ignored and defaults to 'Disabled'.

Enabled Disabled Suspended Deleted Pending_Delete

scriptDetails

string

createdOn

date

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

lastModifiedOn

date

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

inherited

boolean

Defaults to false.

true

version

int64

Defaults to 0

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

403

Not authorized for this operation.

404

PegBehavior not found.

500

Server error

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://qa.connect.calamp.com/connect/services/pegbehaviors/name/name \
3
     --header 'accept: application/json'

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

application/json

200successful operation