This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.
Working with Note in Evernote
Overview
The following operations allow you to carry out note operations. Click an operation name to see details on how to use it.
For a sample proxy service that illustrates how to work with note, see Sample configuration.
Operation | Description |
---|---|
Makes a new Note in an existing Notebook. | |
deleteNote | Moves a single existing Note to the trash. |
updateNote | Changes the content or metadata of a single existing Note. |
getNote | Retrieves the state of a single Note. |
expungeNote | Permanently removes an existing Note. |
shareNote | If this note is not already shared (via its own direct URL), then this will start sharing that note. |
stopSharingNote | If this note is not already shared then this will stop sharing that note. |
findNotesMetaData | Used to find the high-level information about a set of the notes from a user's account. |
Operation details
This section provides details on each of the operations.
Create a Note
The createNote
method allows you to create a note under an available notebook.
<evernote.createNote> <title>{$ctx:title}</title> <content>{$ctx:content}</content> <notebookGuid>{$ctx:notebookGuid}</notebookGuid> <sourceURL>{$ctx:sourceURL}</sourceURL> <mime>{$ctx:mime}</mime> <fileName>{$ctx:fileName}</fileName> <tagName>{$ctx:tagName}</tagName> </evernote.createNote>
Properties
title : Required-:The subject of the note. Can't begin or end with a space.
content :Optional. Content of the note
notebookGuid : Optional. The unique identifier of the notebook that contains this note
sourceURL :Optional. the original location where the resource was hosted
mime : Optional. The MIME type for the embedded resource
fileName : Optional. if the resource came from a source that provided an explicit file name, the original name will be stored here. Many resources come from unnamed sources, so this will not always be set.
tagName : Optional. May be provided by clients during calls to createNote() as an alternative to providing the tagGuid of existing tag.
Sample request
Following is a sample request that can be handled by the createNote operation.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Envelope xmlns:evr="wso2.connector.evernote"> <soapenv:Header></soapenv:Header> <soapenv:Body> <root> <evr:devToken>S=s424:U=48524b0:E=14e531dc27f:C=146fb6c9600:P=1cd:A=en-devtoken:V=2:H=4a4e288787109ed314ebce861c5c2c92</evr:devToken> <evr:noteStoreUrl>https://www.evernote.com/shard/s424/notestore</evr:noteStoreUrl> <evr:devTokenType>SANDBOX</evr:devTokenType> <evr:title>test title</evr:title> <evr:content>Test Note</evr:content> </root> </soapenv:Body> </soapenv:Envelope> </soapenv:Body> </soapenv:Envelope>
Related Evernote documentation
Deleting a note
The deleteNote
moves the note into the trash. The note may still be undeleted.
<evernote.deleteNote> <noteGuid>{$ctx:noteGuid}</noteGuid> </evernote.deleteNote>
Properties
noteGuid :- Required. The GUID of the note to delete.
Sample request
Following is a sample request that can be handled by the deleteNote operation.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Envelope xmlns:evr="wso2.connector.evernote"> <soapenv:Header></soapenv:Header> <soapenv:Body> <root> <evr:devToken>S=s424:U=48524b0:E=14e531dc27f:C=146fb6c9600:P=1cd:A=en-devtoken:V=2:H=4a4e288787109ed314ebce861c5c2c92</evr:devToken> <evr:noteStoreUrl>https://www.evernote.com/shard/s424/notestore</evr:noteStoreUrl> <evr:devTokenType>SANDBOX</evr:devTokenType> <evr:noteGuid>1523462cc29c48f4974e842e8cceeb98</evr:noteGuid> </root> </soapenv:Body> </soapenv:Envelope> </soapenv:Body> </soapenv:Envelope>
Related Evernote documentation
Updating a note
The updateNote
operation submit a set of changes to a note to the service .
<evernote.updateNote> <noteGuid>{$ctx:noteGuid}</noteGuid> <title>{$ctx:title}</title> <content>{$ctx:content}</content> <notebookGuid>{$ctx:notebookGuid}</notebookGuid> <sourceURL>{$ctx:sourceURL}</sourceURL> <mime>{$ctx:mime}</mime> <fileName>{$ctx:fileName}</fileName> <active>{$ctx:active}</active> <tagName>{$ctx:tagName}</tagName> </evernote.updateNote>
Properties
noteGuid :-Required:- The unique identifier of this note.
title :-Required :- The note's title must also be set.
content :- Optional. Content of the note
notebookGuid :-Required. The unique identifier of the notebook that contains this note
sourceURL :-Optional .The original location where the resource was hosted .
mime :- Optional. The MIME type for the embedded resource.
fileName :-Optional. Name of the file to update
active :-Optional. If the note is available for normal actions and viewing, this flag will be set to true.
tagName :-Optional. Provided by clients during calls to createNote() as an alternative to providing the tagGuids of existing tags.
Sample request
Following is a sample request that can be handled by the updateNote operation.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Envelope xmlns:evr="wso2.connector.evernote"> <soapenv:Header></soapenv:Header> <soapenv:Body> <root> <evr:devToken>S=s424:U=48524b0:E=14e531dc27f:C=146fb6c9600:P=1cd:A=en-devtoken:V=2:H=4a4e288787109ed314ebce861c5c2c92</evr:devToken> <evr:noteStoreUrl>https://www.evernote.com/shard/s424/notestore</evr:noteStoreUrl> <evr:devTokenType>SANDBOX</evr:devTokenType> <evr:noteGuid>1523462cc29c48f4974e842e8cceeb98</evr:noteGuid> <evr:title>testing update title</evr:title> <evr:content>Test Note done</evr:content> </root> </soapenv:Body> </soapenv:Envelope> </soapenv:Body> </soapenv:Envelope>
Related Evernote documentation
Get Note
The getNote
retrieves a note by note guid.
<evernote.getNote> <noteGuid>{$ctx:noteGuid}</noteGuid> </evernote.getNote>
Properties
noteGuid :Required. The GUID of the note to delete.
Sample request
Following is a sample request that can be handled by the getNote operation.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Envelope xmlns:evr="wso2.connector.evernote"> <soapenv:Header></soapenv:Header> <soapenv:Body> <root> <evr:devToken>S=s424:U=48524b0:E=14e531dc27f:C=146fb6c9600:P=1cd:A=en-devtoken:V=2:H=4a4e288787109ed314ebce861c5c2c92</evr:devToken> <evr:noteStoreUrl>https://www.evernote.com/shard/s424/notestore</evr:noteStoreUrl> <evr:devTokenType>SANDBOX</evr:devTokenType> <evr:noteGuid>1523462cc29c48f4974e842e8cceeb98</evr:noteGuid> </root> </soapenv:Body> </soapenv:Envelope> </soapenv:Body> </soapenv:Envelope>
Related Evernote documentation
Expunge a Note
The expungeNote
operation permanently removes a Note, and all of its Resources, from the service.
<evernote.expungeNote> <noteGuid>{$ctx:noteGuid}</noteGuid> </evernote.expungeNote>
Properties
noteGuid :- Required. The GUID of the note to delete.
Sample request
Following is a sample request that can be handled by the expungeNote operation.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Envelope xmlns:evr="wso2.connector.evernote"> <soapenv:Header></soapenv:Header> <soapenv:Body> <root> <evr:devToken>S=s424:U=48524b0:E=14e531dc27f:C=146fb6c9600:P=1cd:A=en-devtoken:V=2:H=4a4e288787109ed314ebce861c5c2c92</evr:devToken> <evr:noteStoreUrl>https://www.evernote.com/shard/s424/notestore</evr:noteStoreUrl> <evr:devTokenType>SANDBOX</evr:devTokenType> <evr:noteGuid>1523462cc29c48f4974e842e8cceeb98</evr:noteGuid> </root> </soapenv:Body> </soapenv:Envelope> </soapenv:Body> </soapenv:Envelope>
Related Evernote documentation
Stop Sharing Note
If this note is already shared then stopShareNote
operation will stop sharing that note.
<evernote.stopSharingNote> <noteGuid>{$ctx:noteGuid}</noteGuid> </evernote.stopSharingNote>
Properties
noteGuid :- Required. GUID of the note to be un-shared
Sample request
Following is a sample request that can be handled by the stopShareNote operation.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Envelope xmlns:evr="wso2.connector.evernote"> <soapenv:Header></soapenv:Header> <soapenv:Body> <root> <evr:devToken>S=s424:U=48524b0:E=14e531dc27f:C=146fb6c9600:P=1cd:A=en-devtoken:V=2:H=4a4e288787109ed314ebce861c5c2c92</evr:devToken> <evr:noteStoreUrl>https://www.evernote.com/shard/s424/notestore</evr:noteStoreUrl> <evr:devTokenType>SANDBOX</evr:devTokenType> <evr:noteGuid>1523462cc29c48f4974e842e8cceeb98</evr:noteGuid> </root> </soapenv:Body> </soapenv:Envelope> </soapenv:Body> </soapenv:Envelope>
Related Evernote documentation
sharing a Note
If this note is not already shared , then this will start sharing that note. This will return the secret "Note Key" for this note .
<evernote.shareNote> <noteGuid>{$ctx:noteGuid}</noteGuid> </evernote.shareNote>
Properties
noteGuid :-Required. The GUID of the note to be shared.
Sample request
Following is a sample request that can be handled by the shareNote operation.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Envelope xmlns:evr="wso2.connector.evernote"> <soapenv:Header></soapenv:Header> <soapenv:Body> <root> <evr:devToken>S=s424:U=48524b0:E=14e531dc27f:C=146fb6c9600:P=1cd:A=en-devtoken:V=2:H=4a4e288787109ed314ebce861c5c2c92</evr:devToken> <evr:noteStoreUrl>https://www.evernote.com/shard/s424/notestore</evr:noteStoreUrl> <evr:devTokenType>SANDBOX</evr:devTokenType> <evr:noteGuid>1523462cc29c48f4974e842e8cceeb98</evr:noteGuid> </root> </soapenv:Body> </soapenv:Envelope> </soapenv:Body> </soapenv:Envelope>
Related Evernote documentation
findNotesMetaData
Used to find the high-level information about a set of the notes from a user's account based on various criteria specified via a NoteFilter object.
<evernote.findNotesMetaData> <ascending>{$ctx:ascending} </ascending> <words>{$ctx:words}</words> <notebookGuid>{$ctx:notebookGuid}</notebookGuid> <inactive>{$ctx:inactive}</inactive> <emphasized>{$ctx:emphasized}</emphasized> <offset>{$ctx:offset}</offset> <maxNotes>{$ctx:maxNotes}</maxNotes> <includeTitle>{$ctx:includeTitle}</includeTitle> <includeContentLength>{$ctx:includeContentLength}</includeContentLength> <includeCreated>{$ctx:includeCreated}</includeCreated> <includeUpdated>{$ctx:includeUpdated}</includeUpdated> <includeDeleted>{$ctx:includeDeleted}</includeDeleted> <includeUpdateSequenceNum>{$ctx:includeUpdateSequenceNum}</includeUpdateSequenceNum> <includeNotebookGuid>{$ctx:includeNotebookGuid}</includeNotebookGuid> <includeTagGuids>{$ctx:includeTagGuids}</includeTagGuids> <includeAttributes>{$ctx:includeAttributes}</includeAttributes> <includeLargestResourceMime>{$ctx:includeLargestResourceMime}</includeLargestResourceMime> </evernote.findNotesMetaData>
Properties
ascending :-Required. The NoteSortOrder value indicating what criterion should be used to sort the results of the filter.
words :-Optional. A search query string that will filter the set of notes to be returned.
notebookGuid :-.-Required.The Guid of the notebook that must contain the notes.
inactive :-Required.If true, then only notes that are not active will be returned.Otherwise, only active notes will be returned
emphasized :-Required. If present, a search query string that may or may not influence the notes to be returned.
offset :-Required. The numeric index of the first note to show within the sorted results.
maxNotes :-Required.The maximum notes to return in this query. The service will return a set of notes that is no larger than this number.
includeTitle :-Optional. if this field is set to “true” on this structure when calling findNotesMetadata, then each NoteMetadata in the list should have its 'title' field set. if it is not set then it will be treated as 'false'.
includeContentLength :-Optional. This field is set to “True” when calling findNotesMetadata if it is not set then it will be treated as 'false'.
includeCreated :-Optional. This field is set to “True” when calling findNotesMetadata if it is not set then it will be treated as 'false'.
includeUpdated :-Optional. This field is set to “True” when calling findNotesMetadata if it is not set then it will be treated as 'false'.
includeDeleted :-Optional. This field is set to “True” when calling findNotesMetadata if it is not set then it will be treated as 'false'.
includeUpdateSequenceNum :-Optional. This field is set to “True” when calling findNotesMetadata if it is not set then it will be treated as 'false'.
includeNotebookGuid :-Optional. This field is set to “True” when calling findNotesMetadata if it is not set then it will be treated as 'false'.
includeTagGuids :-Optional. This field is set to “True” when calling findNotesMetadata if it is not set then it will be treated as 'false'.
includeAttributes :-Optional. This field is set to “True” when calling findNotesMetadata if it is not set then it will be treated as 'false'.
includeLargestResourceMime :-Optional. This field is set to “True” when calling findNotesMetadata if it is not set then it will be treated as 'false'.
Sample request
Following is a sample request that can be handled by the findNotesMetaData operation.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <soapenv:Envelope xmlns:evr="wso2.connector.evernote"> <soapenv:Header></soapenv:Header> <soapenv:Body> <root> <evr:devToken>S=s424:U=48524b0:E=14e531dc27f:C=146fb6c9600:P=1cd:A=en-devtoken:V=2:H=4a4e288787109ed314ebce861c5c2c92</evr:devToken> <evr:noteStoreUrl>https://www.evernote.com/shard/s424/notestore</evr:noteStoreUrl> <evr:devTokenType>SANDBOX</evr:devTokenType> <evr:noteGuid>1523462cc29c48f4974e842e8cceeb98</evr:noteGuid> <evr:ascending>true</evr:ascending> <evr:inactive>false</evr:inactive> <evr:offset>0</evr:offset> <evr:maxNotes>100</evr:maxNotes> <evr:includeTitle>true</evr:includeTitle> <evr:includeContentLength>false</evr:includeContentLength> <evr:includeCreated>true</evr:includeCreated> <evr:includeUpdated>true</evr:includeUpdated> <evr:includeDeleted>false</evr:includeDeleted> <evr:includeUpdateSequenceNum>true</evr:includeUpdateSequenceNum> <evr:includeNotebookGuid>false</evr:includeNotebookGuid> <evr:includeTagGuids>true</evr:includeTagGuids> <evr:includeAttributes>true</evr:includeAttributes> <evr:includeLargestResourceMime>true</evr:includeLargestResourceMime> </root> </soapenv:Body> </soapenv:Envelope> </soapenv:Body> </soapenv:Envelope>
Related Evernote documentation
Sample configuration
Following is a sample proxy service that illustrates how to connect to Evernote with the init operation and use the createNote operation. You can use this sample as a template for other operation. The sample request for this proxy can be found in Sample Request for createNote.
<?xml version="1.0" encoding="UTF8"?> <proxy xmlns="http://ws.apache.org/ns/synapse" name="createNote" transports="https,http" statistics="disable" trace="disable" startOnLoad="true"> <target> <inSequence> <property xmlns:ns="wso2.connector.evernote" name="devToken" expression="//ns:devToken"/> <property xmlns:ns="wso2.connector.evernote" name="devTokenType" expression="//ns:devTokenType"/> <property xmlns:ns="wso2.connector.evernote" name="noteStoreUrl" expression="//ns:noteStoreUrl"/> <property xmlns:ns="wso2.connector.evernote" name="title" expression="//ns:title"/> <property xmlns:ns="wso2.connector.evernote" name="content" expression="//ns:tagName"/> <property xmlns:ns="wso2.connector.evernote" name="notebookGuid" expression="//ns:notebookGuid"/> <property xmlns:ns="wso2.connector.evernote" name="sourceURL" expression="//ns:sourceURL"/> <property xmlns:ns="wso2.connector.evernote" name="mime" expression="//ns:mime"/> <property xmlns:ns="wso2.connector.evernote" name="fileName" expression="//ns:fileName"/> <property xmlns:ns="wso2.connector.evernote" name="tagName" expression="//ns:tagName"/> <evernote.init> <devToken>{$ctx:devToken}</devToken> <noteStoreUrl>{$ctx:noteStoreUrl}</noteStoreUrl> <devTokenType>{$ctx:devTokenType}</devTokenType> </evernote.init> <evernote.createNote> <title>{$ctx:title}</title> <content>{$ctx:content}</content> <notebookGuid>{$ctx:notebookGuid}</notebookGuid> <sourceURL>{$ctx:sourceURL}</sourceURL> <mime>{$ctx:mime}</mime> <fileName>{$ctx:fileName}</fileName> <tagName>{$ctx:tagName}</tagName> </evernote.createNote> <respond/> </inSequence> <outSequence> <send/> </outSequence> </target> <description/> </proxy>