Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The module exposes the OpenMRS API as REST web services.  if If an OpenMRS instance is running the Webservices.REST module, other programs (and languages) can connect to retrieve and post certain information to an OpenMRS database.

...

Source at: https://github.com/openmrs/openmrs-module-webservices.rest
Download at: https://addons.openmrs.org/#/show/org.openmrs.module.webservices-rest

User Documentation

Visit https://rest.openmrs.org/#openmrs-rest-api for an overview of our Rest Documentation.

Required OpenMRS Version

The REST Web Services module requires at least OpenMRS 1.9.0 or 1.8.1 to run.

...

Configuration keyDescription
webservices.rest.maxResultsDefaultThis setting determines the maximum number of resources that can be accessed on any webservice call.  The default is *50*.
webservices.rest.maxResultsAbsoluteThis setting determines the absolute maximum number of resources that can be accessed on any web service call. If the client requests more than this limit, then receives an error. The default is 1000.
webservices.rest.uriPrefix

This should point at the root of your exposed web application.  This is typically http://localhost:8080/openmrs during testing, but after being deployed will be something like http://192.168.1.100/openmrs or http://yourdomainname.org/openmrs.

If this is empty or not filled in, the user will see NEEDSTOBECONFIGURED/ws/rest/ as the "self" urls on all objects.

webservices.rest.allowedips

By default this is an empty string: "", which means anyone can access the rest URLs. If you put any IP addresses into this list, only calls from those are allowed. IPs should be separated by a whitespace or a comma.

IPs can be declared with bit masks to denote whole subdomains e.g. 10.0.0.0/30 matches 10.0.0.0 - 10.0.0.3 and 10.0.0.0/24 matches 10.0.0.0 - 10.0.0.255. Non matching IP addresses will receive a 403 HTTP error. Both IPv4 and IPv6 addresses are supported.

...

Release Notes



  • 2.14+
    • See JIRA for details
  • 2.13 Released January 7th 2016
    • Add support for OpenMRS Platform 2.0.0 (beta)
    • And:
      Jira Legacy
      serverOpenMRS JIRA
      columnskey,summary,type,assignee,reporter,priority
      maximumIssues1000
      jqlQueryproject = RESTWS AND fixVersion = 2.9 ORDER BY updated DESC, priority DESC, created ASC
      serverId45c5771b-fa4b-3e43-b34a-c19dc45ccc95
  • 2.12
    Jira Legacy
    serverOpenMRS JIRA
    columnskey,summary,type,assignee,reporter,priority
    maximumIssues1000
    jqlQueryproject = RESTWS AND fixVersion = 2.9 ORDER BY updated DESC, priority DESC, created ASC
    serverId45c5771b-fa4b-3e43-b34a-c19dc45ccc95
  • 2.11
    Jira Legacy
    serverOpenMRS JIRA
    columnskey,summary,type,assignee,reporter,priority
    maximumIssues1000
    jqlQueryproject = RESTWS AND fixVersion = 2.9 ORDER BY updated DESC, priority DESC, created ASC
    serverId45c5771b-fa4b-3e43-b34a-c19dc45ccc95
  • 2.10
    Jira Legacy
    serverOpenMRS JIRA
    columnskey,summary,type,assignee,reporter,priority
    maximumIssues1000
    jqlQueryproject = RESTWS AND fixVersion = 2.9 ORDER BY updated DESC, priority DESC, created ASC
    serverId45c5771b-fa4b-3e43-b34a-c19dc45ccc95
  • 2.9 Released January 15th 2015

    Jira Legacy
    serverOpenMRS JIRA
    columnskey,summary,type,assignee,reporter,priority
    maximumIssues1000
    jqlQueryproject = RESTWS AND fixVersion = 2.9 ORDER BY updated DESC, priority DESC, created ASC
    serverId45c5771b-fa4b-3e43-b34a-c19dc45ccc95

     
  • 2.8
  • 2.7

    Release Date: Wednesday November 26th 2014

    2.7 represents version: 20afb1bcdbc46a75859e2c736a8651fa38614720
     

    A huge thank you goes out to the following contributors: Daniel Kayiwa, Darius Jazayeri, Jon Skeet, Pawe? Muchowski, Rafal Korytkowski, Willa Ahmed, Wyclif Luyima

    New Features

    • [RESTWS-453] - Expose login locations via REST
    • [RESTWS-455] - Add ConceptSearchResource
    • [RESTWS-457] - orderfrequency resource should have a representation that includes the full concept representation
    • [RESTWS-461] - Should automatically convert to Double
    • [RESTWS-463] - encounter resource should let you create real-time encounters without explicitly specifying encounterDatetime
    • [RESTWS-465] - Get inactive orders

    Bug Fixes

    • [RESTWS-451] - Nested custom type will fail with conversion exception
    • [RESTWS-454] - deathDate property should be editable on the person resource
    • [RESTWS-458] - orderfrequency resource should have display property
    • [RESTWS-464] - encounter resource has a typo that prevents creating an encounter with orders easily
    • [RESTWS-467] - Going to catalog API using JSON causes stack overflow due to subtypes
    • [RESTWS-469] - NPE generating catalog
    • [RESTWS-470] - Catalog incorrectly shows sub-resources
    • [RESTWS-471] - A resource implementing Listable without Searchable fails in MainResourceController
  • 2.6

...

...