業務アプリの文書の登録を行うことができます。
呼び出し先URL
{your-domain} の部分をご利用の環境にあわせて変更してください。
https://{your-domain}/h2/STRAppDataRecordManipurator.doリクエスト
〇：必須△：いずれか必須
| パラメータ名 | 意味 | 必須 | 制約 |
|---|---|---|---|
func | 動作モード | 〇 | 必ず create を指定します。 |
key | WebAPIキー | 〇 | 業務アプリの文書操作APIが利用可能なWebAPIキーを指定します。 |
appId | 業務アプリID | 〇 | 文書を登録する業務アプリのIDを指定します。 業務アプリのIDは、業務アプリの編集画面で確認することができます。 |
user | 登録ユーザー | △ | 文書の登録ユーザーとなる本部ユーザーのログインIDを指定することができます。store パラメータとどちらかを指定する必要があります。 |
store | 登録店舗 | △ | 文書の登録店舗となる店舗の店舗コードもしくはFC法人の法人コードを指定することができます。user パラメータとどちらかを指定する必要があります。 |
recordStatus | 文書の状態 | 文書の状態コードを指定します。 業務アプリの雛形ごとに指定可能な状態コードは異なります。 状態コードの詳細は こちら を参照ください。 | |
content(X) | フォームに配置した部品のデータ | フォームに配置した各部品に対して設定するデータを文字列として指定することができます。 パラメータ名の X の部分は、部品番号を指定します。補足事項 ・部品のタイプによって指定する値が異なります。部品ごとに設定している文字列の長さや値の範囲などの制約チェックは行われません。 | |
attachedFile[N] | 添付ファイル | ファイル添付部品および画像部品に指定するファイルを指定します。N は整数値で、content(X)=N のように参照を content に指定します。 |
部品ごとの値の指定方法
| 部品 | 指定方法 |
|---|---|
| 文字列入力ボックス | 文字列を指定します。 値に改行コードを含めることはできません。 値の前後のスペースは削除されます。 例） content(10012)=文字列 |
| 数値入力ボックス | 数値を指定します。 例） content(10013)=1234 |
| 文章入力エリア | 文章を指定します。 値に改行コードを含めることができます。 改行コードはCRLFを利用してください。 |
| 複数選択 | キーを指定します。 複数の項目をチェックした状態にするには、パラメータ自体を複数回指定します。 例） content(10014)=A&content(10014)=B |
| 単一選択 | キーを指定します。 |
| 入力可能な単一選択 | 文字列を指定します。 |
| 日付選択 | 日付を yyyy-MM-dd 形式の文字列で指定します。例） content(10015)=2020-11-09 |
| ファイル添付 | attachedFile[N] パラメータで指定したファイルの N の部分を値として指定します。例） content(10016) に attachedFile[0] で指定したファイルを指定する場合content(10016)=0&attachedFile[0]=ファイル補足事項 添付ファイルを含むリクエストは実際にはマルチパート形式になります。 |
| 画像 | attachedFile[N] パラメータで指定したファイルの N の部分を値として指定します。例） content(10017) に attachedFile[1] で指定したファイルを指定する場合content(10017)=1&attachedFile[1]=ファイル補足事項 添付ファイルを含むリクエストは実際にはマルチパート形式になります。 |
| 店舗の選択 | 店舗コードもしくはグループコードを指定します。 補足事項 ・複数設定する場合には同一パラメータを複数回指定します。 ・選択方式を定義されたグループに設定している場合には項目IDを、全ての店舗は __$ALL（アンダーバー2つに$ALL）を、ログイン店舗の所属する全ての店舗グループは __$GROUPS（アンダーバー2つに$GROUPS）を指定します。例） content(10018)=store001&content(10018)=store002 |
| 本部ユーザーの選択 | ログインIDもしくはグループコードを指定します。 複数設定する場合には同一パラメータを複数回指定します。 選択方式を定義されたグループに設定している場合には項目IDを、全ての本部ユーザーは __$ALL（アンダーバー2つに$ALL）を、ログイン店舗の所属する店舗グループの担当ユーザーは __$AREAMANAGERS（アンダーバー2つに$AREAMANAGERS）を指定します。例） content(10019)=user001&content(10019)=user002 |
レスポンス
API の呼び出し結果は以下のスキーマの XML 文書として返されます。
<?xml version="1.0"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element name="response">
<xsd:sequence>
<xsd:element name="result" type="xsd:int" minOccurs="1" maxOccurs="1" />
<xsd:element name="record-id" type="xsd:int" minOccurs="0" maxOccurs="1"/>
<xsd:element name="errors" type="xsd:string" minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
</xsd:element>
</xsd:schema>
| 要素 | 意味 | 備考 |
|---|---|---|
//response/result | リザルトコード | 以下の値をとります。1: 成功4: 入力パラメータの内容にエラーがある8: その他のシステムエラーが発生 |
//response/record-id | 文書番号 | 文書の登録に成功した場合は、登録された文書番号が返されます。 文書番号は32ビット整数値の範囲内の値を取ります。 |
//response/errors | エラーメッセージ | エラーが発生した場合は、詳細なエラーメッセージが文字列として返されます。 |
登録操作に成功した場合のレスポンスXMLの例
<response>
<result>1</result>
<record-id>736</record-id>
</response>
上の例では、//response/result の値が 1 なので呼び出しは成功しており、//response/record-id に登録された業務アプリの文書番号が返されます。
登録操作に失敗した場合のレスポンスXMLの例
<response>
<result>4</result>
<errors><![CDATA[
* attachedFile[1] is not set. It is required for content(10017).
]]></errors>
</response>
上の例では、//response/result の値が 4 なので呼び出しは失敗しています。//response/errors に、content(10017) に指定するファイルが attachedFile[1] にセットされていない旨のエラーメッセージが返されます。