GetBufferTimeUsage
HTTP Request Formats
POST api/BufferTimesUsage
GET api/BufferTimeUsage/{resourceName}
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/BufferTimeUsage
GET api/achedule/{scheduleName}/BufferTimeUsage/{resourceName}
Description
The GetBufferTimeUsage REST API command returns the names of all tasks with an assignment within the specified resource's buffer time. If any tasks are unassigned, they will also be returned if they have any timeslots within the specified resource's buffer time.
Parameters
Parameters are only required if a POST endpoint is used. Only one of "Id", "IdList", and "All" should be used.
| JSON Parameters | Body Format | Description |
|---|---|---|
| resourceName | "resourceName" : "Res1" | Parameter is a string of a single resource name. |
Examples
Return assignments/timeslots that include SSR as a resource, and are within the buffer time of FUSE.
POST api/BufferTimesUsage
Body:
{
"resourceName" : "SSR"
}
Alternative:
GET api/BufferTimeUsage/{resourceName}
Return Message
Returns a message that contains all the included tasks.
Group Membership
This command belongs to the following group(s):
Version
11.6
