お知らせAPI (/announcements)
お知らせAPIを使用して、Coupa Mobileでお知らせを検索します。
お知らせにアクセスするURLは次のとおりです。 https ://<instance>/api/announcements
詳細については、統合のベストプラクティスを参照してください。
アクション
お知らせAPIでは以下の操作が可能です。
| 動詞 | パス | アクション | Description |
|---|---|---|---|
| GET | /api/announcements | インデックス | お知らせを検索 |
| GET | /api/announcements /: id | 表示 | お知らせを表示 |
Elements
お知らせAPIでは、次の要素を使用できます。
| 要素 | Description | 必須フィールド？ | 一意？ | 許容値 | Api_Inフィールド？ | Api_Outフィールド？ | データタイプ |
|---|---|---|---|---|---|---|---|
| ID | Coupaの一意の識別子 | yes | 整数 | ||||
| 作成日時 | CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します | yes | datetime | ||||
| updated-at | CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します | yes | datetime | ||||
| subject | お知らせの件名 | yes | yes | string(255) | |||
| message | お知らせのメッセージ | yes | yes | テキスト | |||
| short-description | お知らせのショートメッセージ | yes | |||||
| announceable-type | お知らせ可能なタイプ | yes | string(255) | ||||
| announceable-id | お知らせ可能なID | yes | 整数 | ||||
| start-at | お知らせの開始日 | yes | yes | datetime | |||
| new | 新規お知らせ | yes | boolean | ||||
| created-by | 作成したユーザー | yes | |||||
| updated-by | 更新したユーザー | yes | |||||
| summary | お知らせの概要 | yes | string(255) | ||||
| Important | お知らせは重要 | yes | boolean |