CreateSchedule
Adds a new schedule.
Execute
EXEC CreateSchedule DocumentId=5500, Name='test', Type='xls', Destination='{"inbox": {}}', RecurrenceType='daily', RecurrenceExpression='{"@retriesAllowed":2,"@retryIntervalInSeconds":60,"startdate":"2025-04-15T01:00:00.000+02:00","enddate":"2025-08-15T01:00:00.000+02:00","dayinterval":1}', Parameters='[{"parameter":{"@optional":false,"@type":"prompt","@dpId":"DP0","id":0,"technicalName":"Enter State:","answer":{"@constrained":false,"@type":"Text","values":[{"value":"Texas"}]}}}]'
Input
| Name | Type | Required | Description |
| DocumentID | String | True | The identifier of the document to schedule the report. |
| Name | String | True | The name of the schedule. |
| Type | String | True | The format type of the schedule. |
| ServerGroupId | Integer | False | The server group ID as defined in the CMC. |
| ServerGroupRequired | Bool | False | If false, the schedule is run preferably on the server that belongs to the specified server group. If the specified server is not available, then the schedule is run on the next available server. If true, only the specified servers found within the selected server group is used. If all of the servers in the server group are unavailable, then the schedule is not processed. |
| Destination | String | False | The destination aggregate in JSON format. |
| RecurrenceType | String | False | The recurrence type. |
| RecurrenceExpression | String | False | The recurrence expression aggregate in JSON format. |
| Parameters | String | False | The schedule parameters in JSON format. |
Result Set Columns
| Name | Type | Description |
| Id | String | The id of the created schedule. |
| Message | String | The message returned from the server. |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |