ドキュメント

ドキュメントを追加する

ドキュメントを、そのオプションのメタデータとオプションのサムネイルとともに追加する。 DocumentGUID はレスポンスで返される。
 
のURLです。
POST http://api.aurelon.com/api/v2/document
 
リクエストヘッダ。
コンテンツ-タイプ : multipart/form-data
MisKey : 認証を見る
HardwareHash : 認証参照
シリアルナンバー : 認証参照
アプリケーションバージョン : 認証参照
 
リクエストの本文です。
フォームデータ1:必須

    • 名前JsonString
    • Content-Type: application/json
  • を含むJSONオブジェクト。
  • DocumentGUID – オプション – ドキュメントGUID。指定すると、このGUIDが使用され、もしそれが存在すれば、同じドキュメントの新しいリビジョンが追加され、最新になります。
    • 名称– 必須 – ドキュメント名
  • Type – 必須 – ドキュメントのコンテンツタイプ
  • Meta – ドキュメントに関するメタデータを含む JSON オブジェクト
  • Dimensions – ドキュメントのサイズ(単位)

 
 
フォームデータ2:オプション

    • 名前原稿の原画名
    • Content-Type: application/octet-stream
  • ドキュメントのバイナリコンテンツ

 
フォームデータ3:オプション

    • 名前Thumbnail.png
    • Content-Type: image/png
  • 文書サムネイルのバイナリコンテンツ

 
対応する。
操作の結果を含むコンテンツタイプapplication/json。
 
成功です。

  • 200 OK : {“Message”:”Document successfully saved”, “DocumentGUID”:”00000000-0000-0000-0000-000000000000″}

 
エラーです。

  • 401 認証されていません。 {“Message”: “Invalid HardwareHash”}.
  • 401 認証されていません。 {メッセージ”: “Invalid MisKey” }.
  • 415 サポートされていないメディアタイプ : {“Message”: “This request is not properly formatted”}.
  • 401 認証されていません。 {“Message”:””MisKey” または “HardwareHash”, “SerialNumber” および “ApplicationVersion” ヘッダが必要です”}。
  • 500 Internal Server Error(内部サーバーエラー): {メッセージ”: “内部サーバーエラー”}。

 

ドキュメント一覧の取得

組織内の全文書のフィルタリングされたリストを取得する
 
のURLです。
POST http://api.aurelon.com/api/v2/document/list
 
リクエストヘッダ。
コンテンツ-タイプ : application/json
MisKey : 認証を見る
HardwareHash : 認証参照
シリアルナンバー : 認証参照
アプリケーションバージョン : 認証参照
 
リクエストの本文です。
以下のフィルタを1つ以上含むJSONオブジェクト。

  • シリアルナンバー
  • 仕事
  • ジョブガイド
  • デバイス
  • デバイスGUID
  • メディアタイプ
  • メディアサイズ
  • キュー
  • ユーザー
  • プロデューサー
  • StatusList – 以下のステータスを持つ配列 (エラー, 待機中, インプログレス, 完成品, キャンセル, 削除済み, PrintRequest, NotSupported).

ここで、以下のステータスは、アクティブなジョブと完了したジョブを区別するものです。

  • アクティブジョブ(エラー、待機中、進行中、キャンセル、PrintRequest、NotSupportedの各状態)
  • 完了ジョブ (完了、削除)

 
元です。
{SerialNumber”: 336484, “StatusList”:[“Waiting”, “Error”], “Producer”: “Editor”}.
 
対応する。
リクエストボディでフィルタリングされた企業の求人情報を返します。
 
成功です。

  • 200 OK : ジョブリストを返す

[{
“DocumentGUID”。”3dfd53fd-2d6b-11e6-853c-793ef2c92c66”,
“ドキュメント”:”Ducky.tif”。
“Jobs “です。[
“29F9ED80-F45D-4A2B-B067-BDD638D1E6FD”,
“29680F35-4C41-4025-8915-3C688DABD456”
],
“Devices”(デバイス)。[
“03ca4950-0f14-4e58-9bf9-a036c2e1b316”,
“0cc6bcfe-8ada-4c4a-852a-952d720d3b51”
],
“メディア”。[ロール10インチ”, “ロール17インチ”],
“MediaType “です。[セミマット 250g/m2]。
“Queue “です。[ “ad3afa36-bf8b-4ae7-9553-206a0ad339b8” ]となります。
“Status”(状態)。”InProgress”(進行中)。
“ユーザー “です。[“wendell.lucas”],
“プロデューサー””Hotfolder”(ホットフォルダー)。
“プログレス “です。70
}, {
“DocumentGUID”:”a7dcef15-7283-4eb1-ac96-94a6d5e859bd”,
“ドキュメント”:”Lemonade.jpg”。
“Jobs “です。[
“65eec7e8-c05b-429c-8b8a-8ce16fc55010”,
“d43e9158-39c1-46b9-98b3-3418126e5255”
}],
“メディア”。[100インチロール」]。
“MediaType “になります。[“Paper 250g 09.05.2016”] となります。
“キュー “です。[],
“ステータス”:”完了”,
“ユーザー “です。[“julia.bailey”],
“プロデューサー “です。”レイアウト “です。
“プログレス “です。0
}]
 
エラーです。

  • 401 認証されていません。 {“Message”: “Invalid HardwareHash”}.
  • 401 認証されていません。 {メッセージ”: “Invalid MisKey” }.
  • 401 認証されていません。 {“Message”:””MisKey” または “HardwareHash”, “SerialNumber” および “ApplicationVersion” ヘッダが必要です”}。
  • 400 Bad Request(不正なリクエスト) : {“Message”:””DocumentGUID” value required”}.
  • 415 非対応のメディアタイプ : {“Message”: “Expected type: application/json”}.
  • 500 Internal Server Error(内部サーバーエラー): {メッセージ”: “内部サーバーエラー”}。

ドキュメントのサムネイルを設定する

既存文書のサムネイルを追加・差し替え。 サムネイルは、RGBまたはRGBAのPNGである必要があります。
 
のURLです。
POST:http://api.aurelon.com/api/v2/document/thumbnail
 
リクエストヘッダ。
コンテンツ-タイプ : multipart/form-data
MisKey : 認証を見る
HardwareHash : 認証参照
シリアルナンバー : 認証参照
アプリケーションバージョン : 認証参照
 
リクエストの本文です。
フォームデータ1:必須

  • 名前JsonString
  • Content-Type: application/json
  • を含むJSONオブジェクト。
  • ドキュメントGUID– 必須 – ドキュメントGUID
  • ページ番号 1 から page までの整数値で、サムネイルが属するドキュメントのページ数を表します。

 
元です。
{“DocumentGUID”:”00092EA6-fb01-11e5-9b85-793ef2c92c66″,”PageNumber”:1}
フォームデータ2:必須

  • 名前Thumbnail.png
  • Content-Type: image/png
  • PNGのバイナリコンテンツ

 
対応する。
操作の結果を含むコンテンツタイプapplication/json。
 
成功です。

  • 200 OK : {メッセージ”: “文書のサムネイルが正常に保存されました”}。

 
エラーです。

  • 401 認証されていません。 {“Message”: “Invalid HardwareHash”}.
  • 401 認証されていません。 {メッセージ”: “Invalid MisKey” }.
  • 404 Not Found : {“Message”: “DocumentGUID is not found”}.
  • 415 サポートされていないメディアタイプ : {“Message”: “This request is not properly formatted”}.
  • 401 認証されていません。 {“Message”:””MisKey” または “HardwareHash”, “SerialNumber” および “ApplicationVersion” ヘッダが必要です”}。
  • 400 Bad Request(不正なリクエスト) : {“Message”:””DocumentGUID” value required”}.
  • 500 Internal Server Error(内部サーバーエラー): {メッセージ”: “内部サーバーエラー”}。

 

ドキュメントサムネイル取得

ドキュメントのページのサムネイルを取得する
 
のURLです。
GET http://api.aurelon.com/api/v2/document/<DocumentGUID>/thumbnail/<PageNumber>
 
リクエストヘッダ。
MisKey : 認証を見る
HardwareHash : 認証参照
シリアルナンバー : 認証参照
アプリケーションバージョン : 認証参照
 
対応する。
コンテンツタイプはimage/pngで、ページサムネイルのPNGが含まれます。 または、エラーの内容を含む場合のコンテンツタイプはapplication/jsonです。
 
成功です。

  • 200 OK : ドキュメントページPNGサムネイル

 
エラーです。

  • 401 認証されていません。 {“Message”: “Invalid HardwareHash”}.
  • 401 認証されていません。 {メッセージ”: “Invalid MisKey” }.
  • 404 Not Found : {“Message”: “DocumentGUID is not found”}.
  • 400 Bad Request(不正なリクエスト): {“Message”: “PageNumber is not found”}.
  • 401 認証されていません。 {“Message”:””MisKey” または “HardwareHash”, “SerialNumber” および “ApplicationVersion” ヘッダが必要です”}。
  • 500 Internal Server Error(内部サーバーエラー): {メッセージ”: “内部サーバーエラー”}。
Updated on 5月 10, 2022

Was this article helpful?