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

フォルダ共有

post

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

指定されたフォルダを指定されたユーザーまたはグループ (あるいはその両方)と共有します。 フォルダを共有する場合、ロールを個人/グループに割り当てることにより、各個人/グループが各フォルダおよびそのファイルに対して持っている権限を制御します。 異なるロールによって、個人/グループが共有フォルダに対して実行できる操作が決まります。
  • ビューア: ビューアはフォルダの内容を参照できますが、ファイルを変更することはできません。
  • ダウンローダ: ダウンローダはファイルをダウンロードし、自分のコンピュータに保存することもできます。
  • 貢献者: コントリビュータは、ファイルの変更、更新、アップロードおよび削除を行うこともできます。 コントリビュータは、メタデータ値の取得、メタデータ定義の取得、およびフォルダ所有者がすでに割り当てたメタデータの値の設定を行うこともできます。
  • マネージャ: マネージャは他のロールの権限をすべて持ち、他のユーザーをメンバーとして追加したり、削除できます。

リクエスト

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

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

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

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

    • ビューア: ビューアは、ファイル、フォルダおよびアセットを参照できますが、変更することはできません。
    • ダウン・ローダー: ダウンロード者は、ファイルやアセットをダウンロードして、自分のコンピュータに保存することもできます。
    • 貢献者: 投稿者は、ファイルやアセットを変更、更新、アップロード、および削除することもできます。
    • マネージャ: マネージャは他のロールの権限をすべて持ち、他のユーザーをメンバーとして追加したり、削除できます。

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

レスポンス

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

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":"manager",
    "type":"share",
    "user":{
        "id":"U7ECC74059E0FEDFEC66BF5AT00000000001",
        "displayName":"User BB",
        "type":"user"
    }
}

400レスポンス

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

403レスポンス

ユーザーに読取り権限がない場合、または1つ以上のユーザーまたはグループで問題が発生している場合は禁止されています。

404レスポンス

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

トップに戻る

例

次の例では、指定したフォルダに対する管理者レベルのアクセス権を付与します。

POST .../shares/F1321DC48E3B123D02DBEE88T0000000000100000001

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "userID": "U7ECC74059E0FEDFEC66BF5AT00000000001",
    "role": "manager",
    "message": "granting you shared access to this folder"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
  "errorCode": "0",
  "id": "F1321DC48E3B123D02DBEE88T0000000000100000001",
  "members": [
    {
      "id": "U7ECC74059E0FEDFEC66BF5AT00000000001",
      "displayName": "User CC",
      "type": "user",
      "isSuccessful": "1",
      "provisioningStatus": "active"
    }
  ],
  "role": "manager",
  "type": "share",
  "user": {
    "displayName": "User CC",
    "loginName": "userCCLoginName",
    "id": "U7ECC74059E0FEDFEC66BF5AT00000000001",
    "type": "user"
  }
}

例2

次の例では、フォルダをviewerロールと共有しようとしていますが、ユーザーがすでにフォルダにアクセスしているため、エラーが返されます。 

PUT .../shares/F2CD745706AEC8BD04260B2F45B3E9DD64907CA0D19F

リクエスト・ヘッダー

なし。

リクエスト本文

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

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

{
    "errorCode": "-1",
    "errorKey": "!csUserAlreadyHasAccessToFolder,User DD,f2",
    "errorMessage": "User 'UserAA' already has access to folder 'f2' with identical or higher privileges.",
    "errorType": "share",
    "id": "F2CD745706AEC8BD04260B2F45B3E9DD64907CA0D19F",
    "members":[
        {
            "id":"U5C4D5FCE14F2B44946FA74745B3E9DD6490",
            "displayName":"User DD",
            "type":"user",
            "isSuccessful":"0"
        }
    ],
    "role": "viewer",
    "title": "User 'User DD' already has access to folder 'f2' with identical or higher privileges.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "user": {
	"displayName": "User DD",
	"id": "U5C4D5FCE14F2B44946FA74745B3E9DD6490",
	"loginName": "userDDLoginName",
	"type": "user"
    }
}

例3

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

PUT .../shares/F2CD745706AEC8BD04260B2F45B3E9DD64907CA0D19F

リクエスト・ヘッダー

なし。

リクエスト本文

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

HTTPステータス・コード

HTTP_STATUS = 400

JSONレスポンス

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

例4

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

PUT .../shares/F2CD745706AEC8BD04260B2F45B3E9DD64907CA0D19F

リクエスト・ヘッダー

なし。

リクエスト本文

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

HTTPステータス・コード

HTTP_STATUS = 404

JSONレスポンス

{
    "errorCode": "-16",
    "errorKey": "!csUnableToShareFolder!csSecurityValidationFailed!csFldDoesNotExist,F2CD745706AEC8BD04260B2F45B3E9DD64907CA0D19F!csUnprivilegedSystemError",
    "errorMessage": "Failed to share folder. Security validation failed. 'F2CD745706AEC8BD04260B2F45B3E9DD64907CA0D19F' does not exist. The error was caused by an internally generated issue. The error has been logged.",
    "errorType": "share",
    "id": "F2CD745706AEC8BD04260B2F45B3E9DD64907CA0D19F",
    "role": "manager",
    "title": "Failed to share folder. Security validation failed. 'F2CD745706AEC8BD04260B2F45B3E9DD64907CA0D19F' 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"
    }
}

例5

次の例は、ユーザーGUIDとログイン名を使用して、2人のユーザーとフォルダを共有しています。

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "userID": "U92A91A29A46767692583BCCCC4A88C356D9,JohnSmith,GS18003",
    "role": "manager",
    "message": "granting you shared access"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
  "errorCode": "0",
  "id": "F6ED064539F10B076BC0F8E19AD1D511040A6D384E90",
  "members": [
    {
      "id": "U92A91A29A46767692583BCCCC4A88C356D9",
      "displayName": "David Lee",
      "type": "user",
      "isSuccessful": "1",
      "provisioningStatus": "active"
    },
    {
      "id": "JohnSmith",
      "displayName": "John Smith",
      "type": "user",
      "isSuccessful": "1",
      "provisioningStatus": "pending"
    },
    {
      "id": "GS18003",
      "displayName": "Sales Group",
      "type": "group",
      "isSuccessful": "1",
      "provisioningStatus": "active"
    }
  ],
  "role": "manager",
  "type": "share",
  "user": {
    "id": "U92A91A29A46767692583BCCCC4A88C356D9,JohnSmith,GS18003",
    "type": "user"
  }
}
先頭に戻る