ドキュメント用REST API

機械翻訳について

ファイル会話を作成

post

/documents/api/1.2/files/{fileId}/conversation

新しい会話を作成し、指定したファイルに関連付けます。このリクエストは、作成者の会話applinkも生成します。

リクエスト

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

application/json
application/xml

パス・パラメータ

fileId: string

ファイルのグローバル一意識別子(GUID)。

ヘッダー・パラメータ

accessToken(optional): string

現在のユーザーに親フォルダまたはこのファイルにアクセスすることを許可するApplinkアクセス・トークン。このパラメータは、appLinkIDが使用されている場合は必須です。これはaccessTokenまたはAccessTokenとして使用できます。
appLinkID(optional): string

現在のユーザーに親フォルダまたはこのファイルにアクセスすることを許可するApplink ID。パラメータappLinkIDが使用されるときはいつでも、パラメータaccessTokenも提供されなければなりません。働くには、このapplinkは、少なくともコントリビュータ・ロールが付与されていなければなりません。 appLinkIDまたはAppLinkIDとして使用できます。
dAccessCode(optional): string

保護されたパブリック・リンクを使用するために必要なアクセス・コード。次の形式のCookieヘッダーの一部として送信する必要があります: dAccessCode-<linkID>=<passcodeValue>
linkID(optional): string

現在のユーザーにこのファイルへのアクセスを許可する、パブリック・リンクのパブリック・リンクID。機能させるには、このパブリック・リンクにコントリビュータ・ロールが付与されている必要があります。 linkIDまたはLinkIDとして使用できます。

リクエスト本文は、ファイル作成の会話リクエストの詳細を定義します。 Boldは必須の値を示します。

ルート・スキーマ : FileCreateConversationBody

タイプ: object

リクエスト本文は、ファイル作成の会話リクエストの詳細を定義します。

ソースを表示

conversationName: string

最大長: 256

新しく作成したファイル会話の名前を指定します。

{
    "description":"The request body defines details of the create file conversation request.",
    "properties":{
        "conversationName":{
            "type":"string",
            "description":"Specify the name of the newly created file conversation.",
            "maxLength":256
        }
    },
    "required":[
        "conversationName"
    ]
}

リクエストの例(application/json)

{
    "conversationName":"File Conversation Test"
}

トップに戻る

レスポンス

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

application/json
application/xml

200レスポンス

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

ルート・スキーマ : FileCreateConversationResponse

タイプ: object

ソースを表示

conversationAppLink(optional): string

会話のApplink。
conversationAppLinkToken(optional): string

限られた期間、このアプリケーション・リンクに有効なアクセス・トークン。
conversationID(optional): string

新しく作成した会話のグローバル一意識別子(GUID)。
conversationName(optional): string

対話名
errorCode(optional): string

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

ファイルのグローバル一意識別子(GUID)。
listOfRemovedInactiveUsers(optional): string

非アクティブなユーザーのリスト。
listOfUnknownUsers(optional): string

不明なユーザーのリスト。
type(optional): string

アイテム・タイプfile。

{
    "description":"",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the file."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>file</code>."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        },
        "conversationID":{
            "type":"string",
            "description":"Globally unique identifier (GUID) of the newly created conversation."
        },
        "conversationName":{
            "type":"string",
            "description":"Conversation name."
        },
        "conversationAppLink":{
            "type":"string",
            "description":"Applink for the conversation."
        },
        "conversationAppLinkToken":{
            "type":"string",
            "description":"Access token that is valid for this applink for a limited duration."
        },
        "listOfRemovedInactiveUsers":{
            "type":"string",
            "description":"List of inactive users."
        },
        "listOfUnknownUsers":{
            "type":"string",
            "description":"List of unknown users."
        }
    }
}

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

{
    "id":"DFCCA263ED167730B7824BFF98503556E71E89DE95CC",
    "type":"file",
    "errorCode":"0",
    "conversationID":"13865",
    "conversationName":"File Conversation Test",
    "conversationAppLink":"http://service1-tenant1.dly.gemmain.shared.cec.oraclecorp.com:19200/osn/web/cList/conversations/13865",
    "conversationAppLinkToken":"2842038cbf8b9c5db8ec37db134b5af44e9240d20f79891a0eb18e3df90b6684s"
}

400レスポンス

リクエスト・パラメータが正しくフォーマットされていません。

403レスポンス

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

404レスポンス

ファイルIDが見つかりません。

トップに戻る

例

次の例では、ファイルの会話を作成します。

POST .../files/DFCCA263ED167730B7824BFF98503556E71E89DE95CC/conversation

リクエスト・ヘッダー

なし。

リクエスト本文

{
  "conversationName": "File Conversation Test"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "conversationAppLink": "http://service1-tenant1.dly.gemmain.shared.osn.oraclecorp.com:19200/osn/web/cList/conversations/13865",
    "conversationAppLinkToken": "2842038cbf8b9c5db8ec37db134b5af44e9240d20f79891a0eb18e3df90b6684",
    "conversationID": "13865",
    "conversationName": "File Conversation Test",
    "errorCode": "0",
    "id": "DFCCA263ED167730B7824BFF98503556E71E89DE95CC",
    "type": "file"
}

例2

次の例では、ファイルの会話を作成します。このファイルは現在のユーザーが所有していない、または共有していないフォルダ構造の下にあるため、この例ではapplink IDを使用しています。 applink IDとアクセス・トークンはリクエスト・ヘッダーに送信されます。

POST .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/conversation

リクエスト・ヘッダー

appLinkID: LF5Bxj4TPo_p4n4qWn0tbKTicR2cTUJKv7X_ng9E7ry93rRuDokPqS1d6-wKwhb_wtcGYFDsI_cNMxeKQ-HR-FXQhiVoGRTYM_MPZY8qpICfYU94mmnMjM_cvsRhKMzc0NJgvwEJfqqDwPsAVrhc8cmg==
accessToken: 352FpiMmW66PeYI1Gh5b83I9CXRwZhLfYAu4TXdqpzD8uNKUBMZVVJ3ZvivUW8kQ

リクエスト本文

{
  "conversationName": "Applink File Conversation Test"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "conversationAppLink": "http://service1-twebcli.myhost.us.oracle.com:19200/osn/web/cList/conversations/12081",
    "conversationAppLinkToken": "088dc118855dd4056ee68d79d265353e4d87dc88f1806cf80dc400e23cb0c148",
    "conversationID": "12081",
    "conversationName": "Applink File Conversation Test",
    "errorCode": "0",
    "id": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
    "type": "file"
}

先頭に戻る