Data - Retrieve Tasks

Service:

Operations Manager

API Version:

v1

Retrieves the list of tasks and their properties.

POST http://<Servername>/OperationsManager/data/getTaskPane

Request Body

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Name	Required	Type	Description
id	True	string	Task ID
viewType	True	string	View Type

Responses

Name	Type	Description
200 OK	TaskListResponse[]	OK.Successfully retrieved the list of tasks and their properties. Media Types: "application/json", "text/json", "application/xml", "text/xml"

Examples

GetTaskPaneData

Sample Request

HTTP

POST http://<Servername>/OperationsManager/data/getTaskPane

{
  "id": "dfba68de-a600-4244-9c5f-04c1e056a037",
  "viewType": "HtmlAlertWidget"
}

Sample Response

Status code:

200

[
  {
    "displayName": "Windows Computer Tasks",
    "taskListType": "DynamicTasks",
    "taskList": [
      {
        "id": "023ee23d-db8d-9de7-1923-c0c50d66850f",
        "displayName": "Resubmit local cache state change events.",
        "description": "Submits the snapshot of instance state change events from health service local cache for repeated collection.",
        "iconUrl": "/OperationsManager/images/task/taskIcon.png",
        "targets": [
          {
            "id": "b4abc994-7f94-ef4b-9a4b-69611635f6a0",
            "name": "SCOMFBOMVM0065.smx.net",
            "runLocation": null
          }
        ],
        "parameters": []
      },
      {
        "id": "f5ea8691-50c6-3555-4166-e71120134ef7",
        "displayName": "Show Failed Rules and Monitors for this Object",
        "description": null,
        "iconUrl": "/OperationsManager/images/task/taskIcon.png",
        "targets": [
          {
            "id": "b4abc994-7f94-ef4b-9a4b-69611635f6a0",
            "name": "SCOMFBOMVM0065.smx.net",
            "runLocation": null
          }
        ],
        "parameters": []
      },
      {
        "id": "bab05472-d548-f69c-ee7d-7c51e2cc890d",
        "displayName": "Show local cache for state change events.",
        "description": "Displays the snapshot of instance state change events from health service local cache.",
        "iconUrl": "/OperationsManager/images/task/taskIcon.png",
        "targets": [
          {
            "id": "b4abc994-7f94-ef4b-9a4b-69611635f6a0",
            "name": "SCOMFBOMVM0065.smx.net",
            "runLocation": null
          }
        ],
        "parameters": []
      },
      {
        "id": "5d649d3c-7c4c-8dec-a1fd-2f5711ac7f3d",
        "displayName": "Show Running Rules and Monitors for this Object",
        "description": null,
        "iconUrl": "/OperationsManager/images/task/taskIcon.png",
        "targets": [
          {
            "id": "b4abc994-7f94-ef4b-9a4b-69611635f6a0",
            "name": "SCOMFBOMVM0065.smx.net",
            "runLocation": null
          }
        ],
        "parameters": []
      }
    ]
  }
]

Definitions

Name	Description
TaskListResponse
TaskParameter
TaskRequest
TaskResponse
TaskTarget

TaskListResponse

Name	Type	Description
displayName	string	Task Display Name
taskList	TaskResponse[]	Task lists
taskListType	string	Task List Type

TaskParameter

Name	Type	Description
defaultValue	string	Default value of task parameter
displayName	string	task parameter Display Name
id	string	id
name	string	task parameter Name
parameterType	string	task parameter type

TaskRequest

Name	Type	Description
id	string	Task ID
viewType	string	View Type

TaskResponse

Name	Type	Description
description	string	Task Description
displayName	string	Task Display Name
iconUrl	string	Icon URL
id	string	Task ID
parameters	TaskParameter[]	Task parameters
targets	TaskTarget[]	List of task targets

TaskTarget

Name	Type	Description
id	string	Task target id
name	string	Task target Name
runLocation	string	task run Location