Associate entities to a schedule.

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

Associates entities to a schedule and returns the schedule.

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

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 schedule

description

string

Description for schedule

status

string

Defaults to 'Enabled'

Enabled Disabled Suspended Deleted Pending_Delete

activatedOn

date

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

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

deletedOn

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.

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

inheritable

boolean

A flag indicating if the schedule is inheritable, making it accessible to all child accounts, irrespective of their depth in the account sub tree

true

scheduleConfigs

array of objects

required

length between 1 and 2147483647

Schedule configurations

scheduleConfigs*

object

day

string

required

Day for the schedule

MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY

time

array of objects

Time for the schedule

time

object

startTime

string

Start Time for the schedule

endTime

string

End Time for the schedule

timeZone

string

The time zone of the schedule. Max Length = 64 characters. See https://nodatime.org/TimeZones for supported timeZones

tolerance

int32

The tolerance value should be between 1 and 60 (minutes) and it should be an integer not decimal value. If decimal value is provided, then it will be rounded down to the nearest integer.

400

Invalid request.

403

Not authorized for this operation.

404

Schedule not found.

500

Server error

Language

Credentials


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://qa.connect.calamp.com/connect/services/schedules/id/entities \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

200successful operation