| GET | /schedules/hosts/{companyId} | ||
|---|---|---|---|
| GET | /schedules/hosts/{companyId}/{scheduleId} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| scheduleId | path | Guid | 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 | List<TypeScheduledHosts> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| ScheduleId | form | Guid | No | |
| HostId | form | string | No | |
| HostName | form | string | No | |
| HostDatacenterCode | form | string | No | |
| HostLocationId | form | Guid | No | |
| Precedence | form | int | No | |
| DelayStart | form | int | 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.
GET /schedules/hosts/{companyId} HTTP/1.1
Host: n3tapi.palmettovdc.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
result:
[
{
id: 00000000000000000000000000000000,
scheduleId: 00000000000000000000000000000000,
hostId: String,
hostName: String,
hostDatacenterCode: String,
hostLocationId: 00000000000000000000000000000000,
precedence: 0,
delayStart: 0
}
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}