Versions Compared

Key

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

...

With the release of XNAT 1.7, a second API standard has been added, and will become the default for all new development. This is known as the XAPI. Swagger documentation for XAPI functions, as well as a live console for performing XAPI commands, is available inside your XNAT webapp at Administer > Site Administration > Miscellaneous > Swagger Page.

XNAT API Basics

Content by Label
showLabelsfalse
showSpacefalse
cqllabel = "api-basics"
labelsapi-basics

Content in development:

  • How to search XNAT via REST

 

 

API Notes for XNAT 1.7

Content in development:

  • /xapi vs /data vs /REST - XNAT 1.7 and the REST API Roadmap

 

The XNAT API Directory

Info

This Directory combines all legacy XNAT REST API and new-generation XAPI commands that come installed on a default XNAT. Plugins or customizations may add new API calls that will not be documented here.

See: XNAT 1.7 REST API Directory


XNAT API Tutorials

Content by Label
showLabelsfalse
showSpacefalse
cqllabel = "api-basics"
labelsapi-basics

Content in development:

  • How to search XNAT via REST