2-5 印刷状況
印刷状況の取得
SVF Cloud WebAPIでは印刷リクエストに対して、アクションを生成し、識別するためのIDを付与します。このIDを指定して、印刷状況を取得します。
https://api.svfcloud.com/v1/actions/{actionId}GET
application/json
パスのパラメーター
パスパラメーター
値
必須
説明
actionId
アクション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」に返された値の秒数経過後に、再度実行してください。 |
{
"artifact": {
"id": "8149fed9-dadd-4678-af2d-da2ead6d656d",
"name": "WingArc",
"pages": 1,
"path": "WingArc.pdf",
"sourceType": "CSV",
"workflowId": "e892d8a3-daf2-4f78-b02f-102c59f69f05"
},
"billings": [
{
"date": "2018-03-07T02:01:50.656Z",
"idx": 1,
"pages": 1,
"payment": {
"coupon": "ec38b3b7-0c79-11e8-a7ab-06de8bf5ad36",
"date": "2018-03-07T02:01:50.656Z"
},
"plan": {
"fixed": false,
"id": "9e14438b-0c79-11e8-a7ab-06de8bf5ad36",
"name": "S",
"points": 10,
"profile": "",
"type": "DOWNLOAD"
},
"points": 10
}
],
"code": 0,
"executedTime": "2018-03-07T02:01:48.623Z",
"id": "e892d8a3-daf2-4f78-b02f-102c59f69f05",
"profile": "",
"reason": 0,
"segment": "",
"state": 2,
"stateUpdated": "2018-03-07T02:01:50.656Z",
"type": 4,
"user": {
"id": "xxxx@api.svfcloud.com",
"name": "帳票太郎"
}
}キー | 内容 | 説明 |
|---|---|---|
id | アクションID | アクションを識別するためのIDです。印刷リクエスト時に付与されます。 |
type | アクションタイプ | 要求された処理の内容を示します。「付録」の「アクションタイプ」を参照してください。 |
state | 状態 | 処理の状態を示します。「付録」の「印刷ステータス」を参照してください。 |
stateUpdated | 状態更新日時 | 状態が更新された日時です。処理状態に変化があったタイミングで更新されます。 |
code | エラーコード | エラー内容を示します。「付録」の「エラーコード」を参照してください。 |
executedTime | 実行日時 | 処理が実行された日時です。 |
artifact | 成果物情報 | 生成した成果物に関する情報です。 |
user | ユーザー情報 | 処理を実行したユーザーの情報です。 |
billings | 請求情報 | 請求に関する情報です。 |
profile | プロファイル情報 | リクエスト元に関する情報です。 |
表に記載されていないキー項目は、現在未使用です。将来使用する目的で定義しています。
また、処理の状態によって、取得できる内容に違いがあります。