1<?xml version="1.0" encoding="UTF-8"?> 2<!----> 3<!--################################################################################ --> 4<!--# Redfish Schema: Task v1.7.3 --> 5<!--# --> 6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, --> 7<!--# available at http://www.dmtf.org/standards/redfish --> 8<!--# Copyright 2014-2023 DMTF. --> 9<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright --> 10<!--################################################################################ --> 11<!----> 12<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0"> 13 14 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml"> 15 <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/> 16 </edmx:Reference> 17 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml"> 18 <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/> 19 </edmx:Reference> 20 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Measures.V1.xml"> 21 <edmx:Include Namespace="Org.OData.Measures.V1" Alias="Measures"/> 22 </edmx:Reference> 23 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml"> 24 <edmx:Include Namespace="Resource"/> 25 <edmx:Include Namespace="Resource.v1_0_0"/> 26 </edmx:Reference> 27 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml"> 28 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/> 29 <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/> 30 </edmx:Reference> 31 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Message_v1.xml"> 32 <edmx:Include Namespace="Message"/> 33 </edmx:Reference> 34 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/TaskCollection_v1.xml"> 35 <edmx:Include Namespace="TaskCollection"/> 36 </edmx:Reference> 37 38 <edmx:DataServices> 39 40 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task"> 41 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 42 43 <EntityType Name="Task" BaseType="Resource.v1_0_0.Resource" Abstract="true"> 44 <Annotation Term="OData.Description" String="The Task schema contains information about a task that the Redfish task service schedules or executes. Tasks represent operations that take more time than a client typically wants to wait."/> 45 <Annotation Term="OData.LongDescription" String="This resource contains a task for a Redfish implementation."/> 46 <Annotation Term="Capabilities.InsertRestrictions"> 47 <Record> 48 <PropertyValue Property="Insertable" Bool="false"/> 49 </Record> 50 </Annotation> 51 <Annotation Term="Capabilities.UpdateRestrictions"> 52 <Record> 53 <PropertyValue Property="Updatable" Bool="false"/> 54 </Record> 55 </Annotation> 56 <Annotation Term="Capabilities.DeleteRestrictions"> 57 <Record> 58 <PropertyValue Property="Deletable" Bool="true"/> 59 <Annotation Term="OData.Description" String="Use the DELETE operation to remove a task."/> 60 </Record> 61 </Annotation> 62 <Annotation Term="Redfish.Uris"> 63 <Collection> 64 <String>/redfish/v1/TaskService/Tasks/{TaskId}</String> 65 <String>/redfish/v1/TaskService/Tasks/{TaskId}/SubTasks/{TaskId2}</String> 66 </Collection> 67 </Annotation> 68 </EntityType> 69 </Schema> 70 71 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_0_0"> 72 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 73 <Annotation Term="Redfish.Release" String="1.0"/> 74 75 <EntityType Name="Task" BaseType="Task.Task"> 76 <Property Name="TaskState" Type="Task.v1_0_0.TaskState" Nullable="false"> 77 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 78 <Annotation Term="OData.Description" String="The state of the task."/> 79 <Annotation Term="OData.LongDescription" String="This property shall indicate the state of the task."/> 80 </Property> 81 <Property Name="StartTime" Type="Edm.DateTimeOffset" Nullable="false"> 82 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 83 <Annotation Term="OData.Description" String="The date and time when the task was started."/> 84 <Annotation Term="OData.LongDescription" String="This property shall indicate the date and time when the task was started."/> 85 </Property> 86 <Property Name="EndTime" Type="Edm.DateTimeOffset" Nullable="false"> 87 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 88 <Annotation Term="OData.Description" String="The date and time when the task was completed. This property will only appear when the task is complete."/> 89 <Annotation Term="OData.LongDescription" String="This property shall indicate the date and time when the task was completed. This property shall not appear if the task is running or otherwise has not been completed. This property shall appear only if the TaskState is Completed, Killed, Cancelled, or Exception."/> 90 </Property> 91 <Property Name="TaskStatus" Type="Resource.Health" Nullable="false"> 92 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 93 <Annotation Term="OData.Description" String="The completion status of the task."/> 94 <Annotation Term="OData.LongDescription" String="This property shall contain the completion status of the task and shall not be set until the task completes. This property should contain `Critical` if one or more messages in the Messages array contains the severity `Critical`. This property should contain `Warning` if one or more messages in the Messages array contains the severity `Warning` and if no messages contain the severity `Critical`. This property should contain `OK` if all messages in the Messages array contain the severity `OK` or if the array is empty."/> 95 </Property> 96 <Property Name="Messages" Type="Collection(Message.Message)" Nullable="false"> 97 <Annotation Term="OData.Description" String="An array of messages associated with the task."/> 98 <Annotation Term="OData.LongDescription" String="This property shall contain an array of messages associated with the task."/> 99 </Property> 100 </EntityType> 101 102 <EnumType Name="TaskState"> 103 <Member Name="New"> 104 <Annotation Term="OData.Description" String="A new task."/> 105 <Annotation Term="OData.LongDescription" String="This value shall represent that the task is newly created but has not started."/> 106 </Member> 107 <Member Name="Starting"> 108 <Annotation Term="OData.Description" String="Task is starting."/> 109 <Annotation Term="OData.LongDescription" String="This value shall represent that the task is starting."/> 110 </Member> 111 <Member Name="Running"> 112 <Annotation Term="OData.Description" String="Task is running normally."/> 113 <Annotation Term="OData.LongDescription" String="This value shall represent that the task is executing."/> 114 </Member> 115 <Member Name="Suspended"> 116 <Annotation Term="OData.Description" String="Task has been suspended."/> 117 <Annotation Term="OData.LongDescription" String="This value shall represent that the task has been suspended but is expected to restart and is therefore not complete."/> 118 </Member> 119 <Member Name="Interrupted"> 120 <Annotation Term="OData.Description" String="Task has been interrupted."/> 121 <Annotation Term="OData.LongDescription" String="This value shall represent that the task has been interrupted but is expected to restart and is therefore not complete."/> 122 </Member> 123 <Member Name="Pending"> 124 <Annotation Term="OData.Description" String="Task is pending and has not started."/> 125 <Annotation Term="OData.LongDescription" String="This value shall represent that the task is pending some condition and has not yet begun to execute."/> 126 </Member> 127 <Member Name="Stopping"> 128 <Annotation Term="OData.Description" String="Task is in the process of stopping."/> 129 <Annotation Term="OData.LongDescription" String="This value shall represent that the task is stopping but is not yet complete."/> 130 </Member> 131 <Member Name="Completed"> 132 <Annotation Term="OData.Description" String="Task was completed."/> 133 <Annotation Term="OData.LongDescription" String="This value shall represent that the task completed successfully or with warnings."/> 134 </Member> 135 <Member Name="Killed"> 136 <Annotation Term="OData.Description" String="Task was terminated."/> 137 <Annotation Term="OData.LongDescription" String="This value shall represent that the task is complete because an operator killed it."/> 138 <Annotation Term="Redfish.Revisions"> 139 <Collection> 140 <Record> 141 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Deprecated"/> 142 <PropertyValue Property="Version" String="v1_2_0"/> 143 <PropertyValue Property="Description" String="This value has been deprecated and is being replaced by the `Cancelled` value, which has more determinate semantics."/> 144 </Record> 145 </Collection> 146 </Annotation> 147 </Member> 148 <Member Name="Exception"> 149 <Annotation Term="OData.Description" String="Task has stopped due to an exception condition."/> 150 <Annotation Term="OData.LongDescription" String="This value shall represent that the task completed with errors."/> 151 </Member> 152 <Member Name="Service"> 153 <Annotation Term="OData.Description" String="Task is running as a service."/> 154 <Annotation Term="OData.LongDescription" String="This value shall represent that the task is now running as a service and expected to continue operation until stopped or killed."/> 155 </Member> 156 <Member Name="Cancelling"> 157 <Annotation Term="OData.Description" String="Task is in the process of being cancelled."/> 158 <Annotation Term="OData.LongDescription" String="This value shall represent that the task is in the process of being cancelled."/> 159 <Annotation Term="Redfish.Revisions"> 160 <Collection> 161 <Record> 162 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 163 <PropertyValue Property="Version" String="v1_2_0"/> 164 </Record> 165 </Collection> 166 </Annotation> 167 </Member> 168 <Member Name="Cancelled"> 169 <Annotation Term="OData.Description" String="Task has been cancelled by an operator or internal process."/> 170 <Annotation Term="OData.LongDescription" String="This value shall represent that either a DELETE operation on a task monitor or Task resource or by an internal process cancelled the task."/> 171 <Annotation Term="Redfish.Revisions"> 172 <Collection> 173 <Record> 174 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 175 <PropertyValue Property="Version" String="v1_2_0"/> 176 </Record> 177 </Collection> 178 </Annotation> 179 </Member> 180 </EnumType> 181 </Schema> 182 183 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_0_2"> 184 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 185 <Annotation Term="OData.Description" String="This version was created to show that annotations in previous namespaces were updated."/> 186 <EntityType Name="Task" BaseType="Task.v1_0_0.Task"/> 187 </Schema> 188 189 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_0_3"> 190 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 191 <Annotation Term="OData.Description" String="This version was created to show that annotations in previous namespaces were updated."/> 192 <EntityType Name="Task" BaseType="Task.v1_0_2.Task"/> 193 </Schema> 194 195 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_0_4"> 196 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 197 <Annotation Term="OData.Description" String="This version was created to show that annotations in previous namespaces were updated."/> 198 <EntityType Name="Task" BaseType="Task.v1_0_3.Task"/> 199 </Schema> 200 201 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_0_5"> 202 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 203 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/> 204 <EntityType Name="Task" BaseType="Task.v1_0_4.Task"/> 205 </Schema> 206 207 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_0_6"> 208 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 209 <Annotation Term="OData.Description" String="This version was created to use the new Revisions annotation."/> 210 <EntityType Name="Task" BaseType="Task.v1_0_5.Task"/> 211 </Schema> 212 213 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_0_7"> 214 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 215 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format. It was also created to correct the resource description."/> 216 <EntityType Name="Task" BaseType="Task.v1_0_6.Task"/> 217 </Schema> 218 219 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_0_8"> 220 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 221 <Annotation Term="OData.Description" String="This version was created to clarify the descriptions of the StartTime and EndTime properties. It was also created to update descriptions that this schema defines."/> 222 <EntityType Name="Task" BaseType="Task.v1_0_7.Task"/> 223 </Schema> 224 225 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_0_9"> 226 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 227 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> 228 <EntityType Name="Task" BaseType="Task.v1_0_8.Task"/> 229 </Schema> 230 231 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_0_10"> 232 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 233 <Annotation Term="OData.Description" String="This version was created to clarify the mapping of TaskStatus."/> 234 <EntityType Name="Task" BaseType="Task.v1_0_9.Task"/> 235 </Schema> 236 237 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_0_11"> 238 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 239 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> 240 <EntityType Name="Task" BaseType="Task.v1_0_10.Task"/> 241 </Schema> 242 243 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_1_0"> 244 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 245 <Annotation Term="Redfish.Release" String="2017.1"/> 246 247 <EntityType Name="Task" BaseType="Task.v1_0_3.Task"> 248 <Property Name="Actions" Type="Task.v1_1_0.Actions" Nullable="false"> 249 <Annotation Term="OData.Description" String="The available actions for this resource."/> 250 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/> 251 </Property> 252 </EntityType> 253 254 <ComplexType Name="Actions"> 255 <Annotation Term="OData.AdditionalProperties" Bool="false"/> 256 <Annotation Term="OData.Description" String="The available actions for this resource."/> 257 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/> 258 <Property Name="Oem" Type="Task.v1_1_0.OemActions" Nullable="false"> 259 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/> 260 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/> 261 </Property> 262 </ComplexType> 263 264 <ComplexType Name="OemActions"> 265 <Annotation Term="OData.AdditionalProperties" Bool="true"/> 266 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/> 267 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/> 268 </ComplexType> 269 </Schema> 270 271 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_1_1"> 272 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 273 <Annotation Term="OData.Description" String="This version was created to show that annotations in previous namespaces were updated."/> 274 <EntityType Name="Task" BaseType="Task.v1_1_0.Task"/> 275 </Schema> 276 277 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_1_2"> 278 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 279 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/> 280 <EntityType Name="Task" BaseType="Task.v1_1_1.Task"/> 281 </Schema> 282 283 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_1_3"> 284 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 285 <Annotation Term="OData.Description" String="This version was created to use the new revisions annotation."/> 286 <EntityType Name="Task" BaseType="Task.v1_1_2.Task"/> 287 </Schema> 288 289 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_1_4"> 290 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 291 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format. It was also created to correct the resource description."/> 292 <EntityType Name="Task" BaseType="Task.v1_1_3.Task"/> 293 </Schema> 294 295 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_1_5"> 296 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 297 <Annotation Term="OData.Description" String="This version was created to clarify the descriptions of the StartTime and EndTime properties. It was also created to update descriptions that this schema defines."/> 298 <EntityType Name="Task" BaseType="Task.v1_1_4.Task"/> 299 </Schema> 300 301 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_1_6"> 302 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 303 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> 304 <EntityType Name="Task" BaseType="Task.v1_1_5.Task"/> 305 </Schema> 306 307 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_1_7"> 308 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 309 <Annotation Term="OData.Description" String="This version was created to clarify the mapping of TaskStatus."/> 310 <EntityType Name="Task" BaseType="Task.v1_1_6.Task"/> 311 </Schema> 312 313 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_1_8"> 314 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 315 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> 316 <EntityType Name="Task" BaseType="Task.v1_1_7.Task"/> 317 </Schema> 318 319 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_2_0"> 320 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 321 <Annotation Term="Redfish.Release" String="2018.1"/> 322 <Annotation Term="OData.Description" String="This version was created to add the TaskMonitor property. This version was also created to add the `Cancelled` and `Cancelling` values to TaskState, and deprecate `Killed`."/> 323 324 <EntityType Name="Task" BaseType="Task.v1_1_1.Task"> 325 <Property Name="TaskMonitor" Type="Edm.String" Nullable="false"> 326 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 327 <Annotation Term="OData.Description" String="The URI of the Task Monitor for this task."/> 328 <Annotation Term="OData.LongDescription" String="This property shall contain a URI to task monitor as defined in the Redfish Specification."/> 329 <Annotation Term="OData.IsURL"/> 330 </Property> 331 </EntityType> 332 </Schema> 333 334 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_2_1"> 335 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 336 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/> 337 <EntityType Name="Task" BaseType="Task.v1_2_0.Task"/> 338 </Schema> 339 340 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_2_2"> 341 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 342 <Annotation Term="OData.Description" String="This version was created to use the new revisions annotation."/> 343 <EntityType Name="Task" BaseType="Task.v1_2_1.Task"/> 344 </Schema> 345 346 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_2_3"> 347 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 348 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format. It was also created to correct the resource description."/> 349 <EntityType Name="Task" BaseType="Task.v1_2_2.Task"/> 350 </Schema> 351 352 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_2_4"> 353 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 354 <Annotation Term="OData.Description" String="This version was created to clarify the descriptions of the StartTime and EndTime properties. It was also created to update descriptions that this schema defines."/> 355 <EntityType Name="Task" BaseType="Task.v1_2_3.Task"/> 356 </Schema> 357 358 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_2_5"> 359 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 360 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> 361 <EntityType Name="Task" BaseType="Task.v1_2_4.Task"/> 362 </Schema> 363 364 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_2_6"> 365 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 366 <Annotation Term="OData.Description" String="This version was created to clarify the mapping of TaskStatus."/> 367 <EntityType Name="Task" BaseType="Task.v1_2_5.Task"/> 368 </Schema> 369 370 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_2_7"> 371 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 372 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> 373 <EntityType Name="Task" BaseType="Task.v1_2_6.Task"/> 374 </Schema> 375 376 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_3_0"> 377 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 378 <Annotation Term="Redfish.Release" String="2018.2"/> 379 <Annotation Term="OData.Description" String="This version was created to add the Payload object to provide consistent capabilities with jobs."/> 380 381 <EntityType Name="Task" BaseType="Task.v1_2_1.Task"> 382 <Property Name="Payload" Type="Task.v1_3_0.Payload" Nullable="false"> 383 <Annotation Term="OData.Description" String="The HTTP and JSON request payload details for this task, unless they are hidden from view by the service."/> 384 <Annotation Term="OData.LongDescription" String="This object shall contain information detailing the HTTP and JSON request payload information for executing this task. This property shall not be included in the response if the HidePayload property is `true`."/> 385 </Property> 386 <Property Name="HidePayload" Type="Edm.Boolean" Nullable="false"> 387 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 388 <Annotation Term="OData.Description" String="An indication of whether the contents of the payload are hidden from view after the task has been created. If `true`, responses do not return the payload. If `false`, responses return the payload. If this property is not present when the task is created, the default is `false`."/> 389 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the contents of the payload should be hidden from view after the task has been created. If `true`, responses shall not return the Payload property. If `false`, responses shall return the Payload property. If this property is not present when the task is created, the default is `false`. This property shall be supported if the Payload property is supported."/> 390 </Property> 391 </EntityType> 392 393 <ComplexType Name="Payload"> 394 <Annotation Term="OData.Description" String="The HTTP and JSON payload details for this Task."/> 395 <Annotation Term="OData.LongDescription" String="This type shall contain information detailing the HTTP and JSON payload information for executing this task."/> 396 <Annotation Term="OData.AdditionalProperties" Bool="false"/> 397 <Property Name="TargetUri" Type="Edm.String" Nullable="false"> 398 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 399 <Annotation Term="OData.Description" String="The URI of the target for this task."/> 400 <Annotation Term="OData.LongDescription" String="This property shall contain a link to the location to use as the target for an HTTP operation."/> 401 <Annotation Term="OData.IsURL"/> 402 </Property> 403 <Property Name="HttpOperation" Type="Edm.String" Nullable="false"> 404 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 405 <Annotation Term="OData.Description" String="The HTTP operation to perform to execute this task."/> 406 <Annotation Term="OData.LongDescription" String="This property shall contain the HTTP operation to execute for this task."/> 407 </Property> 408 <Property Name="HttpHeaders" Type="Collection(Edm.String)" Nullable="false"> 409 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 410 <Annotation Term="OData.Description" String="An array of HTTP headers that this task includes."/> 411 <Annotation Term="OData.LongDescription" String="This property shall contain an array of HTTP headers that this task includes."/> 412 </Property> 413 <Property Name="JsonBody" Type="Edm.String" Nullable="false"> 414 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 415 <Annotation Term="OData.Description" String="The JSON payload to use in the execution of this task."/> 416 <Annotation Term="OData.LongDescription" String="This property shall contain the JSON-formatted payload used for this task."/> 417 </Property> 418 </ComplexType> 419 </Schema> 420 421 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_3_1"> 422 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 423 <Annotation Term="OData.Description" String="This version was created to use the new revisions annotation."/> 424 <EntityType Name="Task" BaseType="Task.v1_3_0.Task"/> 425 </Schema> 426 427 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_3_2"> 428 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 429 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format. It was also created to correct the resource description."/> 430 <EntityType Name="Task" BaseType="Task.v1_3_1.Task"/> 431 </Schema> 432 433 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_3_3"> 434 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 435 <Annotation Term="OData.Description" String="This version was created to update the descriptions of the HidePayload, StartTime, and EndTime properties. It was also created to update descriptions that this schema defines."/> 436 <EntityType Name="Task" BaseType="Task.v1_3_2.Task"/> 437 </Schema> 438 439 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_3_4"> 440 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 441 <Annotation Term="OData.Description" String="This version was created to update the descriptions of the HidePayload property."/> 442 <EntityType Name="Task" BaseType="Task.v1_3_3.Task"/> 443 </Schema> 444 445 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_3_5"> 446 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 447 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> 448 <EntityType Name="Task" BaseType="Task.v1_3_4.Task"/> 449 </Schema> 450 451 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_3_6"> 452 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 453 <Annotation Term="OData.Description" String="This version was created to clarify the mapping of TaskStatus."/> 454 <EntityType Name="Task" BaseType="Task.v1_3_5.Task"/> 455 </Schema> 456 457 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_3_7"> 458 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 459 <Annotation Term="OData.Description" String="This version was created to clarify the usage of the Payload property."/> 460 <EntityType Name="Task" BaseType="Task.v1_3_6.Task"/> 461 </Schema> 462 463 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_3_8"> 464 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 465 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> 466 <EntityType Name="Task" BaseType="Task.v1_3_7.Task"/> 467 </Schema> 468 469 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_4_0"> 470 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 471 <Annotation Term="Redfish.Release" String="2018.3"/> 472 <Annotation Term="OData.Description" String="This version was created to add the PercentComplete property."/> 473 474 <EntityType Name="Task" BaseType="Task.v1_3_1.Task"> 475 <Property Name="PercentComplete" Type="Edm.Int64"> 476 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 477 <Annotation Term="OData.Description" String="The completion percentage of this task."/> 478 <Annotation Term="OData.LongDescription" String="This property shall indicate the completion progress of the task, reported in percent of completion, `0` to `100`. If the task has not been started, the value shall be zero."/> 479 <Annotation Term="Measures.Unit" String="%"/> 480 <Annotation Term="Validation.Minimum" Int="0"/> 481 <Annotation Term="Validation.Maximum" Int="100"/> 482 </Property> 483 </EntityType> 484 </Schema> 485 486 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_4_1"> 487 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 488 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format. It was also created to correct the resource description."/> 489 <EntityType Name="Task" BaseType="Task.v1_4_0.Task"/> 490 </Schema> 491 492 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_4_2"> 493 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 494 <Annotation Term="OData.Description" String="This version was created to update the descriptions of the HidePayload, StartTime, and EndTime properties. It was also created to update descriptions that this schema defines."/> 495 <EntityType Name="Task" BaseType="Task.v1_4_1.Task"/> 496 </Schema> 497 498 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_4_3"> 499 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 500 <Annotation Term="OData.Description" String="This version was created to update the descriptions of the HidePayload property."/> 501 <EntityType Name="Task" BaseType="Task.v1_4_2.Task"/> 502 </Schema> 503 504 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_4_4"> 505 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 506 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> 507 <EntityType Name="Task" BaseType="Task.v1_4_3.Task"/> 508 </Schema> 509 510 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_4_5"> 511 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 512 <Annotation Term="OData.Description" String="This version was created to clarify the mapping of TaskStatus."/> 513 <EntityType Name="Task" BaseType="Task.v1_4_4.Task"/> 514 </Schema> 515 516 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_4_6"> 517 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 518 <Annotation Term="OData.Description" String="This version was created to clarify the usage of the Payload property."/> 519 <EntityType Name="Task" BaseType="Task.v1_4_5.Task"/> 520 </Schema> 521 522 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_4_7"> 523 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 524 <Annotation Term="OData.Description" String="This version was created to clarify the range of possible values for properties with percent units."/> 525 <EntityType Name="Task" BaseType="Task.v1_4_6.Task"/> 526 </Schema> 527 528 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_4_8"> 529 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 530 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> 531 <EntityType Name="Task" BaseType="Task.v1_4_7.Task"/> 532 </Schema> 533 534 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_5_0"> 535 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 536 <Annotation Term="Redfish.Release" String="2020.3"/> 537 538 <EntityType Name="Task" BaseType="Task.v1_4_3.Task"> 539 <NavigationProperty Name="SubTasks" Type="TaskCollection.TaskCollection" ContainsTarget="true" Nullable="false"> 540 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 541 <Annotation Term="OData.Description" String="The link to a collection of sub-tasks for this task."/> 542 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type TaskCollection. This property shall not be present if this resource represents a sub-task for a task."/> 543 <Annotation Term="OData.AutoExpandReferences"/> 544 </NavigationProperty> 545 </EntityType> 546 </Schema> 547 548 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_5_1"> 549 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 550 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> 551 <EntityType Name="Task" BaseType="Task.v1_5_0.Task"/> 552 </Schema> 553 554 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_5_2"> 555 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 556 <Annotation Term="OData.Description" String="This version was created to clarify the mapping of TaskStatus."/> 557 <EntityType Name="Task" BaseType="Task.v1_5_1.Task"/> 558 </Schema> 559 560 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_5_3"> 561 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 562 <Annotation Term="OData.Description" String="This version was created to clarify the usage of the Payload property."/> 563 <EntityType Name="Task" BaseType="Task.v1_5_2.Task"/> 564 </Schema> 565 566 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_5_4"> 567 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 568 <Annotation Term="OData.Description" String="This version was created to clarify the range of possible values for properties with percent units."/> 569 <EntityType Name="Task" BaseType="Task.v1_5_3.Task"/> 570 </Schema> 571 572 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_5_5"> 573 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 574 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> 575 <EntityType Name="Task" BaseType="Task.v1_5_4.Task"/> 576 </Schema> 577 578 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_6_0"> 579 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 580 <Annotation Term="Redfish.Release" String="2022.1"/> 581 582 <EntityType Name="Task" BaseType="Task.v1_5_1.Task"> 583 <Property Name="EstimatedDuration" Type="Edm.Duration"> 584 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 585 <Annotation Term="OData.Description" String="The estimated total time required to complete the task."/> 586 <Annotation Term="OData.LongDescription" String="This property shall indicate the estimated total time needed to complete the task. The value is not expected to change while the task is in progress, but the service may update the value if it obtains new information that significantly changes the expected duration. Services should be conservative in the reported estimate and clients should treat this value as an estimate."/> 587 </Property> 588 </EntityType> 589 </Schema> 590 591 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_6_1"> 592 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 593 <Annotation Term="OData.Description" String="This version was created to clarify the mapping of TaskStatus."/> 594 <EntityType Name="Task" BaseType="Task.v1_6_0.Task"/> 595 </Schema> 596 597 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_6_2"> 598 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 599 <Annotation Term="OData.Description" String="This version was created to clarify the usage of the Payload property."/> 600 <EntityType Name="Task" BaseType="Task.v1_6_1.Task"/> 601 </Schema> 602 603 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_6_3"> 604 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 605 <Annotation Term="OData.Description" String="This version was created to correct the regular expression pattern for duration properties in JSON Schema and OpenAPI to not allow for negative values."/> 606 <EntityType Name="Task" BaseType="Task.v1_6_2.Task"/> 607 </Schema> 608 609 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_6_4"> 610 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 611 <Annotation Term="OData.Description" String="This version was created to clarify the range of possible values for properties with percent units."/> 612 <EntityType Name="Task" BaseType="Task.v1_6_3.Task"/> 613 </Schema> 614 615 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_6_5"> 616 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 617 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> 618 <EntityType Name="Task" BaseType="Task.v1_6_4.Task"/> 619 </Schema> 620 621 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_7_0"> 622 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 623 <Annotation Term="Redfish.Release" String="2022.3"/> 624 625 <EntityType Name="Task" BaseType="Task.v1_6_2.Task"> 626 <Property Name="Links" Type="Task.v1_7_0.Links" Nullable="false"> 627 <Annotation Term="OData.Description" String="Contains references to other resources that are related to this resource."/> 628 <Annotation Term="OData.LongDescription" String="The Links property, as described by the Redfish Specification, shall contain references to resources that are related to but are not contained by, or subordinate to, this resource."/> 629 </Property> 630 </EntityType> 631 632 <ComplexType Name="Links" BaseType="Resource.Links"> 633 <Annotation Term="OData.Description" String="The links to other resources that are related to this resource."/> 634 <Annotation Term="OData.LongDescription" String="This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."/> 635 <NavigationProperty Name="CreatedResources" Type="Collection(Resource.Item)"> 636 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 637 <Annotation Term="OData.Description" String="An array of URIs referencing the resources created as the result of the operation that produced this task."/> 638 <Annotation Term="OData.LongDescription" String="This property shall contain an array of links to resources indicating the resources created as the result of the operation that produced this task. Services shall set this property prior to the task entering its final state."/> 639 <Annotation Term="OData.AutoExpandReferences"/> 640 </NavigationProperty> 641 </ComplexType> 642 </Schema> 643 644 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_7_1"> 645 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 646 <Annotation Term="OData.Description" String="This version was created to correct the regular expression pattern for duration properties in JSON Schema and OpenAPI to not allow for negative values."/> 647 <EntityType Name="Task" BaseType="Task.v1_7_0.Task"/> 648 </Schema> 649 650 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_7_2"> 651 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 652 <Annotation Term="OData.Description" String="This version was created to clarify the range of possible values for properties with percent units."/> 653 <EntityType Name="Task" BaseType="Task.v1_7_1.Task"/> 654 </Schema> 655 656 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Task.v1_7_3"> 657 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 658 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> 659 <EntityType Name="Task" BaseType="Task.v1_7_2.Task"/> 660 </Schema> 661 662 </edmx:DataServices> 663</edmx:Edmx> 664