# Create a new Operation Endpoint: POST /v0/operations/ Version: 1.0.0 Security: apiKey ## Request fields (application/json): - `operation_type` (string) Enum: "CONVERGE", "INSTALL", "UNINSTALL", "APP_INSTALL", "APP_UNINSTALL", "REBOOT" - `schedule_type` (string) Following Schedule types are supported ``` * IMMEDIATE: Schedule the command to execcute Immediately * WINDOW: Schedule the command to execute within the given window Enum: "IMMEDIATE", "WINDOW" - `schedule_args` (object) - `schedule_args.start_datetime` (string) Start date and time in ISO 8601 format, including timezone (e.g., 2024-08-08T14:30:00Z or 2024-08-08T14:30:00+05:30). - `schedule_args.end_datetime` (string) End date and time in ISO 8601 format, including timezone (e.g., 2024-08-08T15:30:00Z or 2024-08-08T15:30:00+05:30). - `schedule_args.time_type` (string) The Time-Type argument, in Schedule args, is to indicate which timezone the Command Framework should utilize when scheduling the command. Following Schedule Args for Time-Type are supported: * CONSOLE: Use the local timezone of the user creating the schedule. * DEVICE: Use the local timezone of the device, to which the command is issued, wherever it may be. Enum: "console", "device" - `schedule_args.window_start_time` (string) It is automatically populated by the time field from the request's start_datetime and cannot be injected via the API request body. - `schedule_args.window_end_time` (string) It is automatically populated by the time field from the request's end_datetime and cannot be injected via the API request body. - `schedule_args.days` (array) - `operation_device_query` (object) A flexible JSON object to define device properties and filters. - `arguments` (object) - `arguments.converge_with_provision` (boolean) - `arguments.sample_key` (string) ## Response 201 fields (application/json): - `content` (object) - `content.id` (string) - `content.operation` (string) Enum: "CONVERGE" - `content.state` (string) Enum: "CREATED", "RESOLVING", "RESOLVED", "DISPATCHING", "COMPLETED", "FAILED" - `content.schedule_type` (string) Following Schedule types are supported ``` * IMMEDIATE: Schedule the command to execcute Immediately * WINDOW: Schedule the command to execute within the given window Enum: "IMMEDIATE", "WINDOW" - `content.schedule_args` (object) - `content.schedule_args.start_datetime` (string) Start date and time in ISO 8601 format, including timezone (e.g., 2024-08-08T14:30:00Z or 2024-08-08T14:30:00+05:30). - `content.schedule_args.end_datetime` (string) End date and time in ISO 8601 format, including timezone (e.g., 2024-08-08T15:30:00Z or 2024-08-08T15:30:00+05:30). - `content.schedule_args.time_type` (string) The Time-Type argument, in Schedule args, is to indicate which timezone the Command Framework should utilize when scheduling the command. Following Schedule Args for Time-Type are supported: * CONSOLE: Use the local timezone of the user creating the schedule. * DEVICE: Use the local timezone of the device, to which the command is issued, wherever it may be. Enum: "console", "device" - `content.schedule_args.window_start_time` (string) It is automatically populated by the time field from the request's start_datetime and cannot be injected via the API request body. - `content.schedule_args.window_end_time` (string) It is automatically populated by the time field from the request's end_datetime and cannot be injected via the API request body. - `content.schedule_args.days` (array) - `content.operation_device_query` (object) - `content.arguments` (object) - `content.arguments.converge_with_provision` (boolean) - `content.arguments.sample_key` (string) - `content.reason` (string) - `content.created_at` (string) - `content.created_by` (string) - `content.updated_at` (string) - `content.updated_by` (string) - `content.operation_activity` (array) - `content.operation_activity.operation_state` (string) Enum: "CREATED", "QUERY INITIATED", "QUERY RESOLVED", "DISPATCHING", "DISPATCHED", "PROCESSING", "SUCCESS", "FAILURE" - `content.operation_stats` (object) - `content.operation_stats.device_operation_statuses_count` (object) - `content.operation_stats.device_operation_statuses_count.resolved_device_count` (integer) - `content.operation_stats.device_operation_statuses_count.dispatched_device_count` (integer) - `content.operation_stats.device_operation_statuses_count.dispatch_failed_count` (integer) - `content.operation_stats.device_operation_statuses_count.failed_device_count` (integer) - `content.operation_stats.device_operation_statuses_count.success_device_count` (integer)