Create Event Schedule

POST 
https://app.infodeck.io/api/organizations/:organizationId/event-schedules

Create new event rule

Request

Path Parameters

organizationId stringrequired

The ID of organization.

application/json

Body

required

name stringrequired

The name of event schedule.

description string

The description of event schedule.

stage stringrequired

The stage of event schedule.

targetName string

The target name of event schedule, when stage is edge.

expressionType stringrequired

The expression type of event schedule.

oneTimeExpression number

The one-time expression of event schedule.

cronExpression object

The cron expression of event schedule.

rateExpression object

The rate expression of event schedule.

timezone number

The timezone of event schedule.

startDate number

The start date of event schedule.

endDate number

The end date of event schedule.

actions string[]required

The actions of event schedule.

hashtags string[]

The hashtags of event rule.

status stringrequired

The status 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

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
  }
}

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
  }
}

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."
}

Authorization: http

name: usertype: httpscheme: bearerbearerFormat: JWTdescription: Get your API token via POST /authentications/tokens

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST 'https://app.infodeck.io/api/organizations/:organizationId/event-schedules' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "description": "string",
  "stage": "string",
  "targetName": "string",
  "expressionType": "string",
  "oneTimeExpression": 0,
  "cronExpression": {},
  "rateExpression": {},
  "timezone": 0,
  "startDate": 0,
  "endDate": 0,
  "actions": [
    "string"
  ],
  "hashtags": [
    "string"
  ],
  "status": "string"
}'

Request Collapse all

Base URL

https://app.infodeck.io/api

Auth

Bearer Token

Parameters

organizationId — pathrequired

Body required

• Example (from schema)
• Example

{
  "name": "string",
  "description": "string",
  "stage": "string",
  "targetName": "string",
  "expressionType": "string",
  "oneTimeExpression": 0,
  "cronExpression": {},
  "rateExpression": {},
  "timezone": 0,
  "startDate": 0,
  "endDate": 0,
  "actions": [
    "string"
  ],
  "hashtags": [
    "string"
  ],
  "status": "string"
}

ResponseClear

Click the Send API Request button above and see the response here!