Jump to

• Request
• Response
• Examples

Get Collaboration Configuration

get

/documents/api/1.2/config/collaboration

Retrieve Collaboration configurations.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body ()

Root Schema : CollaborationConfigurationResponse

Type: object

The response body includes information about Collaboration configurations.

Show Source

• clientURL(optional): string
  Collaboration client URL.
• cListURL(optional): string
  Collaboration cList URL.
• errorCode(optional): number
  An error code of zero (0) indicates no errors.
• oAuthClientURL(optional): string
  Collaboration OAuth client URL.
• oAuthCListURL(optional): string
  Collaboration OAuth cList URL.
• restURL(optional): string
  Collaboration REST URL.
• serviceURL(optional): string
  Collaboration Service URL.

{
    "description":"The response body includes information about Collaboration configurations.",
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        },
        "cListURL":{
            "type":"string",
            "description":"Collaboration cList URL."
        },
        "clientURL":{
            "type":"string",
            "description":"Collaboration client URL."
        },
        "oAuthCListURL":{
            "type":"string",
            "description":"Collaboration OAuth cList URL."
        },
        "oAuthClientURL":{
            "type":"string",
            "description":"Collaboration OAuth client URL."
        },
        "restURL":{
            "type":"string",
            "description":"Collaboration REST URL."
        },
        "serviceURL":{
            "type":"string",
            "description":"Collaboration Service URL."
        }
    }
}

Example Response (application/json)

{
    "errorCode":"0",
    "cListURL":"http://service1-tenant1.dly.gemmain.shared.cec.oraclecorp.com:19200/osn/web/cList",
    "clientURL":"http://service1-tenant1.dly.gemmain.shared.cec.oraclecorp.com:19200/osn",
    "oAuthCListURL":"http://service1-tenant1.dly.gemmain.shared.cec.oraclecorp.com:19200/osnoauth/web/cList",
    "oAuthClientURL":"http://service1-tenant1.dly.gemmain.shared.cec.oraclecorp.com:19200/osnoauth",
    "restURL":"http://service1-tenant1.dly.gemmain.shared.cec.oraclecorp.com:19200/osn/social/api/v1",
    "serviceURL":"http://service1-tenant1.dly.gemmain.shared.cec.oraclecorp.com:19200/osn"
}

Back to Top

Examples

The following example will retrieve Collaboration configuration information.

GET .../config/collaboration

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "cListURL": "http://service1-tenant1.dly.gemmain.shared.osn.oraclecorp.com:19200/osn/web/cList",
    "clientURL": "http://service1-tenant1.dly.gemmain.shared.osn.oraclecorp.com:19200/osn",
    "errorCode": "0",
    "oAuthCListURL": "http://service1-tenant1.dly.gemmain.shared.osn.oraclecorp.com:19200/osnoauth/web/cList",
    "oAuthClientURL": "http://service1-tenant1.dly.gemmain.shared.osn.oraclecorp.com:19200/osnoauth",
    "restURL": "http://service1-tenant1.dly.gemmain.shared.osn.oraclecorp.com:19200/osn/social/api/v1",
    "serviceURL": "http://service1-tenant1.dly.gemmain.shared.osn.oraclecorp.com:19200/osn"
}

Back to Top