2-3 プリンター操作
プリンター一覧の取得
プリンター一覧を取得します。
https://api.svfcloud.com/v1/printers
GET
application/json
クエリーパラメーター
クエリーパラメーター
値
必須
説明
registerable
登録可能なプリンター（true or false）
デフォルトでは、登録済みのプリンター一覧を取得します。
true
未登録のプリンター一覧を取得します。
false
登録済みのプリンター一覧を取得します。
agent
エージェントID
特定のエージェント配下のプリンターを列挙する場合に指定します。
リクエストヘッダー
ヘッダーフィールド
値
説明
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」に返された値の秒数経過後に、再度実行してください。 |
[
{
"id":"1a103817-d55a-46a9-8364-bc534b8aa933",
"segment":"",
"key":"23759108FCDD2B93EE4353105F69937B9CF8B44C",
"stateUpdated":"2015-10-02T09:32:41.000Z",
"name":"LBP8730",
"label": "TestPrinter_Canon",
"manufacturer":"Canon",
"reachable":true,
"ipAddress":"10.XX.XX.XX",
"description":"Canon LBP8730 /P",
"pdlList":[
"ESCP",
"LIPS4",
"PDF"
],
"preferences":[
],
"state":2
},
{
"id":"587d2416-94a6-4af3-a4ca-8f637bc75fe1",
"segment":"",
"key":"ED7054AB697F38EE330C9AE5F613DAD6AD1ED5A3",
"stateUpdated":"2015-10-03T17:29:27.000Z",
"name":"DocuCentre-IV C2270",
"label": "TestPrinter_FUJI",
"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"
],
"preferences":[
{
"id":"587d2416-94a6-4af3-a4ca-8f637bc75fe1",
"name":"art4_1",
"manufacturer":"FUJI XEROX",
"lastmodified":"2015-10-02T07:54:59.000Z",
"pdl":"ART4",
"description":"",
"properties":[
{
"name":"AdjustX",
"labelKey":"",
"value":"10.0",
"readOnly":false,
"hidden":false
},
{
"name":"AdjustY",
"labelKey":"",
"value":"10.0",
"readOnly":false,
"hidden":false
}
]
}
],
"state":12,
"localPrinter":{
"name":"FX DocuCentre-IV C2270",
"platform":"Windows",
"manufacturer":"Fuji Xerox",
"driverName":"FX DocuCentre-IV C2270",
"paused":false
"inputTrays":["プリンタの設定に従う","自動","トレイ1","トレイ2","トレイ3","トレイ4","トレイ5(手差し)"]
}
}
]キー | 内容 | 説明 |
|---|---|---|
id | プリンターIDまたはエージェントID | registerableパラメーターが「true」の場合は、エージェントを識別するためのIDになります。registerableパラメーターが「false」の場合は、プリンターを識別するためのIDになります。ダイレクトプリントを実行する際は、このプリンターIDを指定します。 |
key | プリンターキー | プリンター（実機）を管理する上で付与された一意のキーです。 |
stateUpdated | 状態更新日時 | 状態が更新された日時です。プリンターの状態を定期監視しているため、監視間隔に応じて状態に変化があったタイミングで更新されます。 |
name | プリンター名 | プリンターから取得したプリンター名です。 |
label | プリンターラベル | プリンターごとに任意に設定されたラベルです。設定は、SVF Cloud Managerの［プリンター］画面からできます。 |
manufacturer | 製造者 | プリンターから取得したメーカー情報です。 |
reachable | ネットワーク接続可否 | プリンターがネットワーク越しに接続できる状態かどうかを示します。USB接続の場合は「false」になります。 |
ipAddress | IPアドレス | プリンターのIPアドレスです。 |
description | 備考 | プリンターから取得した備考情報です。 |
pdlList | PDLリスト | プリンターから取得したPDL情報です。 |
preferences | 印刷設定 | プリンターに定義された印刷設定の情報です。 |
state | 状態 | プリンターの状態を示します。詳細は「付録」の「プリンターステータス」を参照してください。 |
localPrinter | ローカルプリンター情報 | ローカルプリンターに関する情報です。 |
inputTrays | 給紙トレイ情報 | プリンターから取得した給紙トレイ情報です。 |
表に記載されていないキー項目は、現在未使用です。将来使用する目的で定義しています。
プリンターの登録
指定したプリンターキーのプリンターを登録します。
https://api.svfcloud.com/v1/printers
POST
application/x-www-form-urlencoded
リクエストボディ
リクエストボディのデータ
値
必須
説明
key
プリンターキー
仮登録状態のプリンター一覧から登録するプリンターのキーを指定します。
リクエストヘッダー
ヘッダーフィールド
値
説明
Authorization
Bearer {your access token}
認証で取得したアクセストークンを指定します。
レスポンス
コード | 説明 |
|---|---|
HTTP/1.1 201 Created | 正常にプリンターが登録されたことを意味します。レスポンスヘッダーの「Location」に登録したプリンター情報を問い合わせるURIが返されます。「Location」の形式は次のとおりです。 https://api.svfcloud.com/v1/printers/{printerId} |
HTTP/1.1 400 Bad Request | リクエスト内容が不正な場合に発生します。 |
HTTP/1.1 401 Unauthorized | 認証情報が不正な場合に発生します。 |
HTTP/1.1 404 Not Found | 指定されたキーが存在しない場合に発生します。 |
HTTP/1.1 409 Conflict | すでに登録済みのプリンターを登録しようとした（二重登録）場合に発生します。 |
HTTP/1.1 429 Too many Requests | APIコール数が閾値を超えた場合に発生します。レスポンスヘッダーの「Retry-After」に返された値の秒数経過後に、再度実行してください。 |
プリンター情報の取得
指定したプリンターIDの情報を取得します。
https://api.svfcloud.com/v1/printers/{printerId}GET
application/json
パスのパラメーター
パスパラメーター
値
必須
説明
printerId
プリンターID
情報を取得するプリンターの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」に返された値の秒数経過後に、再度実行してください。 |
{
"id":"1aaf7a8e-f805-428b-86a2-1dab0b7e9aab",
"segment":"",
"key":"02F557B32F6C6DCE5182473E94B7104B759B3871",
"stateUpdated":"2015-10-01T11:44:10.000Z",
"name":"IPSiO CX7200",
"label": "TestPrinter_RICOH",
"manufacturer":"RICOH",
"reachable":true,
"ipAddress":"10.XX.XX.XX",
"description":"RICOH IPSiO CX7200 1.12 / RICOH Network Printer C model",
"pdlList":[
"RPCS",
],
"preferences":[
],
"state":2
}キー | 内容 | 説明 |
|---|---|---|
id | プリンターID | プリンターを識別するためのIDです。印刷実行時、印刷先となるプリンターを指定する場合は、このプリンターIDを指定します。 |
key | プリンターキー | プリンター（実機）を管理する上で付与された一意のキーです。 |
stateUpdated | 状態更新日時 | 状態が更新された日時です。プリンターの状態を定期監視しているため、監視間隔に応じて状態に変化があったタイミングで更新されます。 |
name | プリンター名 | プリンターから取得したプリンター名です。 |
label | プリンターラベル | プリンターごとに任意に設定されたラベルです。設定は、SVF Cloud Managerの［プリンター］画面からできます。 |
manufacturer | 製造者 | プリンターから取得したメーカー情報です。 |
reachable | ネットワーク接続可否 | プリンターがネットワーク越しに接続できる状態かどうかを示します。USB接続の場合は「false」になります。 |
ipAddress | IPアドレス | プリンターのIPアドレスです。 |
description | 備考 | プリンターから取得した備考情報です。 |
pdlList | PDLリスト | プリンターから取得したPDL情報です。 |
preferences | 印刷設定 | プリンターに定義された印刷設定の情報です。 |
state | 状態 | プリンターの状態を示します。詳細は「付録」の「プリンターステータス」を参照してください。 |
localPrinter | ローカルプリンター情報 | ローカルプリンターに関する情報です。 |
表に記載されていないキー項目は、現在未使用です。将来使用する目的で定義しています。
プリンターの登録解除
指定したプリンターIDのプリンターの登録を解除します。
https://api.svfcloud.com/v1/printers/{printerId}DELETE
パスのパラメーター
パスパラメーター
値
必須
説明
printerId
プリンターID
登録を解除するプリンターの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」に返された値の秒数経過後に、再度実行してください。 |