機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

パブリック・リンク取得

get

/documents/api/1.2/publiclinks/{linkId}

特定のパブリック・リンクに関する情報を返します。

リクエスト

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

• application/json
• application/xml

パス・パラメータ

• linkId: string
  パブリック・リンクのグローバル一意識別子(GUID)。

トップに戻る

レスポンス

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

• application/json
• application/xml

200レスポンス

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

本文 ()

ルート・スキーマ: PublicLinkGetResponse

タイプ: object

レスポンス本文には、パブリック・リンクに関する情報が含まれます。

ソースを表示

• errorCode(optional): string
  エラー・コードがゼロ(0)の場合は、エラーなしです

{
    "description":"The response body includes information about the public link.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/PublicLinkDefinition"
        }
    ],
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

すべてに一致

ソースを表示

• object PublicLinkDefinition
  パブリック・リンク情報。

{
    "description":"The response body includes information about the public link.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/PublicLinkDefinition"
        }
    ],
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

ネストされたスキーマ: PublicLinkDefinition

タイプ: object

パブリック・リンク情報。

ソースを表示

• assignedUsers(optional): string
  リンクを使用できるユーザーのグループ。
• createdTime(optional): string
  パブリック・リンクが作成された日時。
• expirationTime(optional): string
  パブリック・リンクの期限が切れる日時
• lastModifiedTime(optional): string
  パブリック・リンクが最後に変更された日時
• linkID(optional): string
  パブリック・リンクのグローバル一意識別子(GUID)。
• linkName(optional): string
  パブリック・リンクの名前。
• ownedBy(optional): object User
  ユーザー情報
• password(optional): string
  パブリック・リンクのパスワード。 使用できるのは8文字以上50文字以下です。 パスワードでは、大文字と小文字が区別されます。
• role (オプション): string
  使用可能な値: [ "viewer", "downloader", "contributor" ]

  共有アイテムへのアクセス・レベル
• type(optional): string
  アイテム・タイプpubliclink。

{
    "description":"Public link information.",
    "properties":{
        "linkID":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the public link."
        },
        "linkName":{
            "type":"string",
            "description":"Name of the public link."
        },
        "assignedUsers":{
            "type":"string",
            "description":"The group of users who can use the link."
        },
        "role":{
            "type":"string",
            "description":"Access level for the shared item.",
            "enum":[
                "viewer",
                "downloader",
                "contributor"
            ]
        },
        "password":{
            "type":"string",
            "description":"Password for the public link. Use a minimum of 8 characters and a maximum of 50 characters. Passwords are case-sensitive."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>publiclink</code>."
        },
        "createdTime":{
            "type":"string",
            "description":"Date and time when the public link was created."
        },
        "expirationTime":{
            "type":"string",
            "description":"Date and time when the public link expires."
        },
        "lastModifiedTime":{
            "type":"string",
            "description":"Date and time when the public link was last modified."
        },
        "ownedBy":{
            "$ref":"#/definitions/User"
        }
    }
}

ネストされたスキーマ: User

タイプ: object

ユーザー情報

ソースを表示

• displayName(optional): string
  ユーザーの表示名
• id(optional): string
  ユーザーのグローバル一意識別子(GUID)。
• loginName(optional): string
  ユーザーのログイン名。
• type(optional): string
  アイテム・タイプuser。

{
    "description":"User information",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the user."
        },
        "displayName":{
            "type":"string",
            "description":"The display name for the user."
        },
        "loginName":{
            "type":"string",
            "description":"The login name for the user."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>user</code>."
        }
    }
}

レスポンスの例(application/json)

{
    "linkID":"LF906748A021ACD714CABC82T0000000000100000001",
    "linkName":"MyLinkOne",
    "assignedUsers":"@everybody",
    "role":"contributor",
    "type":"publiclink",
    "createdTime":"2015-06-10T16:01:44Z",
    "expirationTime":"2016-01-01T00:00:01Z",
    "lastModifiedTime":"2015-06-10T16:01:44Z",
    "ownedBy":{
        "id":"U0EAA20910FAF3052ACB79E4T00000000001",
        "displayName":"User AA",
        "type":"user"
    },
    "errorCode":"0"
}

400レスポンス

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

403レスポンス

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

404レスポンス

リンクIDが見つかりません。

トップに戻る

例

次の例では、指定したパブリック・リンクに関する情報が返されます。

GET .../publiclinks/LF906748A021ACD714CABC82T0000000000100000001

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "assignedUsers": "@everybody",
    "createdTime": "2015-06-10T16:01:44Z",
    "errorCode": "0",
    "expirationTime": "2016-01-01T00:00:01Z",
    "lastModifiedTime": "2015-06-10T16:01:44Z",
    "linkID": "LF906748A021ACD714CABC82T0000000000100000001",
    "linkName": "MyLinkOne",
    "ownedBy": {
	      "displayName": "User AA",
	      "loginName": "userAALoginName",
	      "id": "U0EAA20910FAF3052ACB79E4T00000000001",
	      "type": "user"
    },
    "role": "contributor",
    "type": "publiclink"
}

例2

次の例では、リンクIDが無効であるため、エラーが返されます。

GET .../publiclinks/LFE36701FF7D3371DCD7F9E245B3E9DD64907CA0D19F

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 404

JSONレスポンス

{
    "errorCode": "-16",
    "errorKey": "!csUnableToRetrieveSharedLinkInfo!csUnableToFindLink",
    "errorMessage": "Failed to retrieve shared link information. Unable to find the specified shared link.",
    "errorType": "publiclink",
    "linkID": "LFE36701FF7D3371DCD7F9E245B3E9DD64907CA0D19F",
    "title": "Failed to retrieve shared link information. Unable to find the specified shared link.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

先頭に戻る