Skip to main content

GET – Task Service

Request

GET https://{{ip}}/redfish/v1/TaskService
Content-Type: application/json

This resource shall be used to represent a task service for a Redfish implementation. It represents the properties for the service itself and has links to the actual list of tasks.

Response

The response of the request will be in JSON format. The properties are mentioned in the following.

Table 1. Task Service Property

Name

Type

Read only

Description

(OData Attributes)  

Refer to OData Support

OemObject 

OEM Extension (Optional), Refer to Resource Complex Types

Id(M)

String

True

Refer to Resource Type Definitions

Name(M)(C)

String

True

Description (C)

String

True

CompletedTaskOverWritePolicy(C)

String

True

The value of this property shall indicate how completed tasks are handled should the task service need to track more tasks.

Enum

Description

Manual

Completed tasks are not automatically overwritten.

Oldest

Oldest completed tasks are overwritten.

DateTime

String

True

The current DateTime value for the TaskService, with offset from UTC, in Redfish Timestamp format.

LifeCycleEventOnTaskStateChange

Boolean

True

The value of this property, if set to true, shall indicate that the service shall send a Life Cycle event to Listener Destinations registered for such events upon change of task state

ServiceEnabled(C)

Boolean

True

This indicates whether this service is enabled.

Status

Object

True

Refer to Resource Complex Types

Tasks

Object

True

The value of this property shall be a link to a resource of type Task Collection.

Actions

Object

True

This object will contain the actions for this resource under Oem property if any.