業務アプリの文書の削除を行うことができます。
呼び出しURL
{your-domain} の部分をご利用の環境にあわせて変更してください。
https://{your-domain}/h2/STRAppDataRecordManipurator.doリクエスト
| パラメータ | 意味 | 必須 | 制約 |
|---|---|---|---|
func | 動作モード | 〇 | 必ず delete を指定します。 |
key | WebAPIキー | 〇 | 業務アプリの文書操作APIが利用可能なWebAPIキーを指定します。 |
appId | 業務アプリID | 〇 | 文書を削除する業務アプリのIDを指定します。 業務アプリのIDは、業務アプリの編集画面で確認することができます。 |
recordId | 文書番号 | 〇 | 削除する文書の文書番号を指定します。 |
レスポンス
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="errors" type="xsd:string" minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
</xsd:element>
</xsd:schema>
| 要素 | 意味 | 備考 |
|---|---|---|
//response/result | リザルトコード | 以下の値をとります。1: 成功4: 入力パラメータの内容にエラーがある8: その他のシステムエラーが発生 |
//response/errors | エラーメッセージ | エラーが発生した場合は、詳細なエラーメッセージが文字列として返されます。 |
削除操作に成功した場合のレスポンスXMLの例
<response>
<result>1</result>
</response>
上の例では、//response/result の値が 1 なので呼び出しは成功しています。
削除操作に失敗した場合のレスポンスXMLの例
<response>
<result>4</result>
<errors><![CDATA[
* appId is invalid.
]]></errors>
</response>
上の例では、//response/result の値が 4 なので呼び出しは失敗しています。//response/errors に業務アプリIDが正しくない旨のエラーメッセージが返されます。