機械翻訳について

共有フォルダ・ユーザーの取得

get

/documents/api/1.2/shares/{folderId}/items

共有フォルダおよびそれを共有するユーザーに関する情報を取得します。

リクエスト

サポートされるメディア・タイプ
パス・パラメータ
  • フォルダのグローバル一意識別子(GUID)。 参照されるフォルダがユーザーのホーム・フォルダの場合、folderIdの値はselfです。

    .
本文 ()
リクエスト本文では、共有フォルダ・ユーザー取得リクエストの詳細を定義します。 必須の属性はありません。
ルート・スキーマ: ShareFolderUsersBody
タイプ: object
リクエスト本文では、共有フォルダ・ユーザー取得リクエストの詳細を定義します。 必須の属性はありません。
ソースを表示
  • 指定したフォルダが明示的に共有されているユーザー(true)、または指定したフォルダにアクセスできるすべてのユーザー(直接またはいずれかの親フォルダfalseを共有しているか)のみを返します。 このオプションのデフォルト値はfalseです。
リクエストの例(application/json)
{
    "currentOnly":"true"
}
トップに戻る

レスポンス

サポートされるメディア・タイプ

200レスポンス

リクエストが処理されました。

本文 ()
ルート・スキーマ: ShareFolderUsersResponse
タイプ: object
レスポンス本文には、共有フォルダ・ユーザー取得操作に関する情報が含まれます。
ソースを表示
ネストされたスキーマ: items
タイプ: array
ソースを表示
ネストされたスキーマ : UserWithLoginName
タイプ: object
ユーザー情報
ソースを表示
  • ユーザーの表示名
  • ユーザーのグローバル一意識別子(GUID)。
  • ユーザーのログイン名。
  • ユーザーのプロビジョニング・ステータス:

    • アクティブ: Oracle Content Managementアプリケーション・ロールが割り当てられたアクティブなユーザー
    • 非アクティブ: 現在コンテンツ管理アプリケーション・ロールが割り当てられていないユーザー。
    • 削除済: IAM/IDCSアイデンティティ・ドメインにすでに存在しないユーザー。
    • 保留中: 招待されたが、IAM/IDCSアイデンティティ・ドメインにまだ存在しない外部ユーザー。

  • アイテム・タイプuser
ネストされたスキーマ: ShareDefinition
タイプ: object
共有情報
ソースを表示
レスポンスの例(application/json)
{
    "count":"1",
    "id":"F1321DC48E3B123D02DBEE88T0000000000100000001",
    "type":"share",
    "errorCode":"0",
    "items":[
        {
            "type":"share",
            "role":"manager",
            "user":{
                "id":"U7ECC74059E0FEDFEC66BF5AT00000000001",
                "displayName":"User BB",
                "loginName":"userBBLoginName",
                "provisioningStatus":"active",
                "type":"user"
            }
        }
    ],
    "ownedBy":{
        "id":"U7ECC74059E0FEDFEC66BF5AT00000000002",
        "displayName":"User AA",
        "loginName":"userAALoginName",
        "type":"user"
    }
}

400レスポンス

リクエスト・パラメータが正しい形式ではありません。

403レスポンス

ユーザーに読取り権限がない場合は禁止されています。

404レスポンス

フォルダIDが見つかりません。

トップに戻る

次の例では、指定したフォルダへのアクセス権を持つユーザーおよびグループを取得します:

GET .../shares/F1321DC48E3B123D02DBEE88T0000000000100000001/items?currentOnly=true

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
  "count": "1",
  "errorCode": "0",
  "id": "F1321DC48E3B123D02DBEE88T0000000000100000001",
  "type": "share",
  "items": [
    {
      "type": "share",
      "user": {
        "displayName": "User BB",
        "loginName": "userBBLoginName",
        "id": "U7ECC74059E0FEDFEC66BF5AT00000000001",
        "type": "user",
        "provisioningStatus": "active"
      },
      "role": "manager"
    }
  ],
  "ownedBy": {
    "id": "U7ECC74059E0FEDFEC66BF5AT00000000002",
    "displayName": "User AA",
    "loginName": "userAALoginName",
    "type": "user"
  }
}
先頭に戻る