全文検索
単一または複数のビジネス オブジェクト内のキーワードに基づいて検索を実行します。
単一のビジネスオブジェクトで検索
定義された特定の単一のビジネス オブジェクト内で検索を実行します。
インシデント ビジネス オブジェクト内の検索キーワードに基づいて検索を実行する例を次に示します。
メールアドレス | https://{tenant url}/api/rest/search/fulltext |
|---|---|
方法 | 役職 |
ヘッダー名 | 認証: JWT トークン/セッション キー/REST API キー |
ステータスコード | 200 |
リクエストペイロード | { 「テキスト」:「プリンター」、 「オブジェクトタイプ」:「インシデント」、 「トップ」:20, 「スキップ」: 20 } |
レスポンスペイロード | { "data": [ { "IncidentNumber": 10005, 「件名」:「ユーザーのデスクの近くにあるプリンターは小さく、非常に暑いようです。」 "RecId": "DAB00E0C24454B07B0A355420D6B0E1C" }, { "IncidentNumber": 10021, 「件名」:「ユーザーのデスクの近くにあるプリンターは小さく、非常に暑いようです。」 "RecId": "EFAA6661BB3E49DEB14A1AEB50B9BECB" }, { "IncidentNumber": 10081, 「件名」: 「プリンターにラベルが詰まっています。」 "RecId": "D9C47BB249B7443C866EB9E7939ECA54" }, { "IncidentNumber": 10155, 「件名」: 「プリンターにラベルが詰まっています。」 "RecId": "45CFEE518CD74E2CAC59A5D94ABBC008" }, { "IncidentNumber": 10205, 「件名」:「人事部のプリンタ設定を確認する」 "RecId": "81DEE4064D84437CA902F00B4879A81F" } ], 「メタデータ」: [ { "FieldRef": "IncidentNumber", "DisplayName": "インシデント ID", "DataType": 6 }, { "FieldRef": "Subject", "DisplayName": "概要", "DataType": 1 }, { "FieldRef": "RecId", "表示名": "受信ID", "DataType": 4 } ], "合計行数": 20, "keyRef": "受信ID", "searchText": "プリンター" } |
失敗した応答 - 単一のビジネス オブジェクトで検索
シナリオ: 検索キーワードを入力せずに検索を実行します。
https://{tenant url}/api/rest/search/fulltext
ヘッダー名:
認証: セッションキー
コード | ISM_4000 |
|---|---|
説明 | 要求の形式が正しくありません |
メッセージ | 「検索キーワードは空白にできません。キーワードを入力してもう一度お試しください。」 |
HTTP ステータス コード | 400 |
シナリオ: リクエスト本文でビジネス オブジェクト タイプを定義せずに検索を実行します。
https://{tenant url}/api/rest/search/fulltext
ヘッダー名:
認証: セッションキー
コード | ISM_4000 |
|---|---|
説明 | 要求の形式が正しくありません |
メッセージ | 「ObjectType は空白にできません。 ビジネスオブジェクトを入力してください ObjectType フィールドに名前を入力して、もう一度試してください。 |
HTTP ステータス コード | 400 |
複数のビジネスオブジェクトを検索
複数のビジネス オブジェクトで検索を実行します。
検索が実行されるビジネス オブジェクトは、検索構成に基づきます。
複数のビジネス オブジェクトで検索を実行する例を次に示します。
メールアドレス | https://{tenant url}/api/rest/Search |
|---|---|
方法 | 役職 |
ヘッダー名 | 認証: セッションキー/REST API キー |
ステータスコード | 200 |
リクエストペイロード | { "テキスト":"電話" } |
レスポンスペイロード | { "Items": [ { "title": "デスクの電話や携帯電話からボイスメールにアクセスするにはどうすればいいですか?" "description": "自分の Cisco 電話からアクセスしています: \r\n1790 にダイヤルしてください (または7940モデルの場合は封筒ボタンを押してください)\r\n PINに続けて#を入力してください\r\nメッセージの聞き取りを開始するには\r\n0を押して戻ります メインメニューでさらにオプションを表示します。例: 2を押すと挨拶を録音できます 願い"、 "tableRef": "よくある質問 "オブジェクトID": "70AEE924D22D487CB99D02B0DE090305", "formName": "FAQ.Brief", "objectType": "よくある質問", "createdDateTime": "May 9, 2007", 「スコア」: null、 "行数": 3, "<Category>k__BackingField": null }, { "title": "ネットワークメンテナンス", 「説明」: 「すべてのルーターに対して定期メンテナンスが実行されます APAC 地域向け。 電話、インターネット、電子メールを含むすべてのネットワークアクセス 2007年11月2日から2007年11月3日までの週末は休止し、再開します。 11/4/2007.", "tableRef": "お知らせ "オブジェクトID": "BD9FE5ABB34D480ABFADBC29E018F2A2", "formName": "Announcement.Brief", "objectType": "アナウンス", "createdDateTime": "May 15, 2007", 「スコア」: null、 "行数": 3, "<Category>k__BackingField": null } ], 「合計レコード数」: 2, "ErrorMessage": null } |
失敗した応答 - 複数のビジネス オブジェクトで検索
シナリオ: 検索キーワードを入力せずに検索を実行します。
https://{tenant url}/api/rest/Search
ヘッダー名:
認証: セッションキー
コード | ISM_4000 |
|---|---|
説明 | 要求の形式が正しくありません |
メッセージ | 「検索キーワードは空白にできません。キーワードを入力してもう一度お試しください。」 |
HTTP ステータス コード | 400 |
