Update a PegLabel.

put https://qa.connect.calamp.com/connect/services/peglabels/{id}

The PegLabel object to be updated, with updated data, is the required input. If the PegLabel exists, it is updated, else a new PegLabel record is created. Returns the updated/created PegLabel. Not applicable if systemDefined is true.

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.

name

string

required

Name of the peglabel. Maxlength:32 characters

description

string

Description of the pegLabel. Maxlength:255 characters

type

string

required

Type of the peglabel. Maxlength:17 characters

EVENT ACCUMULATOR

unit

string

unit of the pegLabel. Maxlength:17 characters

conversionFactor

string

ConversionFactor of the pegLabel. Maxlength:100 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

signed

boolean

value to check signed or not

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

required

Defaults to false.

true

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

PegLabel not found.

409

Object state out-of-date.

500

Server error

Language

Credentials


xxxxxxxxxx
13
1
curl --request PUT \
2
     --url https://qa.connect.calamp.com/connect/services/peglabels/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "pegLabel": {
8
    "type": "EVENT",
9
    "inherited": true,
10
    "version": 0
11
  }
12
}
13
'

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

application/json

200successful operation