Webサービスを使用する
Webサービス要求を受信するためにRICOH ProcessDirectorを準備する
Webサービス要求を実行依頼する前に、使用するWebサービスのRICOH ProcessDirectorユーザーとパスワードを作成する必要があります。Webサービスで指定される操作を行うために、RICOH ProcessDirectorでのユーザーIDの権限レベルが適切であることを確認してください。この章の例に対しては、オペレーター権限で十分です。認証のためにライトウェイトディレクトリーアクセスプロトコル（LDAP）を使用している場合は、Webサービスで使用するためにLDAP内にユーザーを作成します。LDAP ユーザーは、RICOH ProcessDirector で適切な権限レベルが与えられているグループに属している必要があります。
すべてのユーザーは最初にログインしたときにパスワードを変更する必要があるため、作成したユーザーIDでRICOH ProcessDirectorユーザーインターフェースにログインして、パスワードを変更します。指定した期間が過ぎるとパスワードが期限切れになるように設定した場合、必要に応じてログインしてこのパスワードを変更する必要があります。
Webサービス要求を準備する
要求を作成するときは、次の点に注意してください。
- Webサービスユーザーは、アクションを実行する前にログインする必要があります。
Webサービス要求を実行依頼するには、最初にGET /users/loginWebサービスを使用してWebサービスユーザーとしてRICOH ProcessDirectorにログインして、証明書トークンを受け取る必要があります。それ以降、 POST /users/logout/{name} Webサービスを実行依頼するまでのすべてのWebサービス要求のヘッダーに、そのトークンを組み込む必要があります。
- プロパティー名は、ユーザーインターフェース形式ではなく、データベース形式で記述する必要があります。
要求にプロパティー名を組み込むときは、データベースプロパティー名を使用する必要があります。例えば、GET /objects/{objectType}を使用してジョブのクラスの値を検索する場合、要求に attribute値としてJob.Classを組み込みます。データベースプロパティー名は、各プロパティーのフィールドヘルプ、製品のヘルプシステム、一部のWebサービスから受信した結果、データベースプロパティー名で使用可能です。
- プロパティー値は、ユーザーインターフェース形式ではなく、データベース形式で記述する必要があります。
照会に値を組み込むときは、それが有効な値であることを確認する必要があります。通常、数値フィールドには数値が必要で、テキストフィールドにはテキスト値が必要になります。しかし、一部のプロパティーには制限された値のリストがあります。
ドロップダウンリストが提供されるプロパティーでは、その決まった値だけを受け入れます。さらに、そのようなリストに表示される値は、データベースに保存されている値と常に同じではありません。例えば、ユーザーインターフェースで、ステープルプロパティーの値は次のとおりです。
- 2、左
- 2、右
- 左上
- 左上垂直
- 左下
- 2_at_left
- 2_at_right
- Top_left
- Top_left_vertical
- Bottom_left
Webサービス要求では、データベースの値を使用する必要があります。プロパティーのデータベース値は、製品のヘルプシステムとデータベースプロパティー名で使用可能です。
-
定位置ジョブのプロパティーには、プロパティー名の後に、フェーズ、ステップワークフローの名前をこの順序で含める必要があります。3つの名前のそれぞれを大括弧で囲みます。
このJSON文字列の例では、Linuxシステム上の制御ファイルを、PDF制御ファイルの識別のジョブプロパティー（データベース名 Job.IdentifyPDFControlFile）の値として指定しています。
"Job.IdentifyPDFControlFile[Prepare][IdentifyPDFDocuments][PullPDFSample]":"/aiw/aiw1/testfiles/PullPDF.ctl"
ジョブプロパティーは、PullPDFSampleワークフローの 準備フェーズの IdentifyPDFDocumentsステップにあります。