ServiceDesk Plus Cloud ナレッジベース

過去にいただいたご質問に関して、使用例をご案内いたします。
なお、ServiceDesk Plus Cloud APIについての詳細はこちらをご参照ください。

• 使用例１：リクエストを追加したい場合
• 使用例２：リクエストを10件以上取得したい場合
• 使用例３：特定 / 複数のサイトでフィルターしてリクエストを取得したい場合
• 使用例４：期間でフィルターしてリクエストを取得したい場合
• 使用例５：リクエストにメモを追加したい場合

なお、HEADERに設定する値は以下のとおりです。

HEADERに指定する値：

application/json

application/vnd.manageengine.sdp.v3+json

<取得したAuthtoken>

使用例１：リクエストを追加したい場合

METHOD：POST

使用例：

https://sdpondemand.manageengine.com/app/itdesk/api/v3/requests?input_data={"request":{"subject":"件名","description": "説明文","requester": {"name": "依頼者名"}, "level": {"name": "レベル1"}}}

Curlを使用する場合：

curl -i -H "Accept:application/vnd.manageengine.sdp.v3+json" -H "Authorization:<取得したAuthtoken>" -d 'input_data={"request":{"subject":"件名","description":"説明文","requester":{"name":"依頼者名"}}}' https://sdpondemand.manageengine.com/app/itdesk/api/v3/requests

※「-i」オプションとあわせて実行することにより、APIの実行に成功した場合に「HTTP/1.1 201 Created」と出力されます。

※注意※

• 以下のとおり、"request":{}内に設定したいパラメーター（例：subject（リクエスト件名）, description（説明）等）を指定してください。

  input_data={"request":{
    "subject":"インターネット接続できません",
    "description": "インターネットに接続できません。ご確認のほどよろしくお願いします。",
    "requester": {"name": "依頼者名"},
    "level": {"name": "レベル3"}
  }}

• 「必須入力フィールド」が設定されている場合、当該フィールドは必ずAPI URL内で指定してください。

依頼者名に関してメモ：

• 依頼者名を指定しない場合、Authtokenを発行したユーザーが「依頼者」として自動で設定されます。
• 依頼者名がServiceDesk Plus Cloud -> [セットアップ] -> [ユーザー&許可] -> [依頼者]に存在しない場合、自動的に[依頼者]に登録されます。

ADD REQUESTのその他使用できるパラメーターは以下よりご参照ください。（米国）
https://www.manageengine.com/products/service-desk/sdpod-v3-api/SDPOD-V3-API.html#add-request

使用例２：リクエストを10件以上取得したい場合

METHOD：GET

使用例：

https://sdpondemand.manageengine.com/app/itdesk/api/v3/requests?input_data={"list_info":{"row_count":100}}${}

※注意※

• "list_info": に取得したいリクエストの件数を指定してください。（上記の場合は100件出力されます。）

GET REQUESTのその他使用できるパラメーターは以下よりご参照ください。（米国）
https://www.manageengine.com/products/service-desk/sdpod-v3-api/SDPOD-V3-API.html#get-request

使用例３：サイトでフィルターしてリクエストを取得したい場合

(1) まず、以下の手順でサイトのIDを確認します。

METHOD：GET

使用するURL：

https://sdpondemand.manageengine.com/app/itdesk/api/v3/requests/site

結果：

{"site":[
　{
　　"name": "みなとみらい",
　　"deleted": false,
　　"id": "<サイトID>"
　},
　{
　　"name": "関内",
　　"deleted": false,
　　"id": "<サイトID>"}],
（以下省略）}

(2) サイトIDを使用して、サイトでフィルターしてリクエストを取得します。

使用例：

https://sdpondemand.manageengine.com/app/itdesk/api/v3/requests/?input_data={"list_info": {"search_criteria":{"field": "site","condition": "is","values": [{"id": "<サイトID>"},{"id": "<サイトID>"}]}}}

※注意※

• "id": に取得したいサイトを指定してください。
• 特定のサイトのリクエストを取得する場合は、{"id": "<サイトID>"}のみを指定し、複数のサイトのリクエストを取得したい場合は、使用例のとおり、[,]（カンマ）で並べて実行してください。

GET REQUESTのその他使用できるパラメーターは以下よりご参照ください。（米国）

https://www.manageengine.com/products/service-desk/sdpod-v3-api/SDPOD-V3-API.html#get-request

使用例４：期間でフィルターしてリクエストを取得したい場合

METHOD：GET

使用例：

https://sdpondemand.manageengine.com/app/itdesk/api/v3/requests/?input_data={"list_info": {"search_criteria": {"field": "created_time","condition": "greater than","logical_operator": "and","value": "<開始日時>","children": [{"field":"created_time","condition":"lesser than","value":"<終了日時>"}]}}}

期間が、2018/12/1 00:00:00 - 12/31 23:59:59 の場合：

https://sdpondemand.manageengine.com/app/itdesk/api/v3/requests/?input_data={"list_info": {"search_criteria": {"field": "created_time","condition": "greater than","logical_operator": "and","value": "1543590000000","children": [{"field":"created_time","condition":"lesser than","value":"1546268399000"}]}}}

※注意※

• "value"の値には、ミリ秒単位でUNIX(エポック)時間を設定してください。

GET REQUESTのその他使用できるパラメーターは以下よりご参照ください。（米国）

https://www.manageengine.com/products/service-desk/sdpod-v3-api/SDPOD-V3-API.html#get-request

使用例５：リクエストにメモを追加したい場合

METHOD：POST

使用例：

https://sdpondemand.manageengine.com/app/itdesk/api/v3/requests/<リクエストID>/notes?input_data={"request_note":{"notify_technician":false,"show_to_requester":false,"description":"<メモに追加したい内容>"}}

※注意※

• 以下のとおり、"request_note":{}内に設定したいパラメーター（例：notify_technician（メモの追加を技術担当者にメール）, show_to_requester（依頼者にもこのメモを表示）, description（メモに追加したい内容）等）を指定してください。
• ※<リクエストID>に関しては、メモを追加したいリクエストを表示したときのURL内のwoIDになります。
  例) https://sdpondemand.manageengine.com/app/itdesk/WorkOrder.do?woMode=viewWO&woID=7326000002382001

REQUEST NOTEのその他使用できるパラメーターは以下よりご参照ください。（米国）
https://www.manageengine.com/products/service-desk/sdpod-v3-api/SDPOD-V3-API.html#request-note