Create the custom message end point for the enterprise account

post https://qa.connect.calamp.com/connect/services/accounts/{id}/messageendpoint

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.

configuration

object

required

The configuration of the custom message endpoint.The sub type info of MessageEndpointConfig model can be viewed here

type

string

AWS_SQS AWS_KINESIS RABBIT_MQ KAFKA_MTLS KAFKA_SASL_SCRAM KAFKA_SASL_PLAIN

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.

version

int64

Defaults to 0

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

status

string

Status of the message endpoint. Default value is 'Enabled'. Maxlength:16 characters

Enabled Disabled Suspended Deleted Pending_Delete

403

Not authorized for this operation.

404

Account not found.

500

Server error

Language

Credentials


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://qa.connect.calamp.com/connect/services/accounts/id/messageendpoint \
3
     --header 'accept: application/json;charset=UTF-8' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "messageEndpoint": {
8
    "version": 0
9
  }
10
}
11
'

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

application/json;charset=UTF-8

200successful operation