REST API for Content Management 1.1

Create Folder Conversation

post

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

Create a new conversation and associate it with the specified folder. It will also generate a conversation applink for the creator.

Request

Supported Media Types

application/json
application/xml

Path Parameters

folderId: Type: string

Required: true

Globally unique identifier (GUID) for the folder.

Header Parameters

accessToken: Type: string

Applink access token authorizing the current user to access this folder. This parameter is mandatory if appLinkID is used. It can be used as accessToken or AccessToken.
appLinkID: Type: string

Applink ID authorizing the current user to access this folder. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. To work, this applink must have at least the contributor role granted. It can be used as appLinkID or AppLinkID.
dAccessCode: Type: string

Access code needed to use protected public links. It needs to be sent as part of a Cookie header in the following format: dAccessCode-<linkID>=<passcodeValue>
linkID: Type: string

Public link ID of a public link authorizing the current user to access this folder. To work, this public link must have the contributor role granted. It can be used as linkID or LinkID.

Body Parameter

The request body defines details of the create folder conversation request.

Root Schema : FolderCreateConversationBody

The request body defines details of the create folder conversation request.

Properties

conversationName: Type: string

Required: true

Maximum Length: 256

Specify the name of the newly created folder conversation.

Example application/json


{
    "conversationName":"Folder Conversation Test"
}

Response

Supported Media Types

application/json
application/xml

200 Response

The request was fulfilled.

Body

Root Schema : FolderCreateConversationResponse

Properties

conversationAppLink: Type: string

Applink for the conversation.
conversationAppLinkToken: Type: string

Access token that is valid for this applink for a limited duration.
conversationID: Type: string

Globally unique identifier (GUID) of the newly created conversation.
conversationName: Type: string

Conversation name.
errorCode: Type: string

An error code of zero (0) indicates no errors.
id: Type: string

Globally unique identifier (GUID) for the folder.
listOfRemovedInactiveUsers: Type: string

List of inactive users.
listOfUnknownUsers: Type: string

List of unknown users.
type: Type: string

Item type folder.

Example application/json


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

400 Response

Request parameter is not formatted correctly.

403 Response

Forbidden if the user does not have read permission.

404 Response

Folder ID is not found.

Examples

The following example creates a conversation for a folder.

POST .../folders/F1BDF6BBD9725002B8136F6598503556E71E89DE95CC/conversation

Request Header

None.

Request Body

{
"conversationName": "Folder Conversation Test"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "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"
}

Example 2

The following example creates a conversation for a folder. The example uses an applink ID because this folder is under a folder structure not owned by or shared with the current user. The applink ID and access token are submitted in the request header.

POST .../folders/F4A0A403F55D5159B9263259C2DB3E7D25FCBE785123/conversation

Request Header

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

Request Body

{
    "conversationName": "Conversation via applink"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "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"
}