| GET | /schedule/host/{hostId} | Return Schedule for a given Host. | |
|---|---|---|---|
| POST | /schedule/host/{hostId}/{scheduleId}/{hostName}/{hostDatacenterCode} | Add a Schedule to the Host for a specific Datacenter. | |
| POST | /schedule/host/{hostId}/{scheduleId}/{hostName}/{hostDatacenterCode}/{hostLocationId} | ||
| POST,PUT | /schedule/host/{hostId}/{scheduleId}/{hostName}/{hostDatacenterCode}/{precedence}/{delayStart}/{id] | Update a Schedule's settings for given Host for Delay and Precedence. | |
| POST | /schedule/host/{hostId}/{scheduleId}/{delete} | Remove a Schedule from a given Host |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| id | path | Guid | No | |
| scheduleId | path | Guid | No | |
| hostId | path | string | No | |
| hostName | path | string | No | |
| hostDatacenterCode | path | string | No | Allowable Values
|
| hostLocationId | path | Guid | No | |
| precedence | path | int | No | |
| delayStart | path | int | No | |
| delete | path | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| companyId | form | Guid | No | |
| userId | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| sessionId | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | Object | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /schedule/host/{hostId}/{scheduleId}/{hostName}/{hostDatacenterCode} HTTP/1.1
Host: n3tapi.palmettovdc.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: 00000000000000000000000000000000,
scheduleId: 00000000000000000000000000000000,
hostId: String,
hostName: String,
hostDatacenterCode: String,
hostLocationId: 00000000000000000000000000000000,
precedence: 0,
delayStart: 0,
delete: False,
companyId: 00000000000000000000000000000000,
userId: 00000000000000000000000000000000,
sessionId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
result: {},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}