契約テンプレートAPI (/ contracts/templates)
システムは、契約テンプレートAPIを使用して、インデックスを取得したり、個々の契約テンプレート定義を取得したりできます。
契約テンプレート管理をサポートするため、契約テンプレートをコンテンツグループに割り当てることで、契約テンプレートへのアクセスを制限できるようになりました。契約テンプレートAPIを使用すると、システムがそれらを取得できます。
契約テンプレートにアクセスするためのURLは次のとおりです。https ://<instance>/api/contracts/templates
詳細については、統合のベストプラクティスを参照してください。
アクション
Contract Template APIを使用すると、次のことができます。
| 動詞 | パス | アクション | 説明 |
|---|---|---|---|
| 取得 | /api/contracts/templates |
index | Query contract templates |
| 取得 | /api/contracts/templates /: id |
表示 | 契約テンプレートを表示 |
要素
次の要素は、契約テンプレートAPIで使用できます。
| 要素 | 説明 | 必須フィールドですか？ | 一意ですか？ | 許容値 | Api_Inフィールド？ | Api_Outフィールド？ | データタイプ |
|---|---|---|---|---|---|---|---|
| 有効 | テンプレートは有効です | no | no | any | はい | はい | boolean |
| authoring - method | オーサリング方法 | msword, msword_and_online |
はい | はい | string (255) | ||
| content - groups | ビジネスグループ | はい | はい | コンテンツグループ | |||
| contract - classification | 契約の分類 | はい | |||||
| created - at | CoupaがYYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました | はい | 日時 | ||||
| created - by | 作成したユーザー | はい | ユーザー | ||||
| 説明 | 説明 | はい | はい | string (255) | |||
| fill - with - counterparty | 取引先を入力 | はい | はい | boolean | |||
| hierarchy - type | 階層タイプ | はい | string (255) | ||||
| iD | Coupaの一意の識別子 | はい | 整数 | ||||
| 名前 | 名前 | はい | はい | はい | string (255) | ||
| template - generator - id | テンプレートジェネレータID | はい | はい | string (1024) | |||
| updated - at | CoupaがYYY - MM - DDTHH: MM: SS + HH: MMZの形式で自動的に作成しました | はい | 日時 | ||||
| 更新者： | 更新したユーザー | はい | ユーザー | ||||
| template_generator_type | テンプレートジェネレータTypetemplate_generator_type | はい | 整数 | ||||
| supporting_document | サポート文書SUPPORTING_DOCUMENT | はい | boolean | ||||
| ソース | 契約テンプレートソースの識別子 | はい | string (255) | ||||
| contract_types | 契約タイプ | はい | はい | ContractType | |||
| contract_hierarchy_types | 契約ヒエラルキータイプ | はい | はい | ContractHierarchyType | |||