Rest API Documentation

Hello,
Can someone please point me to the official Web API reference?
Thanks,
Patryk

Patry,
You can access the REST API live docs after logging into Eloqua as a user. Live docs provide more up-to-date endpoint details than the static docs.
<base url>/api/docs/Dynamic/Rest/1.0/Reference.aspx
<base url>/api/docs/Dynamic/Rest/2.0/Reference.aspx
The base url is the first part of the URL after you logged into your Eloqua application. To retrieve your base URL programmatically, you can follow the instructions here: http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#Developers/GettingStarted/Tutorials/determining-base…
The OMC support team is unable to assist with custom codes; however, they can provide guidance on supported operations and confirm any technical issues on the APIs.
Hope this helps!
Brigitte

Similar Messages

Which Eloqua REST API documentation link should use ?

I found 2 links as mentioned below for REST API Documentation:
http://secure.eloqua.com/api/docs/Static/Rest/2.0/doc.htm
http://secure.eloqua.com/api/docs/Static/Rest/2.0/index.htm
Is these links are correct or is there any development guide link available which I am missing.
So I need some details that which link should I use for my reference or which link will be used for future enhancement?

I am looking for the same. Were you happen to find any API guide or developers guide for REST API 2.0?
Thank you,
-Syed.

Azure KeyVault REST API documentation is missing

Keyvault Http Request and responses page and various other pages under KeyVault REST API here have
started giving back
Content not found
Where have they gone to?

Link works fine now. Maybe it was temporarily down
Please mark posts as answers/helpful if it answers your query. This would be helpful for others facing the same kind of problem

Azure Websites REST API documentation dispappeared from MSDN

I have been using Azure Website Management APIs REST endpoint GET and PUT with the following:
"https://management.core.windows.net/"+
YourSubscriptionId + "/services/WebSpaces/eastuswebspace/sites/"+
YourAzureWebSiteName+ "/config"
There use to be complete documentation on this and now its gone.

Hi nCloud,
I have reported this issue, there might be some time delay. Appreciate your patience.
Thanks for your understanding!
Best Regards,
Jambor
We are trying to better understand customer views on social support experience, so your participation in this interview project would be greatly appreciated if you have time. Thanks for helping make community forums a great place.
Click
HERE to participate the survey.

Is "2013-08" the latest REST API version or is the documentation outdated?

I'm wondering if the Azure Notification Hubs REST API documentation is
still correct and up-to-date or if there is already a newer API version than "2013-08" that can be used.
All the single pages show "Updated: February 26, 2015", but I guess it was just a meta data update of all the pages, since the API version didn't change,
it's still "2013-08". Is this intentional because the API didn't change or was it forgotten to update the API version?
Here (and here)
is an example for the REST API usage from Elio Damaggio which uses "2013-10" as the api version. I tried all possible api version values in the format "yyyy-mm" from "2013-10" to "2015-03" and the following
were working: "2013-10", "2014-01", "2014-05", "2014-08", "2014-09", "2015-01". Are there actual changes to the API and if so, aren't they officially supported or what is the reason for the
old API version in the documentation?
Is the API version "2015-01" officially supported and can I find the documentation for it or am I stuck with API version "2013-08"? Or
aren't there any changes worth updating the documentation?
Moreover the documentation for "Read All Registrations of a Channel" states to use
following request URI, which doesn't work: https://{namespace}.servicebus.windows.net/{NotificationHub}/registrations/?$filter=DeviceToken eq ‘{deviceToken}’&api-version=2013-08
Even more confusing, the german version uses double quotes, which doesn't work either: https://{Namespace}.servicebus.windows.net/{Benachrichtigungshub}/registrations/?$filter=DeviceToken
eq "{Gerätetoken}"&api-version=2013-08
I found out that the correct request URI must be like this to work: https://{namespace}.servicebus.windows.net/{NotificationHub}/registrations/?$filter=DeviceToken+eq+'{deviceToken}'&api-version=2013-08 ,
so + instead of spaces and '' (apostrophe / straight single quote - U+0027) instead of ‘’ (single curved quotation marks - U+2018 and U+2019) or "" (straight double quote - U+0022), e.g. https://myServiceBusNamespace.servicebus.windows.net/myHub/registrations/?$filter=DeviceToken+eq+'2ED202AC08EA9033665E853A3DC8BC4C5E78F7A6CF8D55910DF230567037DCC4'&api-version=2013-08
Is the documentation just wrong by mistake or is it not up-to-date? How are people even using the REST API without a 100% correct documentation? Is
there something I am missing? Do you get a manual when you buy a Azure Notification Hubs subscription or is the REST API not even supported officially?

The latest version is 2015-01. All or most of features works with starting version 2013-08.
Version in documentation indicates that minimum version required for working that feature. Hence, all documentation is pointing to 2013-08.
You should do the URL encoding before making http request. Otherwise special characters such as blanks and punctuation are passed in an HTTP stream without encoding, they might be misinterpreted. Hence your request failed due to space. You can use the following
method to do the URL encoding.
https://msdn.microsoft.com/en-us/library/4fkewx0t%28v=vs.110%29.aspx
Yes, REST API is fully supported. May be there could be few gaps or bugs. We are putting constant efforts to fix all bugs as we find and improve it further.
Thanks,
Sateesh
Mark Post as helpful if it provides any help.Otherwise,leave it as it is.

Which Objects should I target for integrating Eloqua REST API 2.0?

Which Objects should I target for integration? and What are the possible use cases for the additional objects other than core objects?

I am still trying to find a good REST API 2,0 document like the Bulk 2.0 document. Book List: Oracle Marketing Cloud
I did find this but is also not in depth:
REST API - Documentation for Core Objects

Are there REST APIs to retrieve entity metadata for eloqua objects?

There is a list of all the objects which can be accessed by REST for CRUD in this link: REST API - Documentation for Core Objects under the Core Objects section.
For each of the objects listed under the Core Objects section are there is a field metadata under the Properties section.
For example for Email object, REST API - Accessing Emails , under the Properties section, there corresponding entries for fields of Emails object under the
Name ,Type, Description and Validations headings.
Is there a REST API for retrieving the same information i.e. the field metadata for an eloqua object programmatically ?
If not , it is a serious hindrance to building systems that are metadata driven and also since SOAP support is being deprecated...

Metadata is 'top level' information on the object, and available whether you query the individual object (a single form, or email asset) or query for multiple objects of that type (list all forms, list all emails). Consider using a depth of minimal or partial for faster performance if the specific configuration of those objects is not important..
Example:
GET /assets/forms?depth=minimal&count=2
Returns:
"elements":
    "type":"Form",
    "currentStatus":"Draft",
    "id":"19",
    "createdAt":"1409623550",
    "createdBy":"8",
    "depth":"minimal",
    "folderId":"7",
    "name":"zzztestCS_3-9381543541_AutocompleteTest",
    "permissions":"fullControl",
    "updatedAt":"1409623623",
    "updatedBy":"8"
    "type":"Form",
    "currentStatus":"Draft",
    "id":"22",
    "createdAt":"1409781207",
    "createdBy":"11",
    "depth":"minimal",
    "folderId":"466",
    "name":"daisychain1",
    "permissions":"fullControl",
    "updatedAt":"1412779449",
    "updatedBy":"20"
"page":1,
"pageSize":2,
"total":130
Without limiting the count to 2, this would return up to 1000 results if you had multiple forms in your system and give you a basic top level view of each. Similarly, you can use GET /assets/form/{id}?depth=minimal to get the same sort of information.
Other endpoints can be found on the REST livedocs page here (requires authentication):
https://secure.eloqua.com/api/docs/Dynamic/Rest/1.0/Reference.aspx
Regards,
Bojan

Best practices for cleaning up after a Bulk REST API v2 export

I want to make sure that I am cleaning up after my exports (not leaving anything staging, etc). So far I am
DELETEing $ENTITY/exports/$ID and $ENTITY/exports/$ID/data as described in the Bulk REST API documentation
Using a dataRetentionDuration when I create an export (as a safety net in case my code crashes before deleting).
Is there anything else I should do? Should I/can I DELETE the syncs I create (syncs are not listed in the "Delete an Entity" section of the documentation)? Or are those automatically deleted when I DELETE an export?
Thanks!
1086203

Hi Chris,
I met the same problem as pod
It happens when I tried to load all historical activities, and one sample is same activityId was given to 2 different types (one is EmailOpen, the other is FormSubmit) that generated in year 2013
Before full loading, I ever did testing for my job, extracting the activity records from Nov 2014, and there is not unique ID issue
Seems Eloqua fixed this problem before Nov 2014, right?
So if I start to load Activity generated since 2015, there will not be PK problem, or else, I have to use ActivityId + ActivityType as compound PK for historical data
Please confirm and advise
Waiting for your feedback
Thanks~

Authentication for Stream Analytics REST Api

Hi there,
I am trying to use the stream analytics rest api from a java client. For other services (storage services for example), I am able to successfully use mutual certificate authorization. I create a management certificate using keytool and upload it through
the settings tab in azure portal. I then create an SSLContext from this certificate. This all works and I am able to get access to the storage services api.
The same flow does not seem to work for stream analytics api. When attempting to make an api call, I get 401 error code with the following response authorization header.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.StreamAnalytics/streamingjobs?api-version=2014-10-01-preview
WWW-Authenticate=[Bearer authorization_uri="https://login.windows.net/{...}", error="invalid_token", error_description="The access token is missing or invalid."]
The result is the same whether or not I configure the certificate on the client side. So, it seems like the mutual certificate authorization is not supported in stream analytics as it is in the other management APIs. Can you confirm if this feature is not
supported? If it is not supported, can you please provide some information on how we should be authenticating for stream analytics REST api?
Thanks

I did some more investigating. The Azure Stream Analytics REST Api documentation uses
https://management.azure.com/
as the base uri for managing stream analytics service. The .NET azure sdk source code on github, however, uses
https://management.core.windows.net/
for the same. So, I have tried accessing some different variations of resources.
https://management.core.windows.net/{my subscription id}/services/storageservices
Response: 200 OK
Here, I am using mutual certificate authorization to successfully reach storage services at management.core.windows.net. This verifies that the certificate authorization flow works for other services in the same subscription.
https://management.azure.com/subscriptions/{my subscription id}/resourcegroups/StreamAnalytics-Default-Central-US/providers/Microsoft.StreamAnalytics/streamingjobs?api-version=2014-10-01-preview
Response: 401 Unauthorized
Message: {"error":{"code":"AuthenticationFailed","message":"Authentication failed. The 'Authorization' header is not present or provided in an invalid format."}}
Now I attempt to use the same mutual certificate authorization on the management.azure.com base uri for stream analytics management. The request fails and the error message notes that an expected Authorization header is missing. This leads me to
believe that mutual certificate authorization is not supported on management.azure.com.
The Authorization header makes sense for OAuth2 flow, so I am thinking that management.azure.com
might only support OAuth2. I need server to server management, so OAuth2 flow will not work because it requires interactive browser redirect to work with management api. Active
Directory only gives delegate permissions to management services, not application permissions. I believe this rules out using OAuth2 / Active Directory for headless
authorization - please correct me if I am wrong.
https://management.core.windows.net/subscriptions/{my subscription id}/resourcegroups/StreamAnalytics-Default-Central-US/providers/Microsoft.StreamAnalytics/streamingjobs?api-version=2014-10-01-preview
Response: 403 Forbidden
Message: <Error xmlns="http://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><Code>ForbiddenError</Code><Message>The server failed to authenticate
the request. Verify that the certificate is valid and is associated with this subscription.</Message></Error>
Here I try to use the mangagement.core.windows.net base uri that is used in .net sdk. I get a 403 forbidden response. The error message indicates that the server attempted to complete the mutual certificate authorization. The server complains, though,
that the certificate is invalid. This is the same certificate used successfully to manage storage services, so I know the certificate is valid and the client flow works.
It would be great if someone could expand on the discrepancy between the base uri in the documentation vs .net sdk and provide some guidance on server to server authorization to stream analytics management api.
Thanks,
Dave

"ErrorAccesDenied" when using REST APIs to access Contacts, Calendar and Mails in Office365

Hi,
I am developing a web application to integration with Office365 using Azure AD method. I have created a Multi-Tenant application in Azure AD and using the client-id , client secret I have successfully generated access token and refresh token.
Based on the rest API documentation I am setting the header with Authorization, User-Agent, Client-request-id as the parameters. But when I make a request to fetch all the contacts getting the following response.
{"error":{"code":"ErrorAccessDenied","message":"Access is denied. Check credentials and try again."}}I have followed all the steps that were listed in this blog http://blogs.msdn.com/b/exchangedev/archive/2014/03/25/using-oauth2-to-access-calendar-contact-and-mail-api-in-exchange-online-in-office-365.aspxAny help is appreciated.Thank you in advance.

Jason,
Thank you for the response.
I am making GET request to get the contacts using this URL - https://outlook.office365.com/api/v1.0/me/contacts
When I copy and paste in JWT this what I am seeing,
scp - Calendars.Read Calendars.Write Contacts.Read Contacts.Write full_access_as_user Mail.Read Mail.Send Mail.Write
aud - https://outlook.office365.com/

Network Security Groups REST API

HI,
according to this link:
http://azure.microsoft.com/blog/2014/11/04/network-security-groups/
Network Security groups is currently exposed only through power shell and REST API.
I can't find any REST API documentations.
any idea?

Hi,
You are correct. There is no offical article related to Network Security Group with REST API as Network Security Group is a new feature. I will report it to the related team and hope the related articles would be published quickly. In addition, you can also
submit your requirement in Azure feedback:
http://feedback.azure.com/forums/34192--general-feedback
Apprecite your patience.
Best regards,
Susie
Please remember to mark the replies as answers if they help and unmark them if they provide no help. If you have feedback for TechNet Subscriber Support, contact [email protected]

How to create a campaign based on a template using the REST API

Hi CodeIt-ers,
I'm using the REST API to create campaigns in Eloqua 10, all works well except for 1 thing: I can't seem to create a campaign based on an existing Campaign template.
Based on the documentation on REST API - Accessing Campaigns I've tried using "sourceTemplateId" (code snippet below) but that did not do the trick.
Does that functionality simply not work or am I missing something?
Thanks!
Ferry
$campaign_data = new Campaign();
$campaign_data->sourceTemplateId='442';
$campaign_data->folderId='1137';
$campaign_data->currentStatus='draft';

Hi Richard,
Unfortunately no. I reached out to support, they informed me "sourceTemplateId" could not be used to create new campaigns based on a template, instead they advised to use the "Elements " property as shown in this example: Eloqua REST API - Create a Campaign with a Segment and Email
Thanks
Ferry

Post/Create a poll using Yammer REST API

Hi everybody,
I have been working on a project where there is a requirement to develop a custom web part that displays the feeds from Yammer. Also, the logged in user should be able to post messages, attachments, polls from the web part.
I was able to post messages and attachments using rest api and with yammer embed. But I couldn't find any information/documentation on how to post/create a poll via Yammer API using JavaScript. I've browsed through the documentation provided by Yammer( https://developer.yammer.com/documentation/ )
and googled a lot, but couldn't get any help.
Any suggestions regarding this would be highly appreciated.
Regards,
Srivikas Nallamilli.
-- Thanks & Regards, Srivikas.

Hi,
Use the same API that you use to fetch messages from yammer i.e https://www.yammer.com/api/v1/messages.json
When you post a poll, above api will return json respose something as below:
"external_references":[
"meta":{
"requested_poll_interval":60,
"realtime":{
"uri":"https://7-791.rt.yammer.com/cometd/",
"authentication_token":<TOKEN>
"channel_id":<CHANNEL ID>
"last_seen_message_id":null,
"current_user_id":1530316230,
"followed_references":[
"ymodules":[
"id":12147685,
"inline_html":"<INLINE HTML>",
"viewer_id":1530316230
"newest_message_details":null,
"feed_name":"Company Feed",
"feed_desc":"",
"direct_from_body":false
you will get the poll message in inline html section highlighted in code above.
Let me know if it works.
Thanks,
Avni Bhatt
If this helped you resolve your issue, please mark it Answered

HTTP REST API call to CPSC 10.x from an external system

Hi,
I would like to know the below items.
Is it possible to connect with the CPSC 10.x from an external system via HTTP REST API call to process a request and complete a task?
Is it possible to create a new ticket / request in CPSC for a specific service via the HTTP REST API call?
One of the use case is to know how many requests are pending in a queue via a HTTP REST API call? How to pass a queue name in the HTTP REST API call to get the result? These kind of custom piece is not available in the integration guide.
Is there any specific REST API guide available which Cisco provides for the REST capability in CPSC?
Any help is highly appreciated!
Thanks.

When a task is invoked from a service catalog request to an external system, the request remains open and the task is pending until the external system issues a call to complete the task. The API for completing the task is SOAP-based. Check out the Cisco Prime Service Catalog Integration Guide. Within the doc, go to the section about "Web Service Listener Adapter" for the WSDL.
You can order a service within Prime Service Catalog with a SOAP call, which is also documented in this same document. Starting with Prime Service Catalog 10.1, you will have a way to order a service via a REST API.
Existing REST APIs are also documented in the integration guide.

Project 2013 REST API - getting all tasks assigned to a user

I'm trying to get all tasks assigned to a user to display something like you would see in "My Tasks" using the REST API.
I found this: http://social.technet.microsoft.com/Forums/projectserver/en-US/a5d8760d-8e27-432b-8187-592cadf302ae/get-my-tasks-tasks-via-rest-api-or-web-services?forum=sharepointdevelopment
But it doesn't seem to pertain to Project 2013.
Any idea on how I could do this?
As an aside, I'm having some trouble with finding guidance in the documentation. Are there any Project 2013 developer resources that break things down a little more than the SDK? Everything I've found is pretty Sharepoint-centered, not really getting into
the specifics of Project.

Check the samples folder which gets installed with SDK, there you will find some samples, however may not be the REST but with CSOM you could try something like this, i am sure you would be able to convert this pretty easily, in case required
projContext = new ProjectContext(pwaPath);
var PrjList = projContext.LoadQuery(projContext.Projects.Where(Prj => Prj.Name == newProjName));
projContext.ExecuteQuery();
var GotPrj = PrjList.First();
//DraftProject projCheckedOut = GotPrj.CheckOut();
projContext.Load(GotPrj.Tasks);
projContext.ExecuteQuery();
foreach (var tsk in GotPrj.Tasks)
this.textBox1.Text += Environment.NewLine + "Task Name: " + tsk.Name + " || Task Work: " + tsk.Work +" || Task Remaining Work: " +tsk.RemainingWork;
projContext.Load(tsk.Assignments);
projContext.ExecuteQuery();
foreach (var tskAssgn in tsk.Assignments)
projContext.Load(tskAssgn.Resource);
projContext.ExecuteQuery();
this.textBox1.Text += Environment.NewLine + tskAssgn.Resource.Name + "--Res ID--" + tskAssgn.Resource.Id +
"----Assgn ID: " + tskAssgn.Id + " || Actual Work: " + tskAssgn.ActualWork +
" || Assgn Remaining Work: " + tskAssgn.RemainingWork
+ " || Assgn minDate: " + tskAssgn.Start
+ " || Assgn maxDate: " + tskAssgn.Finish
Thanks | epmXperts | http://epmxperts.wordpress.com

Rest API Documentation

Similar Messages

Maybe you are looking for