This is the Ona API and OnaData code documentation.
Ona JSON Rest Api Endpoints¶
Authentication¶
Data Endpoints¶
- Charts
- Data
- GET JSON List of data end points
- GET JSON List of data end points using limit operators
- Download data in csv format
- GET JSON List of data end points filter by owner
- Get Submitted data for a specific form
- Paginate data of a specific form
- Sort submitted data of a specific form using existing fields
- Get a single data submission for a given form
- Get the history of edits made to a submission
- Query submitted data of a specific form
- Query submitted data of a specific form using Tags
- Tag a submission data point
- Delete a specific tag from a submission
- Get list of public data endpoints
- Get enketo edit link for a submission instance
- Delete a specific submission instance
- GEOJSON
- OSM
- DataView
- Definition
- Create a new DataView
- Retrieve a DataView
- List all DataView
- Update a DataView
- Patch a DataView
- Delete a DataView
- Retrieving Data from the DataView
- Retrieving Data using limit operators
- Counting the Data in the DataView
- Example
- Response
- Example
- Response
- Example
- Response
- Example
- Response
- Example
- Response
- Widgets
- Stats
Forms¶
- Forms
- Publish XLSForms, List, Retrieve Published Forms.
- Get list of forms
- Get list of forms filter by owner
- Get Form Information
- Set Form Information
- Replacing a Form
- Delete Form
- List of form data exports
- Export form data asynchronously
- Google Sheets Export
- Export submitted data of a specific form version
- Check progress of exporting form data asynchronously
- Delete an XLS form asynchronously
- List Forms
- Get JSON | XML | XLS Form Representation
- Get list of forms with specific tag(s)
- Get list of Tags for a specific Form
- Tag forms
- Delete a specific tag
- Get list of forms containing data with osm files
- Get webform/enketo link
- Get webform/enketo link with default form values
- Get form data in xls, csv format.
- Get list of public forms
- Share a form with a specific username or usernames
- Preview a survey draft
- Import CSV data to existing form
- Upload a XLS form async
- Check on XLS form upload progress
- Attachments and Media
- Metadata
- Notes
- Files
- Projects
- Register a new Project
- List of Projects
- List of Projects filter by owner/organization
- Retrieve Project Information
- Update Project Information
- Available Permission Roles
- Share a project with a specific user
- Send an email to users on project share
- Remove a user from a project
- Assign a form to a project
- Upload XLSForm to a project
- Get forms for a project
- Get list of projects with specific tag(s)
- Get list of Tags for a specific Project
- Tag a Project
- Remove a tag from a Project
- Add a star to a project
- Remove a star to a project
- Get user profiles that have starred a project
- Form Submissions
- RestServices
Submission Stats¶
Users and Organizations¶
- Organizations
- Register a new Organization
- List of Organizations
- List of Organizations Shared with Another User
- Retrieve Organization Profile Information
- Partial updates of Organization Profile Information
- List Organization members
- Add a user to an organization
- Send an email to a user added to an organization
- Change the role of a user in an organization
- Remove a user from an organization
- Profiles
- Teams
- User
- Users
Running your own server¶
- Ubuntu installation instructions
- Prepare OS
- Database setup
- Get the code
- Set up and start your virtual environment or sandbox
- Create a local_settings.py and update it accordingly
- Run make to set up onadata and for initial db setup
- Compile api docs
- Copy static files to static dir
- Setup uwsgi init script
- Setup celery service
- Setup nginx
- Mac OS Installation Instructions