Retrieve the IOProfile.

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

Returns the IOProfile or null if no IOProfile for the given Id was found.

Response

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.

description

string

Description of the ioprofile. Max Length = 255 characters

status

string

required

Defaults to 'Enabled. MaxLength:16 characters

Enabled Disabled Suspended Deleted Pending_Delete

createdOn

date

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

profileName

string

required

The IO profile name. MaxLength:64 characters

ports

array of objects

List of IO ports.

ports

object

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

name

string

The IO Port name. Default to inputX where X is index. MaxLength:32 characters

index

int32

The port's index or number on the device. Default to 0.

lowStatus

string

Name of the status when the input is inactive. Default to 'Low'. MaxLength:16 characters

highStatus

string

Name of the status when the input is active. Default to 'High'. MaxLength:16 characters

workingIdle

boolean

If this flag is set to true it indicates that if the device message has the corresponding input data, it will not be considered as idling time.

portType

string

Port Type. Default to 'IN'

IN OUT

int32

The pin number in the port that is doing the actual IO.

version

int64

Defaults to 0

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

inheritable

boolean

Defaults to 'false'

true

deletedOn

date

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

activatedOn

date

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

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.

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

Language

Credentials


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

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

*/*

200ok