テナント操作用API 一覧
RESTful インタラクション
read
GET [base]/admin/Organization/[id] {?_format=[mime-type]}
| No | Interaction | Remarks | summary | operation | expectation HTTP status | expectation Response Body |
|---|---|---|---|---|---|---|
| 1 | GET [base]/admin/Organization/[id] | 基本形 オプションパラメータ無し | [id]に存在するリソースの id を指定する | 200 OK | 指定した id のリソース |
update
PUT [base]/admin/Organization/[id] {?_format=[mime-type]}
| No | Interaction | Remarks | summary | operation | expectation HTTP status | expectation Response Body |
|---|---|---|---|---|---|---|
| 1 | PUT [base]/admin/Organization/[id]Http request Bodyid=[id] | 基本形 オプションパラメータ無し | [id]に存在するリソースの id を指定する request body の id に[id]と同じ値をセットする meta.versionId、meta.lastUpdated、identifier.system= http://multi-tenant.fructos.jp/organization/partition、identifier.system=http://multi-tenant.fructos.jp/organization/schema は指定しても無視される | 200 OK | 指定した id の更新後のリソース |
create
POST [base]/admin/Organization {?_format=[mime-type]}
| No | Interaction | Remarks | summary | operation | expectation HTTP status | expectation Response Body |
|---|---|---|---|---|---|---|
| 1 | POST [base]/admin/Organization/Http request Body | 基本形 オプションパラメータ無し | request body に作成するリソースをセットする id 、 meta.versionId と meta.lastUpdated は指定しても無視される identifier.system= http://multi-tenant.fructos.jp/organization/schemaは指定しても無視される | 201 Created | 作成されたリソース |
search
Search handling mechanism
GET [base]/admin/Organization{?[parameters]{&_format=[mime-type]}}
| No | Interaction | Remarks | summary | operation | expectation HTTP status | expectation Response Body |
|---|---|---|---|---|---|---|
| 1 | GET [base]/Organization | 対象となるリソースが存在しない場合は Response Body の Bundle.total に 0 が設定される。HTTP Status は 200 OK になる。 | 基本形 オプションパラメータ無し | Organizationリソースが存在する状態で実施する | 200 OK | Bundle |
Operations Defined by Resource Types
Operation $physical-delete on Organization
- FRUCtoS独自のカスタムオペレーションである
URL: [base]/admin/Organization/[id]/$physical-delete
| No | Interaction | Remarks | summary | operation | expectation HTTP status | expectation Response Body |
|---|---|---|---|---|---|---|
| 1 | GET [base]/admin/Organization/[id]/$physical-delete | DBから指定したリソースの現在値と履歴を削除する 対象のOrganizationリソースに対応するテナントのデータもすべて削除される | [id]に存在するリソースの id を指定する | 200 OK | OperationOutcome |