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/.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

Overview

The following operations allow you to work with reminders. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with reminders, see Sample configuration. 

OperationDescription

createReminder

Creates a reminder on an object.

getReminderRetrieves the reminder details.

Operation details

This section provides further details on the operations related to reminders.

Creating a reminder on an object

The createReminder operation creates a reminder on an object.

createReminder 
<podio.createReminder>
    <refId>{$ctx:refId}</refId>
    <remindDelta>{$ctx:remindDelta}</remindDelta>
	<refType>{$ctx:refType}</refType>
</podio.createReminder>
Properties
  • refId: The ID of the object the reminder is on.
  • remindDelta: The number of minutes to remind before the due date of the object.
  • refType: The type of the object the reminder is on.
Sample request

Following is a sample REST/JSON request that can be handled by the createReminder operation.

Sample Request for createReminder 
{
  "apiUrl": "https://api.podio.com",
  "accessToken": "d562991e24ef4eca9e3adfe2afe31550",
  "refType": "task",
  "refId": "28856457",
  "remindDelta":"11"
}
Related Podio Documentation

https://developers.podio.com/doc/reminders/create-or-update-reminder-3315055

Retrieving the reminder details

The getReminder operation retrieves the reminder details for the given object.

getReminder 
<podio.getReminder>
    <refId>{$ctx:refId}</refId>
	<refType>{$ctx:refType}</refType>
</podio.getReminder>
Properties
  • refId: The ID of the object the reminder is on.
  • refType: The type of the object the reminder is on.
Sample request

Following is a sample REST/JSON request that can be handled by the getReminder operation.

Sample Request for getReminder 
{
  "apiUrl": "https://api.podio.com",
  "accessToken": "d562991e24ef4eca9e3adfe2afe31550",
  "refType": "task",
  "refId": "28856457"
}
Related Podio Documentation

https://developers.podio.com/doc/reminders/get-reminder-3415569

Sample configuration

Following is a sample proxy service that illustrates how to connect to Podio with the init operation and use the createReminder operation. The sample request for this proxy can be found in the createReminder sample request. You can use this sample as a template for using other operations in this category.

Sample Proxy
<?xml version="1.0" encoding="UTF-8"?>
<proxy xmlns="http://ws.apache.org/ns/synapse" name="podio_createReminder" transports="https,http" statistics="disable"
   trace="disable" startOnLoad="true">
   <target>
      <inSequence onError="faultHandlerSeq">
         <property name="apiUrl" expression="json-eval($.apiUrl)" />
         <property name="accessToken" expression="json-eval($.accessToken)" />
         <property name="refType" expression="json-eval($.refType)" />
         <property name="refId" expression="json-eval($.refId)" />
         <property name="remindDelta" expression="json-eval($.remindDelta)" />
         <podio.init>
            <apiUrl>{$ctx:apiUrl}</apiUrl>
            <accessToken>{$ctx:accessToken}</accessToken>
         </podio.init>
         <podio.createReminder>
            <refId>{$ctx:refId}</refId>
            <remindDelta>{$ctx:remindDelta}</remindDelta>
            <refType>{$ctx:refType}</refType>
         </podio.createReminder>
         <respond />
      </inSequence>
      <outSequence>
         <send />
      </outSequence>
   </target>
</proxy>
  • No labels