Skip to content

NCIEVS/evsrestapi-client-SDK

Repository files navigation

EVSRESTAPI Client SDK

This is an easy-to-use tutorial for accessing EVSRESTAPI APIs.

Table of Contents

  1. Tutorials by Language
  2. Use Cases
  3. Resources
  4. Contributing
  5. License

Tutorials by Language

Back to top

Use Cases

The following cases are used to demonstrate accessing the EVS REST API. Each of the "Tutorials by language" provides specific details on how to implement them specifically in the technology approach used by that tutorial.

  • Get terminologies
  • Get concept by code (minimum information)
  • Get concepts by list of codes (minimum information)
  • Get concept by code (summary information)
  • Get concept by code (full information)
  • Get concept by code (custom include)
  • Get concept part
  • Get concept descendants
  • Get all properties
  • Get property by code (or label)
  • Get qualifier values by code (or label)
  • Get all roles
  • Get role by code (or label)
  • Get all associations
  • Get association by code (or label)
  • Get all term types
  • Get all definition sources
  • Get all synonym sources
  • Get all synonym types
  • Get synonym types by code
  • Get all definition types
  • Get definition types by code
  • Find root concepts
  • Get paths to/from root from a code
  • Get paths to an ancestor from a code
  • Get subtree for a code
  • Find concepts by search term (use paging to get only first 5 results)
  • Find concepts by search term (restrict by concept status)
  • Find concepts by search term (restrict by definition source)
  • Find concepts by search term (restrict by definition type)
  • Find concepts by search term (restrict by synonym source and termgroup)
  • Find concepts by search term (restrict by synonym type)
  • Find concepts by search term (where term is a code)
  • Find concepts by search term (using type=match)
  • Find concepts by search term (using type=startsWith)
  • Find concepts by search term (using type=phrase)
  • Find concepts by search term (using type=fuzzy)
  • Find concepts by search term (using type=AND)
  • Find concepts by search term (using type=OR)
  • Find concepts by search term (with highlights)
  • Find concepts by property
  • Find concepts by subset
  • Find concepts by SPARQL code
  • Find concepts based on associations query
  • Get all subsets
  • Get subset by code
  • Get subset members by subset code
  • Get all mapsets
  • Get mapset by code
  • Get maps by mapset code
  • Get replacement concepts for an inactive concept code
  • Get replacement concepts for a list of inactive concept codes
  • Get SPARQL bindings from query

All of the tutorials use an environment variable for the API URL of the deployment:

Back to top

Resources

Back to top

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request

Back to top

Current Contributors

Back to top

License

See the included LICENSE file for details.

Back to top