Skip to main content

2-4　エージェント操作

エージェント一覧の取得

エージェントの一覧を取得します。

例 1. エンドポイントのURI
https://api.svfcloud.com/v1/agents


例 2. HTTPメソッド

GET



例 3. HTTPリクエストのAcceptヘッダー

application/json



例 4. パラメーター

  • クエリーパラメーター

    クエリーパラメーター

    値

    必須

    説明

    name

    エージェント名

    情報を取得するエージェント名を指定します。

  • リクエストヘッダー

    ヘッダーフィールド

    値

    説明

    Authorization

    Bearer {your access token}

    認証で取得したアクセストークンを指定します。



レスポンス

コード

説明

HTTP/1.1 200 OK

正常に処理が実行されたことを意味します。

HTTP/1.1 400 Bad Request

リクエスト内容が不正な場合に発生します。

HTTP/1.1 401 Unauthorized

認証情報が不正な場合に発生します。

HTTP/1.1 429 Too many Requests

APIコール数が閾値を超えた場合に発生します。レスポンスヘッダーの「Retry-After」に返された値の秒数経過後に、再度実行してください。

例 5. 出力例（JSON形式）
[
　{
　　"id":"8f885615-72dd-4166-af30-310585f1de45",
　　"segment":"",
　　"name":"東京営業所",
　　"platform":"OS X",
　　"ipAddress":"10.XX.XX.XX",
　　"maxSize":0,
　　"lastModified":"2015-12-11T11:34:30.000Z",
　　"search":{
　　　"interval":5,
　　　"local":true,
　　　"broadcast":false,
　　　"addresses":
　　　　[
　　　　]
　　},
　　"printers":[
　　　{
　　　　"id":"41137e28-6e69-4e82-9279-1221d594353",
　　　　"key":"32C44176298E06C83D541F142E383A96A8734861",
　　　　"stateUpdated":"2015-10-01T09:12:32.000Z",
　　　　"name":"10.XX.XX.XX",
　　　　"manufacturer":"Unknown",
　　　　"reachable":false,
　　　　"description":"10.XX.XX.XX",
　　　　"pdlList":[
　　　　　"PDF",
　　　　　"POSTSCRIPT"
　　　　],
　　　　"segment":"",
　　　　"state":0,
　　　　"localPrinter":{
　　　　　"name":"10.XX.XX.XX","platform":"OS X","paused":false}
　　　　}
　　]
　},
　{
　　"id":"c8ddaafd-d563-4841-9908-13042d5afe53",
　　"segment":"",
　　"name":"大阪営業所",
　　"platform":"Windows",
　　"ipAddress":"10.XX.XX.XX",
　　"maxSize":0,
　　"lastModified":"2015-12-11T11:34:30.000Z",
　　"search":{
　　　"interval":5,
　　　"local":true,
　　　"broadcast":false,
　　　"addresses":[
　　　　]
　　},
　　"printers":[
　　　{
　　　　"id":"c8ddaafd-d563-4841-9908-13042d5afe53",
　　　　"key":"ED7054AB697F38EE330C9AE5F613DAD6AD1ED5A3",
　　　　"stateUpdated":"2015-10-02T08:34:02.000Z",
　　　　"name":"DocuCentre-IV C2270",
　　　　"manufacturer":"FUJI XEROX",
　　　　"reachable":true,
　　　　"ipAddress":"10.XX.XX.XX",
　　　　"description":"FUJI XEROX DocuCentre-IV C2270;ESS1.0.42,IOT 41.3.0,IIT 2.21.1,ADF 7.9.0,FAX 1.1.14,SJFI3.0.13,SSMI1.12.3",
　　　　"pdlList":[
　　　　　"ART4",
　　　　　"EMF",
　　　　　"ESCP",
　　　　　"PDF"
　　　　],
　　　　"segment":"",
　　　　"state":12,
　　　　"localPrinter":{
　　　　　"name":"FX DocuCentre-IV C2270",
　　　　　"platform":"Windows",
　　　　　"manufacturer":"Fuji Xerox",
　　　　　"driverName":"FX DocuCentre-IV C2270",
　　　　　"paused":false
　　　　}
　　　}
　　]
　}
]

キー

内容

説明

id

エージェントID

エージェントを識別するためのIDです。

name

エージェント名

SVF Cloud Agent設定画面で設定したエージェント名です。

platform

プラットフォーム

エージェントが動作しているプラットフォームに関する情報です。

ipAddress

IPアドレス

エージェントのIPアドレスです。

lastModified

最終更新日時

エージェントが状態通知した際に更新される日時です。

search

プリンター検索情報

エージェントがプリンターを検索する際に使用する定義情報です。

printers

プリンター情報

エージェントが保持しているプリンターリストです。

  • 表に記載されていないキー項目は、現在未使用です。将来使用する目的で定義しています。



エージェント情報の取得

指定したエージェントの情報を取得します。

例 6. エンドポイントのURI
https://api.svfcloud.com/v1/agents/{agentId}


例 7. HTTPメソッド

GET



例 8. HTTPリクエストのAcceptヘッダー

application/json



例 9. パラメーター

  • パスのパラメーター

    パスパラメーター

    値

    必須

    説明

    agentId

    エージェントID

    maru.png

    情報を取得するエージェントのIDを指定します。

  • リクエストヘッダー

    ヘッダーフィールド

    値

    説明

    Authorization

    Bearer {your access token}

    認証で取得したアクセストークンを指定します。



レスポンス

コード

説明

HTTP/1.1 200 OK

正常に処理が実行されたことを意味します。

HTTP/1.1 401 Unauthorized

認証情報が不正な場合に発生します。

HTTP/1.1 404 Not Found

指定されたIDのエージェントが存在しない場合に発生します。

HTTP/1.1 429 Too many Requests

APIコール数が閾値を超えた場合に発生します。レスポンスヘッダーの「Retry-After」に返された値の秒数経過後に、再度実行してください。

例 10. 出力例（JSON形式）
{
　"id":"8f885615-72dd-4166-af30-310585f1de45",
　"segment":"",
　"name":"東京営業所",
　"platform":"OS X",
　"ipAddress":"10.XX.XX.XX",
　"maxSize":0,
　"lastModified":"2015-12-11T11:34:30.000Z",
　"search":{
　　"interval":5,
　　"local":true,
　　"broadcast":false,
　　"addresses":[
　　]
　},
　"printers":[
　　{
　　　"id":"41137e28-6e69-4e82-9279-1221d594353",
　　　"key":"32C44176298E06C83D541F142E383A96A8734861",
　　　"stateUpdated":"2015-10-01T09:12:32.000Z",
　　　"name":"10.XX.XX.XX",
　　　"manufacturer":"Unknown",
　　　"reachable":false,
　　　"description":"10.XX.XX.XX",
　　　"pdlList":[
　　　　"PDF",
　　　　"POSTSCRIPT"
　　　],
　　　"segment":"",
　　　"state":0,
　　　"localPrinter":{
　　　　"name":"10.XX.XX.XX",
　　　　"platform":"OS X",
　　　　"paused":false
　　　}
　　}
　]
}

キー

内容

説明

id

エージェントID

エージェントを識別するためのIDです。

name

エージェント名

SVF Cloud Agent設定画面で設定したエージェント名です。

platform

プラットフォーム

エージェントが動作しているプラットフォームに関する情報です。

ipAddress

IPアドレス

エージェントのIPアドレスです。

lastModified

最終更新日時

エージェントが状態通知した際に更新される日時です。

search

プリンター検索情報

エージェントがプリンターを検索する際に使用する定義情報です。

printers

プリンター情報

エージェントが保持しているプリンターリストです。

  • 表に記載されていないキー項目は、現在未使用です。将来使用する目的で定義しています。



エージェントの削除

指定したエージェントを削除します。

例 11. エンドポイントのURI
https://api.svfcloud.com/v1/agents/{agentId}


例 12. HTTPメソッド

DELETE



例 13. パラメーター

  • パスのパラメーター

    パスパラメーター

    値

    必須

    説明

    agentId

    エージェントID

    maru.png

    削除するエージェントのIDを指定します。

  • リクエストヘッダー

    ヘッダーフィールド

    値

    説明

    Authorization

    Bearer {your access token}

    認証で取得したアクセストークンを指定します。



レスポンス

コード

説明

HTTP/1.1 204 No Content

正常に処理が実行されたことを意味します。

HTTP/1.1 401 Unauthorized

認証情報が不正な場合に発生します。

HTTP/1.1 429 Too many Requests

APIコール数が閾値を超えた場合に発生します。レスポンスヘッダーの「Retry-After」に返された値の秒数経過後に、再度実行してください。

: