EditResource
HTTP Request Formats
PATCH api/resource/{resourceName}
To specify the schedule the command shall be sent to:
PATCH api/schedule/{scheduleName}/resource/{resourceName}
Description
The EditResource REST API command edits the attributes of a resource in Astro Scheduler Engine. This command can be used to edit a single resource attribute or multiple attributes of a single resource. When editing multiple resource attributes, all attributes will be applied to the resource in the order in which they appear in the command.
All resources are created with default attribute values unless otherwise specified.
| Parameters | Description |
|---|---|
| General Parameters | |
| Description | Create a description for the given resource. |
| Priority | Set the priority of the given resource based on the priority scale set by the user. |
| MinimumSetupTime | Define the Minimum Setup Time for the resource. |
| BreakdownTime | Define the Breakdown Time for the resource. |
| BufferTime | Define the Buffer Time for the resource. |
| STKObject | Add an associated STK Object to the resource. |
| ResourceTag | Add the resource to different resource tags. |
| AssignmentColor | Assign a specific color to the given resource in the Gantt. |
| Cost | Set the cost options for the given resource. |
| Changes a given Resource's ResourceID to a new value specified by the user. | |
| Availability Parameters | |
| IsDefaultAvailable | Defines default availability of a resource. |
| AvailablePeriodicWindows | Defines periodic windows of availability or unavailability for a resource. |
| AvailableDiscreteWindows | Defines discrete windows of availability or unavailability for a resource. |
| AvailableTimeImport | Defines windows of availability or unavailability for a resource via a file import. |
| AvailabilitySTKReport | Defines windows of availability or unavailability for a resource via STK Reports. |
| Accommodation Parameters | |
| Accommodation | Defines the maximum amount of tasks that a resource is able to handle at once. |
| Capacity Parameters | |
| IsCapacityApplicable | Defines whether the given resource has a capacity. |
| Capacity | Defines the different values for the capacity of a resource. |
| StateModeMatrix | Defines a matrix of the time values required to transition between 2 modes. |
| Duration Parameters | |
| DurationOverrideType | Defines the type of duration override for the resource. |
| DurationOverrideFixed | Defines the fixed duration override when DurOverrideType = FixedDur. |
| DurationOverrideEfficiency | Defines the fixed duration override when DurOverrideType = EfficiencyFactor. |
| Notes Parameters | |
| Notes | Define notes for the given resource. |
| RFI | |
| RfiEntityType | Defines the type of constraint that should be applied to the resource. Options are None, CommNode, or Satellite. |
| RfiInterferingEntities | Defines the interfering satellites for resources with the Satellite RFIEntityType constraint. |
| Other Parameters | |
| Hide | Defines whether the given resource should be hidden from the gantt view. |
Examples
Changes the values of the Priority, SetupTime, and STKObject attributes of the DemoAntenna resource in the active schedule to 7, 15 minutes, and /Facility/DemoStation/Sensor/DemoAntenna, respectively. Also sets DemoAntenna to be unavailable from 2017/02/09 11:45:00 to 2017/02/09 13:00:00
PATCH api/resource/DemoAntenna
Body:
{
"Priority" : "7",
"SetupTime" : "900",
"STKObject" : "Facility/DemoStation/Sensor/DemoAntenna"
"AvailableDiscreteWindows" : {
"Start" : "2017/02/09_11:45:00",
"Stop" : "2017/02/09_13:30:00" }
}
Return Message
If activated, a standard response for a successful HTTP response shall appear.
Group Membership
This command belongs to the following group(s):
Version
12.3
