Summary
Create a schedule.
Description
Create a new schedule.
Route
POST /policy-manager/schedules
Roles
admin
other
readonly
apiread
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
details |
object |
yes |
Details of service to be created |
Copied to Clipboard
{
"details": {
"name": "my standard name",
"_id": {
"id": {
"instanceof": "Buffer"
}
},
"description": "my standard description",
"daysOfWeek": {
"sunday": false,
"monday": false,
"tuesday": true,
"wednesday": false,
"thursday": true,
"friday": true,
"saturday": true
},
"timeOfDayStart": {
"hour": 2,
"minute": 2
},
"timeOfDayEnd": {
"hour": 6,
"minute": 5
},
"beginDate": "2222-46-75T84:86:048630Z",
"endDate": "4941-48-52T11:63:21f96619517Z"
}
}
Return
DetailsExampleSchema
Name |
Type |
Description |
response |
object |
Response object with the document that was created. |
Copied to Clipboard
{
"status": "failure",
"message": "adipisicing",
"doc": {
"id": "sit et",
"name": "my standard name",
"description": "my standard description",
"daysOfWeek": {
"sunday": false,
"monday": false,
"tuesday": true,
"wednesday": false,
"thursday": true,
"friday": true,
"saturday": false
},
"timeOfDayStart": null,
"timeOfDayEnd": {
"hour": 1,
"minute": 22
},
"beginDate": "4611-40-89T89:71:01\"008191Z",
"endDate": "5719-94-56T70:55:07V85298486215Z",
"created": "anim exercitation",
"createdBy": "sed",
"lastUpdated": "laboris sed culpa pariatur cupidatat",
"lastUpdatedBy": "eu sint dolor laboris",
"_id": {
"id": {
"instanceof": "Buffer"
}
}
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"success",
"failure"
]
},
"message": {
"type": "string"
},
"doc": {
"$ref": "scheduleDocument#/definitions/apiResponse"
}
},
"required": [
"status"
]
}