Get Event Schedule

GET 
/organizations/:organizationId/event-schedules/:eventScheduleId

Get event schedule

Request

Path Parameters

organizationId stringrequired

The ID of organization.

eventScheduleId stringrequired

The ID of event schedule.

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the event schedule.
name stringrequired
description stringrequired
stage stringrequired
status stringrequired
targetName stringrequired
expressionType stringrequired
hashtags string[]required
cronExpression objectrequired
atHours numberrequired
atMinutes numberrequired
dayOfMonth number[]required
actions object[]required
Array [
type stringrequired
parameters objectrequired
name stringrequired
assetId stringrequired
confirmed booleanrequired
fPort numberrequired
payload stringrequired
payloadDataType stringrequired
]
createdBy stringrequired
createdAtDateString stringrequired
createdAt numberrequired
updatedAtDateString stringrequired
updatedAt numberrequired

Example (from schema)

{
  "data": {
    "name": "string",
    "description": "string",
    "stage": "string",
    "status": "string",
    "targetName": "string",
    "expressionType": "string",
    "hashtags": [
      "string"
    ],
    "cronExpression": {
      "atHours": 0,
      "atMinutes": 0,
      "dayOfMonth": [
        0
      ]
    },
    "actions": [
      {
        "type": "string",
        "parameters": {
          "name": "string",
          "assetId": "string",
          "confirmed": true,
          "fPort": 0,
          "payload": "string",
          "payloadDataType": "string"
        }
      }
    ],
    "createdBy": "string",
    "createdAtDateString": "string",
    "createdAt": 0,
    "updatedAtDateString": "string",
    "updatedAt": 0
  }
}

Example

{
  "data": {
    "name": "IDT-EventSchedule",
    "description": "IDT-EventSchedule-Description",
    "stage": "EventBridgeScheduler",
    "status": "Enabled",
    "targetName": "IoTCore-Target-Name",
    "expressionType": "cron",
    "hashtags": [
      "Important"
    ],
    "cronExpression": {
      "atHours": 11,
      "atMinutes": 47,
      "dayOfMonth": [
        7
      ]
    },
    "actions": [
      {
        "type": "EnqueueDevice",
        "parameters": {
          "name": "Power Off",
          "assetId": "a-assetId",
          "confirmed": true,
          "fPort": 85,
          "payload": "080000ff",
          "payloadDataType": "string"
        }
      }
    ],
    "createdBy": "d6b0e137-xxxx-xxxx-xxxx-c944cc12a5f4",
    "createdAtDateString": "2024-01-01T00:00:00.000Z",
    "createdAt": 1704067200000,
    "updatedAtDateString": "2024-01-31T00:00:00.000Z",
    "updatedAt": 1706659200000
  }
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

404

The resource hasn't found.

application/json

Schema

Schema

error stringrequired

The resource hasn't found.

message stringrequired

The resource hasn't found message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ResourceNotFound",
  "message": "The requested resource could not be found."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...