Class: exports

exports(message, path, responseData, response)

The error structure returned when a authorization failed

Constructor

new exports(message, path, responseData, response)

Construct a new AuthorizationError

Parameters:

Name	Type	Description
`message`	string	an message to return instead of the the default error message
`path`	string	the requested path
`responseData`	string \| object	responseData
`response`	Object	the object returned by fetch

Source:

Error/AuthorizationError.js, line 4

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(message, path, responseData, response)

The error structure returned when a request page is not found

Constructor

new exports(message, path, responseData, response)

Construct a new BadRequestError

Parameters:

Name	Type	Description
`message`	string	an message to return instead of the the default error message
`path`	string	the requested path
`responseData`	string \| object	responseData
`response`	Object	the object returned by fetch

Source:

Error/BadRequestError.js, line 4

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(message, path, responseData, response)

The error structure returned when a request page is not found

Constructor

new exports(message, path, responseData, response)

Construct a new ConflictError

Parameters:

Name	Type	Description
`message`	string	an message to return instead of the the default error message
`path`	string	the requested path
`responseData`	string \| object	responseData
`response`	Object	the object returned by fetch

Source:

Error/ConflictError.js, line 4

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(message)

The error structure returned when a network call fails

Constructor

new exports(message)

Construct a new ResponseError

Parameters:

Name	Type	Description
`message`	string	an message to return instead of the the default error message

Source:

Error/IllegalArgumentsError.js, line 4

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(message, path, response, responseData)

The error structure returned when a request page is not found

Constructor

new exports(message, path, response, responseData)

Construct a new NotFoundError

Parameters:

Name	Type	Description
`message`	string	an message to return instead of the the default error message
`path`	string	the requested path
`response`	Object	the object returned by fetch
`responseData`	string \| object	responseData

Source:

Error/NotFoundError.js, line 4

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(message, path, responseData, response)

The error structure returned when a network call fails

Constructor

new exports(message, path, responseData, response)

Construct a new ResponseError

Parameters:

Name	Type	Description
`message`	string	an message to return instead of the the default error message
`path`	string	the requested path
`responseData`	string \| object	responseData
`response`	Object	the object returned by fetch

Source:

Error/ResponseError.js, line 4

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(message)

The error structure returned when a network call fails

Constructor

new exports(message)

Construct a new UnsafeError

Parameters:

Name	Type	Description
`message`	string	an message to return instead of the the default error message

Source:

Error/UnsafeError.js, line 4

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

the API Wrapper Class for the Anonymization APIs

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatAdmin/DicomConfig/Anonymization.js, line 12

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

the API Wrapper Class for the DicomScp APIs

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatAdmin/DicomConfig/DicomScp.js, line 11

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

the API Wrapper Class for the Audit APIs

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatAdmin/OtherService/Audit.js, line 11

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

Catalog Refresh API

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatAdmin/OtherService/CatalogRefresh.js, line 11

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

the API Wrapper Class for the Email APIs

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatAdmin/OtherService/Email.js, line 12

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

the API Wrapper Class for the File Mover Service APIs

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatAdmin/OtherService/FileMover.js, line 10

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports()

the Aggregate class of the API Wrappers for miscellaneous jobs

Constructor

new exports()

Source:

XnatAdmin/OtherService/index.js, line 9

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

Wrapper class for the Subject related APIs

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatAdmin/PluginAdmin/Plugin.js, line 11

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

Schema Api

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatAdmin/SiteAdmin/DataTypeSchema.js, line 11

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

Preferences Service API

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatAdmin/SiteAdmin/Preference.js, line 11

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

Site-wide Configuration API

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatAdmin/SiteAdmin/SiteWideConfig.js, line 11

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

Catalog Api

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatAdmin/SystemAdmin/Archive.js, line 11

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

Preferences Service API

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatAdmin/SystemAdmin/Notification.js, line 11

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

Preferences Service API

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatAdmin/SystemAdmin/Task.js, line 11

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

the API Wrapper Class for the UI Spawner APIs

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatAdmin/UiConfig/UiSpawner.js, line 11

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

the API Wrapper Class for the UI Theme APIs

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatAdmin/UiConfig/UiTheme.js, line 11

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

User Resources API

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatAdmin/UserAdmin/UserResource.js, line 11

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

Wrapper class for the User Alias related APIs

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatAdmin/UserAuth/UserAliasToken.js, line 11

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

User Auth Service API

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatAdmin/UserAuth/UserAuthService.js, line 11

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

Archive related API

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatDataMgmt/Archive.js, line 12

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

Automation related API

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatDataMgmt/Automation.js, line 12

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

Data Processing related API

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatDataMgmt/DataProcessing.js, line 12

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

DicomDump related API

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatDataMgmt/DicomDump.js, line 10

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

Experiment (Subject Assessor) related API

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatDataMgmt/Experiment.js, line 13

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

Image Assessor related API

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatDataMgmt/ImageAssessor.js, line 13

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

Prearchive related API

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatDataMgmt/Prearchive.js, line 13

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

Project related API

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatDataMgmt/Project.js, line 13

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(jsXnat)

Resource related API

Constructor

new exports(jsXnat)

Constructor

Parameters:

Name	Type	Description
`jsXnat`	JsXnat

Source:

XnatDataMgmt/Resource.js, line 12

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34

exports(basePath, username, password, authMethodopt)

JsXnat encapsulates the functionality to create various API wrapper objects.

Constructor

new exports(basePath, username, password, authMethodopt)

Intialize the basic paramemters for accessing an XNAT node

Parameters:

Name	Type	Attributes	Default	Description
`basePath`	string			the XNAT base URL e.g. https://mirrir.wustl.edu
`username`	string			Valid XNAT username
`password`	string			Valid XNAT password
`authMethod`	string	<optional>	'token'	Auth Method: either password or token

Source:

index.js, line 49

Members

ExperimentXmlPathShortcuts

Experiment Xml Path Shortcuts objects

Source:

XnatDataMgmt/Experiment.js, line 25

PreArchiveCodes

Valid Prearchive setting codes

Source:

XnatDataMgmt/Project.js, line 25

QurantineCodes

Valid Quarantine setting codes

Source:

XnatDataMgmt/Project.js, line 34