Oracle CRM On Demand REST API Developer's Guide > Getting Started with the Oracle CRM On Demand REST API > About Oracle CRM On Demand REST API Authentication >

REST API Connection Attributes


After credentials are authenticated, the Oracle CRM On Demand server returns a response to the REST API connection request that includes connection attributes. The REST API connection attributes provide details about the current user and the current Oracle CRM On Demand server session.

Table 12 contains the connection attributes returned in a REST API connection request.

Table 12. Connection Attributes
Connection Attribute
Description

apiVersion

The latest version of the Oracle CRM On Demand REST API.

apiVersionMinimum

The oldest version of the Oracle CRM On Demand REST API.

clientHelpURL

The URL for the page that describes Oracle CRM On Demand REST API errors.

dateFormatLocale

The date and time format.

languageLocale

The expected language code for REST API requests that matches the locale code of the logged-in user language.

maximumFileSize

The maximum file size in MB supported for attachments.

Version

The current Oracle CRM On Demand version number.

ServerDate

The current date/time in REST API date format.

ITSUrlforSSO

The Security Assertion Markup Language (SAML) Intersite Transfer Service URL that is used for Single Sign-On (SSO) into Oracle CRM On Demand.

LastLoggedIn

The date that the user last logged in.

UserLoginId

The user login ID.

UserId

The user ID returned.

TenantId

The tenant ID returned.

CompanyName

The company name returned.

REST API Connection Attributes Example

The connection attributes are returned when you send a request to log into an Oracle CRM On Demand server session.

To return the connection attributes, send an HTTP GET request to the following URL:

/OnDemand/user/Rest/Connection

The REST API request returns the connection response with the following attributes. Some values of the attributes are context-sensitive. For more information about connection attributes, see REST API Connection Attributes.

{
   "Connection": {
   "apiVersion": "028",
   "apiVersionMinimum": "026",
   "clientHelpURL": "https://support.oracle.com/epmos/faces/DocumentDisplay?id=1663390.1",
   "dateFormatLocale": "yyyy-MM-dd, yyyy-MM-dd'T'HH:mm:ss'Z'",
   "languageLocale": "ENU",
   "maximumFileSize": 20,
   "Version": "028.009.000",
   "ServerDate": "2014-12-10T10:55:36Z",
   "LastLoggedIn": "2014-12-08T13:22:41Z",
   "UserLoginId": "REST/USER1",
   "UserId": "1QA2-21ATBK",
   "TenantId": "1QA2-21AI7F",
   "CompanyName": "rest"
 }
}

Oracle CRM On Demand REST API Developer's Guide, Release 32 Copyright © 2016, Oracle and/or its affiliates. All rights reserved. Legal Notices.