Amazing Marvin¶
The Amazing Marvin modules allow you to create, update, search, retrieve, and delete the tasks from your Amazing Marvin account.
Getting Started with Amazing Marvin¶
Prerequisites
An Amazing Marvin account - create an account at amazingmarvin.com/.
Connecting Amazing Marvin to Ibexa Connect¶
To connect your Amazing Marvin account to Ibexa Connect you need to obtain the API Key from your Amazing Marvin account and insert it in the Create a connection dialog in the Ibexa Connect module.
-
Log in to your Amazing Marvin account.
-
Go to URL Address, Amazing Marvin API Credentials
-
Copy the API Key to your clipboard
-
Log in to your Ibexa Connect account, add a module from the Amazing Marvin app into an Ibexa Connect scenario.
-
Click Add next to the Connection field.
-
In the Connection name field, enter a name for the connection.
-
In the API Key enter the details copied in step 3 and click Continue.
The connection has been established.
Connecting Amazing Marvin database to Ibexa Connect¶
The Update a Task, Search Tasks, Delete a Task, Get a Task, and Make an API Call modules all require a database connection with Amazing Marvin. You need API credentials from Amazing Marvin.
-
Log in to your Amazing Marvin account.
-
Go to URL Address, Amazing Marvin API Credentials
-
Copy the
syncUser
,syncPassword
,syncServer
, andsyncDatabase
fields. Keep this open in a separate tab or browser for easier copy-pasting. -
Log in to your Ibexa Connect account, add a Update a Task, Search Tasks, Delete a Task, Get a Task, or Make an API Call module from the Amazing Marvin app into an Ibexa Connect scenario.
-
In the Connection name field, enter a name for the connection.
-
Enter the
syncUser
key in the Username field. -
Enter the
syncPassword
key in the Password field. -
Enter the
syncServer
key in the Database URL field. -
Enter the
syncDatabase
key in the Database Name field.
Task¶
Create a Task¶
Creates a new task.
Done |
Select whether the task needs to be done. |
Day |
Enter (map) the day on which the task is to be executed. |
Title |
Enter (map) a title for the task to create. |
Parent ID |
Enter (map) a Parent ID for the task to create. |
Label IDs |
Select or map the Label IDs to add to the task. |
First Scheduled |
Enter (map) the scheduled date for the task. |
Rank |
Enter (map) the rank for the task to update. |
Daily Section |
Select the daily section for the task:
|
Bonus Section |
Enter (map) the bonus sections for the task. |
Note |
Enter (map) the note for the task being created. |
Due Date |
Enter (map) the due date to create the task. |
Update a Task¶
Updates a task.
Username |
Enter (map) the syncUser details of your account. |
Password |
Enter (map) the syncPassword details of your account. |
Database URL |
Enter (map) the syncServer details of your account. |
Database Name |
Enter (map) the syncDatabase details of your account. |
Task ID |
Select or map the Task ID to update a task. |
Done |
Select whether the task needs to be done. |
Day |
Enter (map) the day on which the task is to be executed. |
Title |
Enter (map) a title for the task to create. |
Parent ID |
Enter (map) a Parent ID for the task to update. |
Label IDs |
Select or map the Label IDs to add to the task. |
First Scheduled |
Enter (map) the updated scheduled date for the task. |
Rank |
Enter (map) the rank for the task to update. |
Daily Section |
Select the daily section for the task:
|
Bonus Section |
Enter (map) the bonus sections for the task. |
Note |
Enter (map) the updated note for the task. |
Due Date |
Enter (map) the due date to create the task. |
Search Tasks¶
Searches for a specific task or lists them all.
Done |
Select whether the task needs to be done. |
Day |
Enter (map) the day on which the task was executed to search. |
Title |
Enter (map) a title for the task to search. |
Parent ID |
Enter (map) a Parent ID for the task to search. |
Label IDs |
Select or map the Label IDs to search the task. |
First Scheduled |
Enter (map) the scheduled date of the task to retrieve. |
Rank |
Enter (map) the rank of the task to search. |
Daily Section |
Select the daily section for the task:
|
Bonus Section |
Enter (map) the bonus sections for the task. |
Note |
Enter (map) the note for the task being created. |
Due Date |
Enter (map) the due date of the task to search. |
Limit |
Set the maximum number of tasks Ibexa Connect should return during one execution cycle. The default value is 10. |
Delete a Task¶
Deletes a task.
Task ID | Select or map the Task ID to delete a task. |
Get a Task¶
Returns a certain task.
Task ID | Select or map the Task ID to retrieve a task. |
Others¶
Make an API Call¶
Makes an API request to Database using CouchDB API
URL |
Enter a path relative to For example: For the list of available endpoints, refer to the CouchDB API Documentation. |
Method |
Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
Headers |
Enter the desired request headers. You don't have to add authorization headers; we already did that for you. |
Query String |
Enter the request query string. |
Body |
Enter the body content for your API call. |
Example of Use - List¶
The following API call returns all documents from your Amazing Marvin account:
URL: /_all_docs
Method: GET
Matches of the search can be found in the module's Output under Bundle > Body. In our example, 56 documents were returned: