機械翻訳について
  1. ドキュメント用REST API
  2. タスク
  3. 共有

共有フォルダ・ユーザー・ロールの編集

put

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

共有フォルダのユーザー/グループのロールを変更します。

リクエスト

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

  • フォルダのグローバル一意識別子(GUID)。 参照されるフォルダがユーザーのホーム・フォルダの場合、folderIdの値はselfです。

    .
本文 ()
リクエスト本文では、共有フォルダ・ユーザー・ロール編集リクエストの詳細を定義します。 Boldは必須の値を示します。
ルート・スキーマ: ShareFolderEditRoleBody
タイプ: object
リクエスト本文では、共有フォルダ・ユーザー・ロール編集リクエストの詳細を定義します。 Boldは必須の値を示します。
ソースを表示
  • ユーザーに送信されるオプションのメッセージ。
  • 使用可能な値: [ "viewer", "downloader", "contributor", "manager" ]

    共有アイテムへのアクセス・レベル:

    • ビューア: ビューアはファイルおよびフォルダを表示できますが、何かを変更することはできません。
    • ダウンローダ: ダウンローダはファイルをダウンロードし、自分のコンピュータに保存することもできます。
    • コントリビュータ: コントリビュータはファイルの変更、ファイルの更新、新規ファイルのアップロードおよびファイルの削除を行うこともできます。
    • マネージャ: マネージャは他のロールの権限をすべて持ち、他のユーザーをメンバーとして追加したり、削除できます。

  • ユーザーのグローバル一意識別子(GUID)。ユーザーのログイン名、グループのGUID、または前述のカンマ区切りリスト(合計ID 1000以下)です。
リクエストの例(application/json)
{
    "userID":"U7ECC74059E0FEDFEC66BF5AT00000000001",
    "role":"viewer",
    "message":"Changing your shared access rights to viewer."
}
トップに戻る

レスポンス

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

200レスポンス

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

本文 ()
ルート・スキーマ: ShareFolderResponse
タイプ: object
レスポンス本文には、共有情報がユーザー情報またはグループ情報とともに含まれます。
ソースを表示
ネストされたスキーマ: members
タイプ: array
現在のリクエストでフォルダが共有されているユーザーまたはグループ。
ソースを表示
ネストされたスキーマ: User
タイプ: object
ユーザー情報
ソースを表示
ネストされたスキーマ: items
タイプ: object
ソースを表示
  • ユーザーまたはグループの区切り名。
  • リクエスト本文userIDパラメータに指定されたユーザーまたはグループ識別子。
  • このメンバーの追加に成功したかどうか。(1)は成功、(0)は失敗を示します。

  • ユーザーのプロビジョニング・ステータス:

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

    タイプがgroupの場合、返されません。

  • メンバー・タイプには、userまたはgroupという値があります。
レスポンスの例(application/json)
{
    "errorCode":"0",
    "id":"F1321DC48E3B123D02DBEE88T0000000000100000001",
    "members":[
        {
            "id":"U7ECC74059E0FEDFEC66BF5AT00000000001",
            "displayName":"User BB",
            "type":"user",
            "isSuccessful":"1",
            "provisioningStatus":"active"
        }
    ],
    "role":"viewer",
    "type":"share",
    "user":{
        "id":"U7ECC74059E0FEDFEC66BF5AT00000000001",
        "displayName":"User BB",
        "type":"user"
    }
}

400レスポンス

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

403レスポンス

ユーザーにマネージャ権限がない場合、または1つ以上のユーザーまたはグループに対して編集ロールに問題がある場合は禁止されています。

404レスポンス

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

トップに戻る

例

次の例では、指定されたユーザーおよびグループのアクセス・レベルを、指定されたフォルダに変更します。 

PUT .../shares/F1321DC48E3B123D02DBEE88T0000000000100000001/role

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "userID": "U7ECC74059E0FEDFEC66BF5AT00000000001,GS18003",
    "role": "viewer",
    "message": "Changing your shared access rights to viewer"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
  "errorCode": "0",
  "id": "F1321DC48E3B123D02DBEE88T0000000000100000001",
  "members": [
    {
      "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
      "displayName": "User BB",
      "type": "user",
      "isSuccessful": "1",
      "provisioningStatus": "active"
    },
    {
      "id": "GS18003",
      "displayName": "Sales Group",
      "type": "group",
      "isSuccessful": "1",
      "provisioningStatus": "active"
    }
  ],
  "role": "viewer",
  "type": "share",
  "user": {
    "id": "U6A0B35B0548F250914D18FDB5D17B95F470,GS18003",
    "type": "user"
  }
}

例2

次の例は、userIDパラメータがリクエスト本文から欠落しているため、エラーを戻します。 

PUT .../shares/F2CD745706AEC8BD04260B2F45B3E9DD64907CA0D19F/role

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "role": "viewer",
    "message": "granting you shared access"
}

HTTPステータス・コード

HTTP_STATUS = 400

JSONレスポンス

{
    "errorCode": "-97",
    "errorKey": "!csUnableToEditSharingRole!csRequiredServiceParameterMissing,dUserID,EDIT_SHARING_ROLE",
    "errorMessage": "Failed to change shared user role. Parameter 'dUserID' required by service EDIT_SHARING_ROLE is missing.",
    "errorType": "share",
    "id": "F2CD745706AEC8BD04260B2F45B3E9DD64907CA0D19F",
    "role": "viewer",
    "title": "Failed to change shared user role. Parameter 'dUserID' required by service EDIT_SHARING_ROLE is missing.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例3

次の例では、フォルダIDが無効なためにエラーが返されます。

PUT .../shares/F2CCCC5706AEC8BD04260B2F45B3E9DD64907CA0D19F/role

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "userID": "U5C4D5FCE14F2B44946FA74745B3E9DD6490",
    "role": "manager"
}

HTTPステータス・コード

HTTP_STATUS = 404

JSONレスポンス

{
    "errorCode": "-16",
    "errorKey": "!csUnableToEditSharingRole!csSecurityValidationFailed!csFldDoesNotExist,F2CCCC5706AEC8BD04260B2F45B3E9DD64907CA0D19F!csUnprivilegedSystemError",
    "errorMessage": "Failed to change shared user role. Security validation failed. 'F2CCCC5706AEC8BD04260B2F45B3E9DD64907CA0D19F' does not exist. The error was caused by an internally generated issue. The error has been logged.",
    "errorType": "share",
    "id": "F2CCCC5706AEC8BD04260B2F45B3E9DD64907CA0D19F",
    "role": "manager",
    "title": "Failed to change shared user role. Security validation failed. 'F2CCCC5706AEC8BD04260B2F45B3E9DD64907CA0D19F' does not exist. The error was caused by an internally generated issue. The error has been logged.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "user": {
        "id": "U5C4D5FCE14F2B44946FA74745B3E9DD6490",
        "type": "user"
    }
}
先頭に戻る