オブジェクト情報登録
オブジェクト（フォルダ）情報を登録します。
(1) 必要な権限
RegisterObject APIを使用するには以下の権限が必要です。
ルートフォルダ作成時
-
フォルダの作成権限
-
システム管理の更新権限
管理対象種別による違いは以下のとおりです。
- システム全体
-
ルートフォルダを作成可能
- グループ単位
-
作成不可
ルートフォルダ以外の作成時
-
フォルダの作成権限
ルートフォルダ以外の編集時
-
フォルダの作成権限
上記の権限に加えて、リクエストで指定したオブジェクトに対するアクセス権が必要です。
(2) リクエストURL
http(s)://Domain:xxxx/コンテキスト名/RegisterObject
(3) リクエストインタフェース
|
項目名 |
説明 |
文字 |
省略 |
省略値 |
|---|---|---|---|---|
|
object_id |
オブジェクトID 更新時、登録するオブジェクトのオブジェクトIDを16バイトで指定します。 |
半角 |
○ |
省略した場合は新規作成 |
|
parent_object_id |
親オブジェクトID 登録するオブジェクトの親オブジェクトID（オブジェクトを格納するフォルダ）を16バイトで指定します。 |
半角 |
○ |
省略した場合はルートにオブジェクトを登録します |
|
name |
オブジェクト名 登録するオブジェクトの名前を255バイト以内で指定します。 |
混在 |
× |
|
|
option1 |
オプション1 255バイト以内で指定します。 |
混在 |
○ |
ブランク |
|
option2 |
オプション2 255バイト以内で指定します。 |
混在 |
○ |
ブランク |
|
option3 |
オプション3 255バイト以内で指定します。 |
混在 |
○ |
ブランク |
子オブジェクトを新規作成すると、親オブジェクトにアクセス可能なすべてのグループIDとユーザIDが継承されます。
登録したオブジェクト（フォルダ）のオブジェクトパスが1024バイト以内になるようにしてください。1024バイトを超えた場合はエラーとなります。
- 登録したオブジェクトのオブジェクトパス：
-
「parent_object_idで指定した親オブジェクトのオブジェクトパス」+"/"+「nameで指定したフォルダ名」
(4) レスポンスインタフェース
|
項目名 |
説明 |
備考 |
|---|---|---|
|
object_id |
オブジェクトID 登録したオブジェクトのオブジェクトIDが返却されます。 |
|