ドキュメント用REST API

機械翻訳について

フォルダの会話を作成

post

/documents/api/1.2/folders/{folderId}/conversation

新しい会話を作成し、指定したフォルダに関連付けます。また、作成者の会話アプリケーション・リンクも生成されます。

リクエスト

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

application/json
application/xml

パス・パラメータ

folderId: 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として使用できます。

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

ルート・スキーマ : FolderCreateConversationBody

タイプ: object

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

ソースを表示

conversationName: string

最大長: 256

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

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

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

{
    "conversationName":"Folder Conversation Test"
}

トップに戻る

レスポンス

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

application/json
application/xml

200レスポンス

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

ルート・スキーマ : FolderCreateConversationResponse

タイプ: 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

アイテム・タイプfolder。

{
    "description":"",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the folder."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>folder</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":"F1BDF6BBD9725002B8136F6598503556E71E89DE95CC",
    "type":"folder",
    "errorCode":"0",
    "conversationID":"13841",
    "conversationName":"Folder Conversation Test",
    "conversationAppLink":"http://service1-tenant1.dly.gemmain.shared.cec.oraclecorp.com:19200/osn/web/cList/conversations/13841",
    "conversationAppLinkToken":"e14ad9a457aaa177d33a40115494272bf23bc663072f3fe5cb7412a731df5607"
}

400レスポンス

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

403レスポンス

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

404レスポンス

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

トップに戻る

例

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

POST .../folders/F1BDF6BBD9725002B8136F6598503556E71E89DE95CC/conversation

リクエスト・ヘッダー

なし。

リクエスト本文

{
"conversationName": "Folder Conversation Test"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "conversationAppLink": "http://service1-tenant1.dly.gemmain.shared.osn.oraclecorp.com:19200/osn/web/cList/conversations/13841",
    "conversationAppLinkToken": "e14ad9a457aaa177d33a40115494272bf23bc663072f3fe5cb7412a731df5607",
    "conversationID": "13841",
    "conversationName": "Folder Conversation Test",
    "errorCode": "0",
    "id": "F1BDF6BBD9725002B8136F6598503556E71E89DE95CC",
    "type": "folder"
}

例2

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

POST .../folders/F4A0A403F55D5159B9263259C2DB3E7D25FCBE785123/conversation

リクエスト・ヘッダー

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

リクエスト本文

{
    "conversationName": "Conversation via applink"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "conversationAppLink": "http://service1-twebcli.myhost.us.oracle.com:19200/osn/web/cList/conversations/12039",
    "conversationAppLinkToken": "b80bb5e9cb12cf0770cc63d2c1ddab5b8622ea87d4d10f688f2a0c52555ae159",
    "conversationID": "12039",
    "conversationName": "Conversation via applink",
    "errorCode": "0",
    "id": "F4A0A403F55D5159B9263259C2DB3E7D25FCBE785123",
    "type": "folder"
}

先頭に戻る