2.7.3 タスクの編集
機能
指定したタスクのノートおよびTODOを編集します。
実行権限
Adminロール,Developロール,Modifyロール,Submitロール
APIのバージョン
v1
リクエスト形式
PUT http://host:port/Automation/version/objects/Tasks/id
リクエストのスキーマは,API「タスクの情報取得」のレスポンスボディーと同じ形式です。「Task」のメンバーとして指定できるオブジェクトを,次の表で説明します。
機能 |
リソース名称 |
数 |
説明 |
---|---|---|---|
タスク |
Task |
1 |
指定したIDのTaskリソース |
このオブジェクトに指定必須のプロパティについて,次に説明します。
リソース名称 |
メンバー名 |
数 |
---|---|---|
Task |
notes |
1 |
toDo |
ステータスコード
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード |
メッセージ |
説明 |
---|---|---|
200 |
OK |
成功しました。 |
400 |
Bad Request |
引数が不正です。 |
401 |
Unauthorized |
ログイン権限がありません。 |
403 |
Forbidden |
タスクを編集する権限がありません。 |
404 |
Not found |
タスクを取得する権限がありません。または,タスクがありません。 |
412 |
Precondition failed |
サーバが利用できません。 |
500 |
Server-side error |
サーバ処理エラーが発生しました。 |
レスポンスのスキーマ
リクエストに対するレスポンスボディーの構造を次に示します。
{ "instanceID" : instance-id, "name" : "task-name", "status" : "task-status", "startTime" : "start-date-and-time", "completionTime" : "completion-time", "scheduledStartTime" : "schedule-start-date-and-time", "submitter" : "submit-user-name", "submitTime" : "created-date-and-time", "modifyTime" : "updated-date-and-time", "serviceState" : "service-state", "scheduleType" : "schedule-type", "description" : "description", "serviceName" : "service-name", "tags" : "tags", "recurrenceInterval" : "recurrenceInterval", "recurrenceTime" : "recurrenceTime", "recurrenceStartDate" : "recurrenceStartDate", "serviceGroupName" : "serviceGroupName", "toDo" : {true|false}, "notes" : "notes", "stepTime" : "step-time", "serviceTemplateID" : service-template-id, "scheduleID" : schedule-id, "serviceGroupID" : service-group-id, "serviceID" : service-id, "supportedActionType" : supported-action-type }
使用例
instanceID=3042のタスクのノートおよびTODOを編集する場合の使用例を示します。
リクエストヘッダー: PUT /Automation/v1/objects/Tasks/3042 HTTP/1.1 Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: curl/7.36.0 Host: 10.196.184.182:22015 Accept: application/json Content-Type: application/json Content-Length: 666 Accept-Language: ja レスポンスヘッダー: HTTP/1.1 200 OK Date: Fri, 31 Jul 2015 03:37:03 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO 91351d8e544375a67473e7c7494d1aa7c67b24_Vlo8Y30JdDBUB3ljJSVPaRtjBSA=_V0810 Access-Control-Allow-Origin: * Access-Control-Allow-Methods: GET, POST, DELETE, PUT, HEAD, OPTIONS Access-Control-Allow-Credentials: true Cache-Control: no-cache Transfer-Encoding: chunked Content-Type: application/json レスポンスボディー: { "instanceID" : 3042, "name" : "Execute Remote Command_20150731105831", "status" : "completed", "startTime" : "2015-07-31T11:30:00.000+09:00", "completionTime" : "2015-07-31T11:30:33.000+09:00", "scheduledStartTime" : "2015-07-31T11:30:00.000+09:00", "submitter" : "System", "submitTime" : "2015-07-31T11:00:06.000+09:00", "modifyTime" : "2015-07-31T12:37:03.000+09:00", "serviceState" : "release", "scheduleType" : "schedule", "description" : "", "serviceName" : "Execute Remote Command", "tags" : "Windows,Linux,Execute Script", "serviceGroupName" : "DefaultServiceGroup", "toDo" : true, "notes" : "Notes Test", "serviceTemplateID" : 560, "scheduleID" : 3020, "serviceGroupID" : 3, "serviceID" : 2004, "supportedActionType" : "forciblyStop,retry" }* Connection #0 to host 10.196.184.182 left intact