JSDoc: Global

Methods

__getDump(src, fields, format, cb)

returns dicom header dump

Parameters:

Name	Type	Description
`src`	string	source path
`fields`	array \| string	Optional. tag name or tag number to display
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/DicomDump.js, line 111

Returns:

a list of matched entities

__isOneOf(code, obj) → {boolean}

Check if the code exists in the property of the object

Parameters:

Name	Type	Description
`code`	string
`obj`	obj

Source:

XnatDataMgmt/Experiment.js, line 684

Returns:

returns true if the code exists in the property of the object.

Type: boolean

__isOneOf(code, obj) → {boolean}

Get A Listing Of Pipelines In Your Project

Parameters:

Name	Type	Description
`code`	string
`obj`	obj

Source:

XnatDataMgmt/ImageAssessor.js, line 519

Returns:

returns true if the code exists in the property of the object.

Type: boolean

__isOneOf(code, obj) → {boolean}

Check if the code exists in the property of the object.

Parameters:

Name	Type	Description
`code`	string
`obj`	obj

Source:

XnatDataMgmt/Project.js, line 721

Returns:

returns true if the code exists in the property of the object.

Type: boolean

acceptOrDeclineProjectAccessRequest(id, action, cb)

Accept Or Decline Project Access Request

Parameters:

Name	Type	Description
`id`	string	project id
`action`	string	accept or decline
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 441

archive(src, overwrite, quarantine, triggerPipelines, dest, cb) → {Array.<ResultSet.Result.PrearchiveSession>}

Archive An Image Session That Is Currently In The Prearchive

Parameters:

Name	Type	Default	Description
`src`	string		The location of the session relative to the prearchive path. Refer to the url property of PrearchiveSession object (e.g. /prearchive/projects/Sample_Project/20140411_140005287/Sample_Session)
`overwrite`	OverwriteOptions.values		Optional.
`quarantine`	boolean	false	Optional. none (default): Do not overwrite existing xml or files, append: Add content to existing xml & file system, but do not overwrite existing files, delete: Upload new data, and overwrite any existing files
`triggerPipelines`	boolean	true	Optional. false (default): follow project settings for whether new/modified archive content should go into quarantine, true: override project settings and place new/modified archive content in quarantine
`dest`	string		Optional. true (default): run the AutoRun pipeline for any archived sessions which are modified/created by this import, false: Do not run the AutoRun at this time
`cb`	function		optional callback function

Source:

XnatDataMgmt/Prearchive.js, line 178

Returns:

Type: Array.<ResultSet.Result.PrearchiveSession>

authenticate(username, password, provideropt, cbopt)

Returns a single preference and value for this XNAT application.

Parameters:

Name	Type	Attributes	Description
`username`	string		username
`password`	string		password
`provider`	string	<optional>	provider
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/UserAuth/UserAuthService.js, line 27

callbackErrorOrThrow(cb, path) → {void}

Callback or throw

Parameters:

Name	Type	Description
`cb`	function	callback function
`path`	string	api path

Source:

Common/Requestable.js, line 262

Returns:

Type: void

checkUploadStatus(uploadId, format, cb)

Check The Status Of An Upload

Parameters:

Name	Type	Description
`uploadId`	string	project id
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/Archive.js, line 70

cleanseUrl(raw) → {string}

Cleanse entered url

Parameters:

Name	Type	Description
`raw`	*	url to be cleansed

Source:

Common/Util.js, line 6

Returns:

cleansed url

Type: string

createAssessor(projectId, subjectIdOrLabel, experimentLabel, xml, cb) → {string}

Create A New Image Assessor

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentLabel`	string	experiment label
`xml`	object	assessor xml
`cb`	function	optional callback function

Source:

XnatDataMgmt/ImageAssessor.js, line 121

Returns:

a simple string of the new assessor ID

Type: string

createDicomDump(any) → {DicomDump}

creates and returns an DicomDump object that has the exact same auth and apibase parmeter as the object provided

Parameters:

Name	Type	Description
`any`	Requestable	object that extends Requestable

Source:

XnatDataMgmt/DicomDump.js, line 24

Returns:

new resource object

Type: DicomDump

createDicomScp(dicomScpDefinition, cbopt) → {Array.<DicomScpDefinition>}

Creates a new DICOM SCP receiver from the request body.

Parameters:

Name	Type	Attributes	Description
`dicomScpDefinition`	DicomScpDefinition		DICOM SCP receiver definition
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/DicomConfig/DicomScp.js, line 46

Returns:

DICOM SCP receiver definitions

Type: Array.<DicomScpDefinition>

createExperiment(projectId, subjectIdOrLabel, experimentLabel, json, cb) → {string}

Create A New Experiment

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentLabel`	string	experiment label
`json`	object	object type project data
`cb`	function	optional callback function

Source:

XnatDataMgmt/Experiment.js, line 277

Returns:

a simple string of the new experiment's accession ID

Type: string

createExperimentWithRawXml(projectId, subjectIdOrLabel, experimentLabel, xml, name, cb) → {string}

Create a new experiment represented by XML

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentLabel`	string	experiment label
`xml`	string	project xml representation
`name`	string	project name
`cb`	function	optional callback function

Source:

XnatDataMgmt/Experiment.js, line 310

Returns:

a simple string of the new experiment's accession ID

Type: string

createFolder(projectId, subjectIdOrLabel, experimentIdOrLabel, resourceLabel, format, tags, contents, cb)

Create A New Project Resource Folder

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label
`resourceLabel`	string	resource label (folder name)
`format`	string	Optional. Specify a string format descriptor for this resource folder.
`tags`	string \| array	Optional. Specify a comma-separated list of tags for this resource folder.
`contents`	string	Optional. Specify a string description of the resource folder's content.
`cb`	function	optional callback function

Source:

XnatDataMgmt/Experiment.js, line 573

Returns:

none

createFolder(projectId, subjectIdOrLabel, experimentIdOrLabel, assessorIdOrLabel, resourceLabel, format, tags, contents, cb)

Create A New Project Resource Folder

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label
`assessorIdOrLabel`	string	assessor id or label
`resourceLabel`	string	resource label (folder name)
`format`	string	Optional. Specify a string format descriptor for this resource folder.
`tags`	string \| array	Optional. Specify a comma-separated list of tags for this resource folder.
`contents`	string	Optional. Specify a string description of the resource folder's content.
`cb`	function	optional callback function

Source:

XnatDataMgmt/ImageAssessor.js, line 400

Returns:

none

createFolder(projectId, resourceLabel, format, tags, contents, cb)

Create A New Project Resource Folder

Parameters:

Name	Type	Description
`projectId`	string	project id
`resourceLabel`	string	resource label (folder name)
`format`	string	Optional. Specify a string format descriptor for this resource folder.
`tags`	string \| array	Optional. Specify a comma-separated list of tags for this resource folder.
`contents`	string	Optional. Specify a string description of the resource folder's content.
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 634

Returns:

none

createFolder(path, resourceLabel, format, tags, contents, cb)

Create A New Resource Folder

Parameters:

Name	Type	Description
`path`	string	the path of the entitiy for the resource (the path of Project, Subject, Image Assessor, or Scan)
`resourceLabel`	string	resource label (folder name)
`format`	string	Optional. Specify a string format descriptor for this resource folder.
`tags`	string \| array	Optional. Specify a comma-separated list of tags for this resource folder.
`contents`	string	Optional. Specify a string description of the resource folder's content.
`cb`	function	optional callback function

Source:

XnatDataMgmt/Resource.js, line 112

Returns:

none

createInvestigator(investigator, cb)

Returns the newly created investigator with the submitted attributes.

Parameters:

Name	Type	Description
`investigator`	Investigator	investigator object
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 325

createProject(json, cb)

Create a project

Parameters:

Name	Type	Description
`json`	object	object type project data
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 99

createProjectWithRawXml(xml, name, cb)

Create a project represented by XML

Parameters:

Name	Type	Description
`xml`	string	project xml representation
`name`	string	project name
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 129

createResource(any) → {Resorce}

creates and returns an Resource object that has the exact same auth and apibase parmeter as the object provided

Parameters:

Name	Type	Description
`any`	Requestable	object that extends Requestable

Source:

XnatDataMgmt/Resource.js, line 25

Returns:

new resource object

Type: Resorce

createSimpleProject(id, secondaryId, name, cb) → {string}

Create a simple project

Parameters:

Name	Type	Description
`id`	string	project id
`secondaryId`	string	Optional. project secondary id. id will be used if empty
`name`	string	Optional. project name. id will be used if empty
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 76

Returns:

full project uri

Type: string

createStoredSearch(xml, cb)

Create A Stored Search

Parameters:

Name	Type	Description
`xml`	string	The XML structure of the stored search you want to create. Refer to https://wiki.xnat.org/display/XNAT17/Share+Custom+Data+Tables+as+Stored+Searches+for+Project+Reporting for notes on formatting.
`cb`	function	optional callback function

Source:

XnatDataMgmt/DataProcessing.js, line 126

deleteAssessor(projectId, subjectIdOrLabel, experimentIdOrLabel, assessorIdOrLabel, cb)

Delete (Or Unshare) An Image Assessor

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label to be shared
`assessorIdOrLabel`	string	assessor id or label
`cb`	function	optional callback function

Source:

XnatDataMgmt/ImageAssessor.js, line 266

Returns:

none

deleteExperiment(projectId, subjectIdOrLabel, experimentIdOrLabel, removeFiles, cb)

Delete (Or Unshare) A Subject Record

Parameters:

Name	Type	Default	Description
`projectId`	string		project id
`subjectIdOrLabel`	string		subject id or label
`experimentIdOrLabel`	string		experiment id or label to be shared
`removeFiles`	boolean	false	Optional query param. Defaults to "FALSE", which will leave files in the file system after deleting the experiment record in Postgres. When this param is set to "TRUE", those files are permanently deleted.
`cb`	function		optional callback function

Source:

XnatDataMgmt/Experiment.js, line 447

Returns:

none

deleteFile(projectId, subjectIdOrLabel, experimentIdOrLabel, resourceIdOrLabel, filename, cb)

Delete A Project Resource File

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label
`resourceIdOrLabel`	string	resource id or label (folder name)
`filename`	string	filename
`cb`	function	optional callback function

Source:

XnatDataMgmt/Experiment.js, line 662

Returns:

none

deleteFile(projectId, subjectIdOrLabel, experimentIdOrLabel, assessorIdOrLabel, resourceIdOrLabel, filename, cb)

Delete A Project Resource File

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label
`assessorIdOrLabel`	string	assessor id or label
`resourceIdOrLabel`	string	resource id or label (folder name)
`filename`	string	filename
`cb`	function	optional callback function

Source:

XnatDataMgmt/ImageAssessor.js, line 495

Returns:

none

deleteFile(projectId, resourceIdOrLabel, filename, cb)

Delete A Project Resource File

Parameters:

Name	Type	Description
`projectId`	string	project id
`resourceIdOrLabel`	string	resource id or label (folder name)
`filename`	string	filename
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 706

Returns:

none

deleteFile(path, resourceIdOrLabel, filename, cb)

Delete A Resource File

Parameters:

Name	Type	Description
`path`	string	the path of the entitiy for the resource (the path of Project, Subject, Image Assessor, or Scan)
`resourceIdOrLabel`	string	resource id or label
`filename`	string	filename
`cb`	function	optional callback function

Source:

XnatDataMgmt/Resource.js, line 220

Returns:

none

deleteFolder(projectId, subjectIdOrLabel, experimentIdOrLabel, resourceIdOrLabel, safe, cb)

Delete A Project Resource Folder

Parameters:

Name	Type	Default	Description
`projectId`	string		project id
`subjectIdOrLabel`	string		subject id or label
`experimentIdOrLabel`	string		experiment id or label
`resourceIdOrLabel`	string		resource id or label (folder name)
`safe`	boolean	false	Optional. if throw errors if files exists in the resource folder
`cb`	function		optional callback function

Source:

XnatDataMgmt/Experiment.js, line 635

Returns:

none

deleteFolder(projectId, subjectIdOrLabel, experimentIdOrLabel, assessorIdOrLabel, resourceIdOrLabel, safe, cb)

Delete A Project Resource Folder

Parameters:

Name	Type	Default	Description
`projectId`	string		project id
`subjectIdOrLabel`	string		subject id or label
`experimentIdOrLabel`	string		experiment id or label
`assessorIdOrLabel`	string		assessor id or label
`resourceIdOrLabel`	string		resource id or label (folder name)
`safe`	boolean	false	Optional. if throw errors if files exists in the resource folder
`cb`	function		optional callback function

Source:

XnatDataMgmt/ImageAssessor.js, line 466

Returns:

none

deleteFolder(projectId, resourceIdOrLabel, safe, cb)

Delete A Project Resource Folder

Parameters:

Name	Type	Default	Description
`projectId`	string		project id
`resourceIdOrLabel`	string		resource id or label (folder name)
`safe`	boolean	false	Optional. if throw errors if files exists in the resource folder
`cb`	function		optional callback function

Source:

XnatDataMgmt/Project.js, line 688

Returns:

none

(async) deleteFolder(path, resourceIdOrLabel, safe, cb)

Delete A Resource Folder

Parameters:

Name	Type	Default	Description
`path`	string		the path of the entitiy for the resource (the path of Project, Subject, Image Assessor, or Scan)
`resourceIdOrLabel`	string		resource id or label
`safe`	boolean	false	Optional. if throw errors if files exists in the resource folder
`cb`	function		optional callback function

Source:

XnatDataMgmt/Resource.js, line 185

Returns:

none

deleteInvestigator(id, cb)

Deletes the requested investigator.

Parameters:

Name	Type	Description
`id`	string	investigator id
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 348

Returns:

Returns true if the requested investigator was successfully deleted. Returns false otherwise.

deleteProject(id, cb)

Delete a project with the project id provided

Parameters:

Name	Type	Description
`id`	string	project id
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 172

deleteScan(src, scanId, format, cb)

Delete A Single Scan From A Session In The Prearchive

Parameters:

Name	Type	Description
`src`	string	The location of the session relative to the prearchive path. Refer to the url property of PrearchiveSession object (e.g. /prearchive/projects/Sample_Project/20140411_140005287/Sample_Session)
`scanId`	string	scan id
`format`	string	Optional. Set the format of the response. json by default
`cb`	function	optional callback function return none

Source:

XnatDataMgmt/Prearchive.js, line 252

deleteSession(src, format, cb) → {Array.<ResultSet.Result.PrearchiveSession>}

Delete An Image Session From The Prearchive

Parameters:

Name	Type	Description
`src`	string	The location of the session relative to the prearchive path. Refer to the url property of PrearchiveSession object (e.g. /prearchive/projects/Sample_Project/20140411_140005287/Sample_Session)
`format`	string	Optional. Set the format of the response. json by default
`cb`	function	optional callback function

Source:

XnatDataMgmt/Prearchive.js, line 149

Returns:

Type: Array.<ResultSet.Result.PrearchiveSession>

download(resources)

Creates a download catalog for the submitted sessions and other data objects.

Parameters:

Name	Type	Description
`resources`	object	The resources to be cataloged.

Source:

XnatAdmin/SystemAdmin/Archive.js, line 81

downloadWithSize(resources)

Creates a download catalog for the submitted sessions and other data objects.

Parameters:

Name	Type	Description
`resources`	object	The resources to be cataloged.

Source:

XnatAdmin/SystemAdmin/Archive.js, line 92

enableDisableAutomation(enabled, cb) → {boolean}

Sets the internal scripting enabled flag for this XNAT application to the submitted value.

Parameters:

Name	Type	Description
`enabled`	bolean	whether to enable scripting
`cb`	function	optional callback function

Source:

XnatDataMgmt/Automation.js, line 55

Returns:

enabled

Type: boolean

enableDisableDicomScpReceiverDefinition(id, cbopt)

/xapi/dicomscp/{id}/enabled/{flag}

Parameters:

Name	Type	Attributes	Description
`id`	string		ID of the DICOM SCP receiver definition to fetch
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/DicomConfig/DicomScp.js, line 153

Returns:

none

enableDisableScript(projectId, enableopt, cbopt)

Enables or disables the project-specific anonymization script.

Parameters:

Name	Type	Attributes	Default	Description
`projectId`	string			Project ID
`enable`	boolean	<optional>	true	enable
`cb`	function	<optional>		Callback function

Source:

XnatAdmin/DicomConfig/Anonymization.js, line 95

Returns:

none

enableDisableSiteWideScript(enableopt, cbopt)

Enables or disables the site-wide anonymization script.

Parameters:

Name	Type	Attributes	Default	Description
`enable`	boolean	<optional>	true	enable
`cb`	function	<optional>		Callback function

Source:

XnatAdmin/DicomConfig/Anonymization.js, line 152

Returns:

none

getAllAutomationEventClasses(cb)

Get list of event classes.

Parameters:

Name	Type	Description
`cb`	function	optional callback function

Source:

XnatDataMgmt/Automation.js, line 69

Returns:

a object (map) of automation settings

getAllDataTypeInfo(cb)

Gets a map of all available data types on the system with the full element definition.

Parameters:

Name	Type	Description
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SiteAdmin/DataTypeSchema.js, line 82

getAllDataTypeNames(cb)

Gets a map of the available data types on the system along with the various data type element names and types.

Parameters:

Name	Type	Description
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SiteAdmin/DataTypeSchema.js, line 125

getAllDicomScpDefinitions(cbopt) → {Array.<DicomScpDefinition>}

Get list of all configured DICOM SCP receiver definitions.

Parameters:

Name	Type	Attributes	Description
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/DicomConfig/DicomScp.js, line 36

Returns:

DICOM SCP receiver definitions

Type: Array.<DicomScpDefinition>

getAllExperiments(columns, fromDate, toDate, conditions, format, cb)

Get All Experiments In XNAT

Parameters:

Name	Type	Description
`columns`	string \| array	Optional. Column names can be either properties of ExperimentXmlPathShortcuts or XML Path Shortcuts: https://wiki.xnat.org/display/XAPI/Experiment+Data+REST+XML+Path+Shortcuts
`fromDate`	string \| number \| object	Optional. from-date condition. can be formatted as MM/DD/YYYY or be timestamp. Timestamp ignores hours, mins....
`toDate`	string \| number \| object	Optional. to-date condition. can be formatted as MM/DD/YYYY or be timestamp. Timestamp ignores hours, mins....
`conditions`	object	Optional. restrict the search by any string parameter listed in Experiment Data REST XML Path Shortcuts. e.g., {xsiType: 'xnat:mrSessionData', ID :'XNAT_E0001*'}
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/Experiment.js, line 95

getAllInvestigators(cb)

returns a list of all investigators configured in the XNAT system.

Parameters:

Name	Type	Description
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 291

getAllPreferences(returnFormat, cb)

Returns the full map of preferences and values for this XNAT application.

Parameters:

Name	Type	Default	Description
`returnFormat`	string	json	return format (either json or ini)
`cb`	function \| undefined		optional callback function

Source:

XnatAdmin/OtherService/CatalogRefresh.js, line 25

getAllPreferences(returnFormat, cb)

Returns the full map of preferences and values for this XNAT application.

Parameters:

Name	Type	Default	Description
`returnFormat`	string	json	return format (either json or ini)
`cb`	function \| undefined		optional callback function

Source:

XnatAdmin/SiteAdmin/Preference.js, line 25

getAllPreferences(returnFormat, cb)

Returns the full map of preferences and values for this XNAT application.

Parameters:

Name	Type	Default	Description
`returnFormat`	string	json	return format (either json or ini)
`cb`	function \| undefined		optional callback function

Source:

XnatAdmin/SystemAdmin/Notification.js, line 25

getAllPreferences(returnFormat, cb)

Returns the full map of preferences and values for this XNAT application.

Parameters:

Name	Type	Default	Description
`returnFormat`	string	json	return format (either json or ini)
`cb`	function \| undefined		optional callback function

Source:

XnatAdmin/SystemAdmin/Task.js, line 25

getAllSchemas(cb)

Returns a list of all of the installed XNAT data-type schemas.

Parameters:

Name	Type	Description
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SiteAdmin/DataTypeSchema.js, line 24

getArchiveApi() → {Archive}

Get the Project API wrapper class

Source:

index.js, line 245

Returns:

the Archive API wrapper class

Type: Archive

getAssessor(format, cb)

Get A Specific Assessor Associated With An Image Session

Parameters:

Name	Type	Description
`options.projectId`	string	project id
`options.subjectIdOrLabel`	string	subject id or label
`options.experimentId`	string	experiment id
`options.experimentLabel`	string	experiment label
`options.assessorId`	string	assessor id
`options.asessorLabel`	string	assessor label
`format`	string	Optional. Set the format of the response. json by default
`cb`	function	optional callback function

Source:

XnatDataMgmt/ImageAssessor.js, line 75

getAssessors(columns, fromDate, toDate, conditions, format, cb)

Get All Assessors Associated With An Image Session

Parameters:

Name	Type	Description
`options.projectId`	string	Optional. project id
`options.subjectIdOrLabel`	string	Optional. subject id or label
`options.experimentId`	string	Optional. experiment id
`options.experimentLabel`	string	Optional. experiment label
`columns`	string \| array	Optional. Column names can be either properties of ExperimentXmlPathShortcuts or XML Path Shortcuts: https://wiki.xnat.org/display/XAPI/Experiment+Data+REST+XML+Path+Shortcuts
`fromDate`	string \| number \| object	Optional. from-date condition. can be formatted as MM/DD/YYYY or be timestamp. Timestamp ignores hours, mins....
`toDate`	string \| number \| object	Optional. to-date condition. can be formatted as MM/DD/YYYY or be timestamp. Timestamp ignores hours, mins....
`conditions`	object	Optional. restrict the search by any string parameter listed in Experiment Data REST XML Path Shortcuts. e.g., {xsiType: 'xnat:mrSessionData', ID :'XNAT_E0001*'}
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/ImageAssessor.js, line 35

getAssociatedUsers(id, format, cb)

Get A List Of Users Associated With A Project

Parameters:

Name	Type	Description
`id`	string	project id
`format`	string	Optional. Set the format of the response. json by default
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 359

Returns:

associated user lists. format will be determined by the requested format value.

getAuditApi() → {Audit}

Get the Audit API wrapper class

Source:

XnatAdmin/OtherService/index.js, line 34

Returns:

the Audit API wrapper class

Type: Audit

getAuditReport(xsiType, objectId, cbopt) → {XnatEvents}

Get An Audit Report On An XNAT Data Object

Parameters:

Name	Type	Attributes	Description
`xsiType`	string		a valid XNAT datatype (xsiType) entry, such as xdat:user or xnat:mrSessionData
`objectId`	string		valid ID for the XNAT data object in question. For example, to view changes to a user's permission, you would supply "xdat:user" as the xsiType and the numerical user ID for the ID.
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/OtherService/Audit.js, line 46

Returns:

Xnat Events

Type: XnatEvents

(async) getAuthorizationHeader() → {string}

Get the authorization header to be included in the HTTP request header.

Get the authorization header to be included in the HTTP request header. In most cases, you don't need to call this function directly.

Source:

index.js, line 108

Returns:

authorizatio header

Type: string

getAutomationApi() → {Automation}

Get the Automation API wrapper class

Source:

index.js, line 277

Returns:

the Automation API wrapper class

Type: Automation

getAutomationEventClasses(projectId, cb)

Get list of event classes for a specific project

Parameters:

Name	Type	Description
`projectId`	string	projectId
`cb`	function	optional callback function

Source:

XnatDataMgmt/Automation.js, line 84

Returns:

a object (map) of automation settings

getAutomationProperties(cb)

Returns the full map of automation settings for this XNAT application.

Parameters:

Name	Type	Description
`cb`	function	optional callback function

Source:

XnatDataMgmt/Automation.js, line 26

Returns:

a object (map) of automation settings

getAvailableThemes(cbopt)

Get list of available themes.

Parameters:

Name	Type	Attributes	Description
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/UiConfig/UiTheme.js, line 24

getBuildInfo(key, cb)

Returns a map of application build properties.

Parameters:

Name	Type	Description
`key`	string	optional configuration property key
`cb`	function	optional callback function

Source:

XnatAdmin/SiteAdmin/SiteWideConfig.js, line 63

getCatalogRefreshApi() → {CatalogRefresh}

Get the Catalog Refresh API wrapper class

Source:

XnatAdmin/OtherService/index.js, line 42

Returns:

the Catalog Refresh API wrapper class

Type: CatalogRefresh

getConfigObjectForTool(id, toolId, format, acceptNotFound, cb) → {ToolConfigObject}

Get A Config Object For A Specific Tool In Your Project

Parameters:

Name	Type	Default	Description
`id`	string		project id
`toolId`	string		tool id
`format`	string		Optional. Set the format of the response. json by default
`acceptNotFound`	boolean	false	Optional. returns a 204 - Content Not Found code, if no configs have been set for this tool when true. false by default
`cb`	function		optional callback function

Source:

XnatDataMgmt/Project.js, line 491

Returns:

Type: ToolConfigObject

getDataProcessingApi() → {DataProcessing}

Get the Data Processing API wrapper class

Source:

index.js, line 269

Returns:

the Data Processing API wrapper class

Type: DataProcessing

getDataTypeInfo(dataTypeName, cb)

Gets information about the requested data type.

Parameters:

Name	Type	Description
`dataTypeName`	string	the name of the data type to show
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SiteAdmin/DataTypeSchema.js, line 66

getDataTypeName(dataTypeName, cb)

Gets the element names and types for the specified data type.

Parameters:

Name	Type	Description
`dataTypeName`	string	data type name
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SiteAdmin/DataTypeSchema.js, line 117

getDataTypeNames(dataTypeNames, cb)

Gets information about the requested data type.

Parameters:

Name	Type	Description
`dataTypeNames`	string \| array	data type names
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SiteAdmin/DataTypeSchema.js, line 96

getDefaultScript(cbopt) → {string}

Gets the default anonymization script

Parameters:

Name	Type	Attributes	Description
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/DicomConfig/Anonymization.js, line 26

Returns:

Anonymization script

Type: string

getDetailOfPipelineExecutionStep(projectId, stepId, experimentId, cb)

Get Details Of A Pipeline Execution Workflow Step

Parameters:

Name	Type	Description
`projectId`	string	project id
`stepId`	string	Specify the ID of the pipeline step as defined in the Pipeline XML.
`experimentId`	string	Specify the Accession ID of the root experiment that the pipeline was launched on.
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 552

getDicomConfig() → {Dicom}

Get the Dicom group class

Source:

index.js, line 181

Returns:

a Class grouping the API wrappers related to DICOM jobs

Type: Dicom

getDicomDumpApi() → {DicomDump}

Get the Dicom Dump API wrapper class

Source:

index.js, line 285

Returns:

the Dicom Dump API wrapper class

Type: DicomDump

getDicomScpReceiverDefinition(title, port, cbopt) → {DicomScpDefinition}

Gets the DICOM SCP receiver definition with the specified AE title and port.

Parameters:

Name	Type	Attributes	Description
`title`	string		AE title of the DICOM SCP receiver definition to fetch
`port`	integer		Port of the DICOM SCP receiver definition to fetch
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/DicomConfig/DicomScp.js, line 93

Returns:

DICOM SCP receiver definitions

Type: DicomScpDefinition

getDicomScpReceiverDefinitionWithId(id, cbopt) → {DicomScpDefinition}

Gets the DICOM SCP receiver definition with the specified ID.

Parameters:

Name	Type	Attributes	Description
`id`	string		ID of the DICOM SCP receiver definition to fetch
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/DicomConfig/DicomScp.js, line 108

Returns:

DICOM SCP receiver definitions

Type: DicomScpDefinition

getDicomScpReceiverDefinitionWithId(id, cbopt) → {DicomScpDefinition}

Deletes the DICOM SCP receiver definition object with the specified ID.

Parameters:

Name	Type	Attributes	Description
`id`	string		ID of the DICOM SCP receiver definition to fetch
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/DicomConfig/DicomScp.js, line 133

Returns:

DICOM SCP receiver definitions

Type: DicomScpDefinition

getDisplayableUptime(cb)

Returns the system uptime.

Parameters:

Name	Type	Description
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SiteAdmin/SiteWideConfig.js, line 80

getDumpForPrearchiveSession(projectId, subjectIdOrLabel, experimentIdOrLabel, scanId, fields, format, cb)

returns dicom header dump for a prearchive session

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label
`scanId`	string	scan id
`fields`	array \| string	Optional. tag name or tag number to display
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/DicomDump.js, line 94

Returns:

a list of matched entities

getDumpForScan(projectId, subjectIdOrLabel, experimentIdOrLabel, scanId, fields, format, cb)

returns dicom header dump for a scan

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label
`scanId`	string	scan id
`fields`	array \| string	Optional. tag name or tag number to display
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/DicomDump.js, line 66

Returns:

a list of matched entities

getDumpForSession(projectId, subjectIdOrLabel, experimentIdOrLabel, fields, format, cb)

returns dicom header dump for a session

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label
`fields`	array \| string	Optional. tag name or tag number to display
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/DicomDump.js, line 39

Returns:

a list of matched entities

getElementIdsInNamespace(namespaceopt, cbopt) → {Array.<string>}

Get list of element IDs in the system's default namespace.

Parameters:

Name	Type	Attributes	Description
`namespace`	string	<optional>	if empty, element Ids in the default namespace will be looked up
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/UiConfig/UiSpawner.js, line 35

Returns:

A list of spawner element namespaces.

Type: Array.<string>

getElementNamespaces(cbopt) → {Array.<string>}

Returns a single preference and value for this XNAT application.

Parameters:

Name	Type	Attributes	Description
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/UiConfig/UiSpawner.js, line 25

Returns:

A list of spawner element namespaces.

Type: Array.<string>

getEmailApi() → {Email}

Get the Email API wrapper class

Source:

XnatAdmin/OtherService/index.js, line 26

Returns:

the Email API wrapper class

Type: Email

getExperiment(format, cb)

Get A Single Experiment Record

Parameters:

Name	Type	Description
`options.projectId`	string	project id
`options.subjectIdOrLabel`	string	subject id or label
`options.experimentId`	string	experiment id
`options.experimentLabel`	string	experiment label
`format`	string	Optional. Set the format of the response. json by default
`cb`	function	optional callback function

Source:

XnatDataMgmt/Experiment.js, line 203

getExperimentApi() → {Experiment}

Get the Experiment API wrapper class

Source:

index.js, line 213

Returns:

the Experiment API wrapper class

Type: Experiment

getExperimentByExperiment(experimentId, format, cb)

Get A Single Experiment Record using an experiment id

Parameters:

Name	Type	Description
`experimentId`	string	experiment id
`format`	string	Optional. Set the format of the response. json by default
`cb`	function	optional callback function

Source:

XnatDataMgmt/Experiment.js, line 244

getExperimentByExperimentLabel(projectId, experimentLabel, format, cb)

Get A Single Experiment Record using an experiment label

Parameters:

Name	Type	Description
`projectId`	string	subject id
`experimentLabel`	string	experiment label
`format`	string	Optional. Set the format of the response. json by default
`cb`	function	optional callback function

Source:

XnatDataMgmt/Experiment.js, line 259

getExperimentsInProject(projectId, columns, fromDate, toDate, conditions, format, cb)

Get All Experiments In A Project

Parameters:

Name	Type	Description
`projectId`	string	project id
`columns`	string \| array	Optional. Column names can be either properties of ExperimentXmlPathShortcuts or XML Path Shortcuts: https://wiki.xnat.org/display/XAPI/Experiment+Data+REST+XML+Path+Shortcuts
`fromDate`	string \| number \| object	Optional. from-date condition. can be formatted as MM/DD/YYYY or be timestamp. Timestamp ignores hours, mins....
`toDate`	string \| number \| object	Optional. to-date condition. can be formatted as MM/DD/YYYY or be timestamp. Timestamp ignores hours, mins....
`conditions`	object	Optional. restrict the search by any string parameter listed in Experiment Data REST XML Path Shortcuts. e.g., {xsiType: 'xnat:mrSessionData', ID :'XNAT_E0001*'}
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/Experiment.js, line 130

getExperimentsInSubject(projectId, subjectIdOrLabel, columns, fromDate, toDate, conditions, format, cb)

Get All Experiments For A Subject

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`columns`	string \| array	Optional. Column names can be either properties of ExperimentXmlPathShortcuts or XML Path Shortcuts: https://wiki.xnat.org/display/XAPI/Experiment+Data+REST+XML+Path+Shortcuts
`fromDate`	string \| number \| object	Optional. from-date condition. can be formatted as MM/DD/YYYY or be timestamp. Timestamp ignores hours, mins....
`toDate`	string \| number \| object	Optional. to-date condition. can be formatted as MM/DD/YYYY or be timestamp. Timestamp ignores hours, mins....
`conditions`	object	Optional. restrict the search by any string parameter listed in Experiment Data REST XML Path Shortcuts. e.g., {xsiType: 'xnat:mrSessionData', ID :'XNAT_E0001*'}
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/Experiment.js, line 167

getFile(projectId, subjectIdOrLabel, experimentIdOrLabel, resourceIdOrLabel, filename, cb)

Get A Listing Of Resource Files Stored With A Project

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label
`resourceIdOrLabel`	string	resource id or label (folder name)
`filename`	string	filename
`cb`	function	optional callback function

Source:

XnatDataMgmt/Experiment.js, line 545

getFile(projectId, subjectIdOrLabel, experimentIdOrLabel, assessorIdOrLabel, resourceIdOrLabel, filename, cb)

Get A Listing Of Resource Files Stored With A Project

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label
`assessorIdOrLabel`	string	assessor id or label
`resourceIdOrLabel`	string	resource id or label (folder name)
`filename`	string	filename
`cb`	function	optional callback function

Source:

XnatDataMgmt/ImageAssessor.js, line 370

getFile(src, scanId, resourceIdOrLabel, filename, cb)

Get A Scan Resource File From A Session In The Prearchive

Parameters:

Name	Type	Description
`src`	string	The location of the session relative to the prearchive path. Refer to the url property of PrearchiveSession object (e.g. /prearchive/projects/Sample_Project/20140411_140005287/Sample_Session)
`scanId`	string	scan id
`resourceIdOrLabel`	string	resource id or label (folder name)
`filename`	string	filename
`cb`	function	optional callback function

Source:

XnatDataMgmt/Prearchive.js, line 327

getFile(projectId, resourceIdOrLabel, filename, cb)

Get A Listing Of Resource Files Stored With A Project

Parameters:

Name	Type	Description
`projectId`	string	project id
`resourceIdOrLabel`	string	resource id or label (folder name)
`filename`	string	filename
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 615

getFile(path, resourceIdOrLabel, filename, cb)

Get A Listing Of Resource Files Stored With A Entity specifed in the path parameter

Parameters:

Name	Type	Description
`path`	string	the path of the entitiy for the resource (the path of Project, Subject, Image Assessor, or Scan)
`resourceIdOrLabel`	string	resource id or label (folder name)
`filename`	string	filename
`cb`	function	optional callback function

Source:

XnatDataMgmt/Resource.js, line 93

getFileMoverApi() → {FileMover}

Get the File Mover API wrapper class

Source:

XnatAdmin/OtherService/index.js, line 18

Returns:

the File Mover API wrapper class

Type: FileMover

getFiles(projectId, subjectIdOrLabel, experimentIdOrLabel, sortBy, format, cb)

Get A Listing Of Resource Files Stored With A Project

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label
`sortBy`	array \| string	Optional. Sort the returned results by one or more parameters in the Result array. Multiple parameters can be provided
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/Experiment.js, line 520

getFiles(projectId, subjectIdOrLabel, experimentIdOrLabel, assessorIdOrLabel, sortBy, format, cb)

Get A Listing Of Resource Files Stored With A Project

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label
`assessorIdOrLabel`	string	assessor id or label
`sortBy`	array \| string	Optional. Sort the returned results by one or more parameters in the Result array. Multiple parameters can be provided
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/ImageAssessor.js, line 343

getFiles(src, scanId, resourceIdOrLabel, sortBy, format, cb)

Get A Scan Resource File From A Session In The Prearchive

Parameters:

Name	Type	Description
`src`	string	The location of the session relative to the prearchive path. Refer to the url property of PrearchiveSession object (e.g. /prearchive/projects/Sample_Project/20140411_140005287/Sample_Session)
`scanId`	string	scan id
`resourceIdOrLabel`	string	resource id or label (folder name)
`sortBy`	array \| string	Optional. Sort the returned results by one or more parameters in the Result array. Multiple parameters can be provided
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/Prearchive.js, line 300

getFiles(projectId, sortBy, format, cb)

Get A Listing Of Resource Files Stored With A Project

Parameters:

Name	Type	Description
`projectId`	string	project id
`sortBy`	array \| string	Optional. Sort the returned results by one or more parameters in the Result array. Multiple parameters can be provided
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 594

getFiles(path, sortBy, format, cb)

Get A Listing Of Resource Files Stored With A Entity specifed in the path parameter

Parameters:

Name	Type	Description
`path`	string	the path of the entitiy for the resource (the path of Project, Subject, Image Assessor, or Scan)
`sortBy`	array \| string	Optional. Sort the returned results by one or more parameters in the Result array. Multiple parameters can be provided
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/Resource.js, line 65

getFolders(projectId, subjectIdOrLabel, experimentIdOrLabel, sortBy, format, cb)

Get A Listing Of Resource Folders Stored With A Subject

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label
`sortBy`	array \| string	Optional. Sort the returned results by one or more parameters in the Result array. Multiple parameters can be provided
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/Experiment.js, line 495

getFolders(projectId, subjectIdOrLabel, experimentIdOrLabel, assessorIdOrLabel, sortBy, format, cb)

Get A Listing Of All Resource Collections Stored With An Image Assessor

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label
`assessorIdOrLabel`	string	assessor id or label
`sortBy`	array \| string	Optional. Sort the returned results by one or more parameters in the Result array. Multiple parameters can be provided
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/ImageAssessor.js, line 316

getFolders(src, scanId, sortBy, format, cb)

Get A List Of Scan Resources From A Session In The Prearchive

Parameters:

Name	Type	Description
`src`	string	The location of the session relative to the prearchive path. Refer to the url property of PrearchiveSession object (e.g. /prearchive/projects/Sample_Project/20140411_140005287/Sample_Session)
`scanId`	string	scan id
`sortBy`	array \| string	Optional. Sort the returned results by one or more parameters in the Result array. Multiple parameters can be provided
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/Prearchive.js, line 273

getFolders(projectId, sortBy, format, cb)

Get A Listing Of Resource Folders Stored With A Project

Parameters:

Name	Type	Description
`projectId`	string	project id
`sortBy`	array \| string	Optional. Sort the returned results by one or more parameters in the Result array. Multiple parameters can be provided
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 573

getFolders(path, sortBy, format, cb)

Get A Listing Of Resource Folders

Parameters:

Name	Type	Description
`path`	string	the path of the entitiy for the resource (the path of Project, Subject, Image Assessor, or Scan)
`sortBy`	array \| string	Optional. Sort the returned results by one or more parameters in the Result array. Multiple parameters can be provided
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/Resource.js, line 37

getImageAssessorApi() → {ImageAssessor}

Get the Image Assessor API wrapper class

Source:

index.js, line 229

Returns:

the Image Assessor API wrapper class

Type: ImageAssessor

getInstalledPlugin(pluginId, cbopt) → {InstalledPlugin}

Returns the indicated XNAT plugin with its properties.

Parameters:

Name	Type	Attributes	Description
`pluginId`	string		Plugin ID
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/PluginAdmin/Plugin.js, line 59

Returns:

Installed plugin object

Type: InstalledPlugin

getInstalledPlugins(cbopt) → {Array.<InstalledPlugin>}

Returns a list of all of the installed and active XNAT plugins with their properties.

Parameters:

Name	Type	Attributes	Description
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/PluginAdmin/Plugin.js, line 49

Returns:

Installed plugin object array

Type: Array.<InstalledPlugin>

getInvestigator(id, cb)

Returns the investigator with the specified ID.

Parameters:

Name	Type	Description
`id`	string	investigator id
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 300

getMapOfDicomObjectIdentifiersAndNames(cbopt) → {Array.<DicomScpDefinition>}

Get map of all configured DICOM object identifiers and names.

Parameters:

Name	Type	Attributes	Description
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/DicomConfig/DicomScp.js, line 55

Returns:

DICOM SCP receiver definitions

Type: Array.<DicomScpDefinition>

getNextPage(linksHeader) → {string}

Parameters:

Name	Type	Description
`linksHeader`	string	linksHeader separated by comma

Source:

Common/Requestable.js, line 245

Returns:

nextUrl

Type: string

getOpenUrlSettings(cbopt) → {InstalledPlugin}

Gets the plugin open URL configuration.

Parameters:

Name	Type	Attributes	Description
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/PluginAdmin/Plugin.js, line 68

Returns:

Installed plugin object

Type: InstalledPlugin

getOtherService() → {Other}

Get the Other group class

Source:

index.js, line 189

Returns:

a Class grouping the API wrappers related to miscellaneous jobs

Type: Other

getPipelines(projectId, format, cb)

Get A Listing Of Pipelines In Your Project

Parameters:

Name	Type	Description
`projectId`	string	project id
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/DataProcessing.js, line 28

Returns:

a list of matched entities

getPipelines(id, format, cb)

Get A Listing Of Pipelines In Your Project

Parameters:

Name	Type	Description
`id`	string	project id
`format`	string	Optional. Set the format of the response. json by default
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 533

getPipelineStep(projectId, stepId, experimentId, cb)

Get Details Of A Pipeline Execution Workflow Step

Parameters:

Name	Type	Description
`projectId`	string	project id
`stepId`	string	step id
`experimentId`	string	experiment id
`cb`	function	optional callback function

Source:

XnatDataMgmt/DataProcessing.js, line 48

Returns:

none

getPluginAdmin() → {PluginAdmin}

Get the Plugin Administration group class

Source:

index.js, line 165

Returns:

a Class grouping the API wrappers related to Plugin-Administration jobs

Type: PluginAdmin

getPrearchiveApi() → {Prearchive}

Get the Prearchive API wrapper class

Source:

index.js, line 253

Returns:

the Prearchive API wrapper class

Type: Prearchive

getPrearchiveSetting(projectId, cb) → {0|4|5}

Returns a project's prearchive setting

Parameters:

Name	Type	Description
`projectId`	string	project id
`cb`	function	optional callback function

Source:

XnatDataMgmt/Prearchive.js, line 342

Returns:

"0": All uploaded image data will be placed into the prearchive. Users will have to manually transfer sessions into the permanent archive, "4": All uploaded image data will be auto-archived. If a session with the same label already exists, new files will NOT overwrite old ones, "5": All uploaded image data will be auto-archived. If a session with the same label already exists, new files WILL overwrite old ones

Type: 0 | 4 | 5

getPrearchiveSetting(id, cb) → {0|4|5}

Returns a project's prearchive setting

Parameters:

Name	Type	Description
`id`	string	project id
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 214

Returns:

Type: 0 | 4 | 5

getPreference(toolId, preference, cb)

Returns a single preference and value for this XNAT application.

Parameters:

Name	Type	Description
`toolId`	string	toolId
`preference`	string	a single preference
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/OtherService/CatalogRefresh.js, line 57

getPreference(toolId, preference, cb)

Returns a single preference and value for this XNAT application.

Parameters:

Name	Type	Description
`toolId`	string	toolId
`preference`	string	a single preference
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SiteAdmin/Preference.js, line 57

getPreference(toolId, preference, cb)

Returns a single preference and value for this XNAT application.

Parameters:

Name	Type	Description
`toolId`	string	toolId
`preference`	string	a single preference
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SystemAdmin/Archive.js, line 128

getPreference(toolId, preference, cb)

Returns a single preference and value for this XNAT application.

Parameters:

Name	Type	Description
`toolId`	string	toolId
`preference`	string	a single preference
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SystemAdmin/Notification.js, line 57

getPreference(toolId, preference, cb)

Returns a single preference and value for this XNAT application.

Parameters:

Name	Type	Description
`toolId`	string	toolId
`preference`	string	a single preference
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SystemAdmin/Task.js, line 57

getPreferences(toolId, returnFormat, cb)

Returns preferences for matched tool id

Parameters:

Name	Type	Default	Description
`toolId`	string		toolId
`returnFormat`	string	json	return format (either json or ini)
`cb`	function \| undefined		optional callback function

Source:

XnatAdmin/OtherService/CatalogRefresh.js, line 39

getPreferences(toolId, returnFormat, cb)

Returns preferences for matched tool id

Parameters:

Name	Type	Default	Description
`toolId`	string		toolId
`returnFormat`	string	json	return format (either json or ini)
`cb`	function \| undefined		optional callback function

Source:

XnatAdmin/SiteAdmin/Preference.js, line 39

getPreferences(toolId, returnFormat, cb)

Returns preferences for matched tool id

Parameters:

Name	Type	Default	Description
`toolId`	string		toolId
`returnFormat`	string	json	return format (either json or ini)
`cb`	function \| undefined		optional callback function

Source:

XnatAdmin/SystemAdmin/Archive.js, line 110

getPreferences(toolId, returnFormat, cb)

Returns preferences for matched tool id

Parameters:

Name	Type	Default	Description
`toolId`	string		toolId
`returnFormat`	string	json	return format (either json or ini)
`cb`	function \| undefined		optional callback function

Source:

XnatAdmin/SystemAdmin/Notification.js, line 39

getPreferences(toolId, returnFormat, cb)

Returns preferences for matched tool id

Parameters:

Name	Type	Default	Description
`toolId`	string		toolId
`returnFormat`	string	json	return format (either json or ini)
`cb`	function \| undefined		optional callback function

Source:

XnatAdmin/SystemAdmin/Task.js, line 39

getProject(id, format, cb)

Get a single project

Parameters:

Name	Type	Description
`id`	string	project id (value of xnat:projectData/ID)
`format`	string	Optional. Set the format of the response. json by default
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 61

getProjectAccessibility(id, cb)

Returns the accessibility status as a string: 'Public', 'Protected' or 'Private'

Parameters:

Name	Type	Description
`id`	string	project id
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 181

getProjectAccessRequestforProject(id, cb)

List All Project Access Requests For A Project

Parameters:

Name	Type	Description
`id`	string	project id
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 406

Returns:

array of ppending project access requests for the specified project

getProjectAccessRequests(format, cb)

Get All Site-wide Project Access Requests For The current User

Parameters:

Name	Type	Description
`format`	string	Optional. Set the format of the response. json by default
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 423

Returns:

array of pending project access requests for the current user. the "firstname", "lastname", and "login" fields refer to the user who created the invitation. "level" refers to the project access group. "?column?" is used for the project investigator field.

getProjectApi() → {Project}

Get the Project API wrapper class

Source:

index.js, line 197

Returns:

the Project API wrapper class

Type: Project

getProjects(formatopt, cb)

Get a listing of all projects

Parameters:

Name	Type	Attributes	Default	Description
`options.accessible`	boolean			Optional. Restrict the list of projects to those that are accessible to the currently logged in user. This is a catchall for any project group that the user may be assigned to. Default is false.
`options.owner`	boolean			Optional. Restrict the list of projects to those where the currently logged in user is listed as an owner. Default is false.
`options.member`	boolean			Optional. Restrict the list of projects to those where the currently logged in user is listed as a member. Default is false.
`options.collaborator`	boolean			Optional. Restrict the list of projects to those where the currently logged in user is listed as a collaborator. Default is false.
`options.activeSince`	date			Optional. Restrict the list of projects to those who have been updated since the specified date. Date format is YYYY-MM-DD
`options.recent`	boolean			Optional. Restrict the list of projects to those who have been recently accessed by the logged in user. Default is false
`options.favorite`	boolean			Optional. Restrict the list of projects to those in the current user's "favorites" list.
`format`	string	<optional>	'json'	Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function			optional callback function

Source:

XnatDataMgmt/Project.js, line 51

getQueriableFields(xsiType, format)

Delete (Or Unshare) An Image Assessor

Parameters:

Name	Type	Description
`xsiType`	string	xsiType e.g., xnat:mrSessionData
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON* @param {function} cb optional callback function

Source:

XnatDataMgmt/DataProcessing.js, line 63

Returns:

none

getQurantineCode(id, cb)

Returns a project's quarantine code

Parameters:

Name	Type	Description
`id`	string	project id
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 246

getResouceApi() → {Resource}

Get the Resource API wrapper class

Source:

index.js, line 237

Returns:

the Resource API wrapper class

Type: Resource

getScanApi() → {Scan}

Get the Scan API wrapper class

Source:

index.js, line 221

Returns:

the Scan API wrapper class

Type: Scan

getScans(src, format, cb)

Get A List Of Scans From A Session In The Prearchive

Parameters:

Name	Type	Description
`src`	string	The location of the session relative to the prearchive path. Refer to the url property of PrearchiveSession object (e.g. /prearchive/projects/Sample_Project/20140411_140005287/Sample_Session)
`format`	string	Optional. Set the format of the response. json by default
`cb`	function	optional callback function
	Array.<Result.Prearchive>

Source:

XnatDataMgmt/Prearchive.js, line 231

getScanTypes(id, cb)

Returns project's scan types

Parameters:

Name	Type	Description
`id`	string	project id
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 278

getSchema(schema, namespace, cb)

Returns the requested XNAT data-type schema.

Parameters:

Name	Type	Description
`schema`	string	schema
`namespace`	string \| undefined	namespace (this is optional because it can be possible for a schema to be in the root namespace)
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SiteAdmin/DataTypeSchema.js, line 34

getScript(projectId, cbopt) → {string}

Gets the project-specific anonymization script.

Parameters:

Name	Type	Attributes	Description
`projectId`	string		Project ID
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/DicomConfig/Anonymization.js, line 36

Returns:

Anonymization script

Type: string

getSearchApi() → {Search}

Get the Search API wrapper class

Source:

index.js, line 261

Returns:

the Search API wrapper class

Type: Search

getSearchReportVersionsFor(xsiType, format, cb)

Get A List Of Search Report Versions For A Data Type

Parameters:

Name	Type	Description
`xsiType`	string	xsiType e.g., xnat:mrSessionData
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/DataProcessing.js, line 84

getSessionsForProject(projectId, format, cb) → {Array.<ResultSet.Result.PrearchiveSession>}

Get A List Of All Sessions In The Prearchive for a specific project

Parameters:

Name	Type	Description
`projectId`	string	project id
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/Prearchive.js, line 72

Returns:

Type: Array.<ResultSet.Result.PrearchiveSession>

getSharedProjects(projectId, subjectIdOrLabel, experimentIdOrLabel, format, cb)

Get A List Of Shared Projects Associated With An Experiment

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/Experiment.js, line 418

Returns:

a list of all projects associated with a subject. The root project ID in the URI can be either a project that owns the subject or a shared project.

getSharedProjects(projectId, subjectIdOrLabel, experimentIdOrLabel, assessorIdOrLabel, format, cb)

Get A List Of Shared Projects Associated With An Experiment

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label to be shared
`assessorIdOrLabel`	string	assessor id or label
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/ImageAssessor.js, line 236

Returns:

a list of all projects associated with a subject. The root project ID in the URI can be either a project that owns the subject or a shared project.

getSiteAdmin() → {SiteAdmin}

Get the Site Administration group class

Source:

index.js, line 133

Returns:

a Class grouping the API wrappers related to Site-Administration jobs

Type: SiteAdmin

getSiteConfig(key, cb)

Returns the full map of site configuration properties.

Parameters:

Name	Type	Description
`key`	string \| undefined	optional configuration property key
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SiteAdmin/SiteWideConfig.js, line 25

getSiteConfigValue(key, cb)

Returns a map of the selected site configuration properties.

Parameters:

Name	Type	Description
`key`	string	the site configuration property key
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SiteAdmin/SiteWideConfig.js, line 94

getSiteWideScript(cbopt) → {string}

Gets the site-wide anonymization script.

Parameters:

Name	Type	Attributes	Description
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/DicomConfig/Anonymization.js, line 114

Returns:

Anonymization script

Type: string

getStoredSearch(id, cb)

Get List of Stored Searches

Parameters:

Name	Type	Description
`id`	string	search id
`cb`	function	optional callback function

Source:

XnatDataMgmt/DataProcessing.js, line 117

getStoredSearches(format, cb)

Get List of Stored Searches

Parameters:

Name	Type	Description
`format`	string	Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function	optional callback function

Source:

XnatDataMgmt/DataProcessing.js, line 105

getStoredSearchResult(id, guiStyle, xml, cb)

Create A Stored Search

Parameters:

Name	Type	Default	Description
`id`	string		The unique ID of the stored search
`guiStyle`	boolean	false	If this query parameter is set to true, the information returned will be run through the same formatting that information in the GUI is normally run through. This means that the results of the REST call will have the same columns and column headings as the table displayed in the GUI when the saved search is executed.
`xml`	string		The XML structure of the stored search you want to create. Refer to https://wiki.xnat.org/display/XNAT17/Share+Custom+Data+Tables+as+Stored+Searches+for+Project+Reporting for notes on formatting.
`cb`	function		optional callback function

Source:

XnatDataMgmt/DataProcessing.js, line 159

getSubjectApi() → {Subject}

Get the Subject API wrapper class

Source:

index.js, line 205

Returns:

the Subject API wrapper class

Type: Subject

getSystemAdmin() → {SystemAdmin}

Get the System Administration group class

Source:

index.js, line 141

Returns:

a Class grouping the API wrappers related to System-Administration jobs

Type: SystemAdmin

getTools(id, format, cb)

Get A Listing Of Tools With Active Configurations At The Project Level

Parameters:

Name	Type	Description
`id`	string	project id
`format`	string	Optional. Set the format of the response. json by default
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 460

Returns:

getUiConfig() → {UserAdmin}

Get the UI Configuration group class

Source:

index.js, line 173

Returns:

a Class grouping the API wrappers related to UI-Configuration jobs

Type: UserAdmin

getUptime(cb)

Returns the system uptime.

Parameters:

Name	Type	Description
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SiteAdmin/SiteWideConfig.js, line 72

getUserAdmin() → {UserAdmin}

Get the User Administration group class

Source:

index.js, line 149

Returns:

a Class grouping the API wrappers related to User-Administration jobs

Type: UserAdmin

getUserAuth() → {UserAuth}

Get the User Authentication group class

Source:

index.js, line 157

Returns:

a Class grouping the API wrappers related to User-Authentication jobs

Type: UserAuth

(async) getVersion(includesBuildNumberopt) → {string}

Get the XNAT's version info that the currrent JsXnat object points to

Parameters:

Name	Type	Attributes	Default	Description
`includesBuildNumber`	boolean	<optional>	false	true if you want a build number along with version number

Source:

index.js, line 118

Returns:

Version info

Type: string

getWorkflowApi() → {DicomDump}

Get the Workflow API wrapper class

Source:

index.js, line 293

Returns:

the Dicom Dump API wrapper class

Type: DicomDump

grantAccessToUser(id, groupName, usernameOremail, cb)

Add Project Access To A User Account

Parameters:

Name	Type	Description
`id`	string	project id
`groupName`	string	the display name of the access group you want the new user to join (aka "Members"
`usernameOremail`	string	username of email address
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 374

Returns:

an updated list of users

invalidateToken(token, secret, cbopt)

Invalidate A User Alias Token

Parameters:

Name	Type	Attributes	Description
`token`	string		token
`secret`	string		secret
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/UserAuth/UserAliasToken.js, line 104

Returns:

none

isAutomationEnabled(cb)

Returns whether internal scripting is enabled for this XNAT application.

Parameters:

Name	Type	Description
`cb`	function	optional callback function

Source:

XnatDataMgmt/Automation.js, line 45

Returns:

a object (map) of automation settings

isDicomScpReceiverDefinition(id, cbopt) → {boolean}

Returns whether the DICOM SCP receiver definition with the specified ID is enabled.

Parameters:

Name	Type	Attributes	Description
`id`	string		ID of the DICOM SCP receiver definition to fetch
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/DicomConfig/DicomScp.js, line 143

Returns:

whether the DICOM SCP receiver definition with the specified ID is enabled.

Type: boolean

isScriptEnabled(projectId, cbopt) → {boolean}

Indicates whether the project-specific anonymization script is enabled or disabled.

Parameters:

Name	Type	Attributes	Description
`projectId`	string		Project ID
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/DicomConfig/Anonymization.js, line 76

Returns:

whether the anonymization script is enabled or disabled.

Type: boolean

isSiteWideScriptEnabled(projectId, cbopt) → {boolean}

Indicates whether the site-wide anonymization script is enabled or disabled.

Parameters:

Name	Type	Attributes	Description
`projectId`	string		Project ID
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/DicomConfig/Anonymization.js, line 142

Returns:

whether the anonymization script is enabled or disabled.

Type: boolean

(async) issueToken(cbopt) → {UserAliasTokenObject}

Issue A New User Alias Token

Parameters:

Name	Type	Attributes	Description
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/UserAuth/UserAliasToken.js, line 40

Returns:

User Alias Token Object

Type: UserAliasTokenObject

issueTokenForUser(username, cbopt) → {UserAliasTokenObject}

Issue A New User Alias Token For Another User

Parameters:

Name	Type	Attributes	Description
`username`	string		username
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/UserAuth/UserAliasToken.js, line 62

Returns:

User Alias Token Object

Type: UserAliasTokenObject

methodHasNoBody(method) → {boolean}

check if the http method provided has a body part

Parameters:

Name	Type	Description
`method`	string	upper-case http method name

Source:

Common/Requestable.js, line 236

Returns:

has body

Type: boolean

moveFile(src, dest, ovewriteopt, cbopt)

Set a value for a single preference

Parameters:

Name	Type	Attributes	Default	Description
`src`	string			Specifies the source file path relative to your XNAT application, including the file name. e.g. /cache/USERS/{User ID}/{resource_name}/{file_name}
`dest`	string			Specifies the intended destination file path relative to your XNAT application, including the file name. e.g. /archive/projects/{project_id}/resources/{resource_name}/{file_name}
`ovewrite`	boolean	<optional>	false	Allow file move to overwrite files at the destination path if true
`cb`	function	<optional>		callback function

Source:

XnatAdmin/OtherService/FileMover.js, line 26

moveSessionToProject(src, projectId, async, format, cb) → {Array.<ResultSet.Result.PrearchiveSession>}

Move A Session To A New Project

Parameters:

Name	Type	Default	Description
`src`	string		The location of the session relative to the prearchive path. Refer to the url property of PrearchiveSession object (e.g. /prearchive/projects/Sample_Project/20140411_140005287/Sample_Session)
`projectId`	string		The ID of the destination project
`async`	string \| array	false	Optional. Default is "false"
`format`	string		Optional. Set the format of the response. Format value can be json, html, xml, or csv. If not specified, default is JSON
`cb`	function		optional callback function

Source:

XnatDataMgmt/Prearchive.js, line 99

Returns:

Type: Array.<ResultSet.Result.PrearchiveSession>

rebuildSession(src, format, cb) → {Array.<ResultSet.Result.PrearchiveSession>}

Rebuild An Image Session Listing

Parameters:

Name	Type	Description
`src`	string	The location of the session relative to the prearchive path. Refer to the url property of PrearchiveSession object (e.g. /prearchive/projects/Sample_Project/20140411_140005287/Sample_Session)
`format`	string	Optional. Set the format of the response. json by default
`cb`	function	optional callback function

Source:

XnatDataMgmt/Prearchive.js, line 127

Returns:

Type: Array.<ResultSet.Result.PrearchiveSession>

refreshCatalog(resources, cb)

Refresh the catalog entry for one or more resources.

Parameters:

Name	Type	Description
`resources`	array \| string	the list of resources (or a single resource: '/archive/experiments/XNAT_E00001') to be refreshed
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SystemAdmin/Archive.js, line 43

refreshCatalogWithSpecificOperation(operations, resources, cb)

Refresh the catalog entry for one or more resources, performing only the operations specified.

Parameters:

Name	Type	Description
`operations`	array \| string	The operations to be performed
`resources`	array \| string	the list of resources (or a single resource: '/archive/experiments/XNAT_E00001') to be refreshed
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SystemAdmin/Archive.js, line 61

removeAccessFromUser(id, groupName, usernameOremail, cb)

Remove Project Access From A User Account

Parameters:

Name	Type	Description
`id`	string	project id
`groupName`	string	the display name of the access group you want the new user to join (aka "Members"
`usernameOremail`	string	username of email address
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 391

Returns:

an updated list of users

resetAllDicomObjectIdentifers(cbopt) → {Array.<DicomScpDefinition>}

Resets all configured DICOM object identifiers.

Parameters:

Name	Type	Attributes	Description
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/DicomConfig/DicomScp.js, line 64

Returns:

DICOM SCP receiver definitions

Type: Array.<DicomScpDefinition>

resetUploadStatus(uploadId, cb)

Reset The Status Of An Upload

Parameters:

Name	Type	Description
`uploadId`	string	project id
`cb`	function	optional callback function

Source:

XnatDataMgmt/Archive.js, line 83

send(to, subject, textopt, htmlopt, cbopt) → {string}

Send Email From XNAT To User

Parameters:

Name	Type	Attributes	Description
`to`	string		an email account that matches a user account in XNAT
`subject`	string		an email subject
`text`	string	<optional>	a plain-text version of your email body copy.
`html`	string	<optional>	an HTML-formatted version of your email body copy.
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/OtherService/Email.js, line 30

Returns:

Result message

Type: string

sendVerification(email, cbopt)

Send Or Resend Email Verification To User

Parameters:

Name	Type	Attributes	Description
`email`	string		an email account that matches a user account in XNAT
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/OtherService/Email.js, line 52

Returns:

none

setAutomationProperties(json, cb)

Sets a map of automation properties.

Parameters:

Name	Type	Description
`json`	string	automation properties to set
`cb`	function	optional callback function

Source:

XnatDataMgmt/Automation.js, line 36

Returns:

none

setDataType(cb)

Gets a list of the available data types on the system.

Parameters:

Name	Type	Description
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SiteAdmin/DataTypeSchema.js, line 49

setOpenUrlSettings(jsonopt, cbopt)

Sets the plugin open URL configuration.

Parameters:

Name	Type	Attributes	Description
`json`	object	<optional>	e.g. { "additionalProp1": true, "additionalProp2": true }
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/PluginAdmin/Plugin.js, line 78

Returns:

none

setPrearchiveSetting(projectId, code, cb)

Set a project's prearhive setting

Parameters:

Name	Type	Description
`projectId`	string	project id
`code`	integer	Valid Prearchive setting codes 0: Project is using the Prearchive, 4: Project is not using the Prearchive; No overwrites allowed, 5: Project is not using the Prearchive; No overwrites allowed
`cb`	function	optional callback function

Source:

XnatDataMgmt/Prearchive.js, line 357

setPrearchiveSetting(id, code, cb)

Set a project's prearhive setting

Parameters:

Name	Type	Description
`id`	string	project id
`code`	integer	Valid Prearchive setting codes 0: Project is using the Prearchive, 4: Project is not using the Prearchive; No overwrites allowed, 5: Project is not using the Prearchive; No overwrites allowed
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 229

setPreference(toolId, preference, cb)

Set a value for a single preference

Parameters:

Name	Type	Description
`toolId`	string	toolId
`preference`	string	a single preference
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/OtherService/CatalogRefresh.js, line 78

setPreference(toolId, preference, cb)

Set a value for a single preference

Parameters:

Name	Type	Description
`toolId`	string	toolId
`preference`	string	a single preference
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SiteAdmin/Preference.js, line 78

setPreference(toolId, preference, cb)

Set a value for a single preference

Parameters:

Name	Type	Description
`toolId`	string	toolId
`preference`	string	a single preference
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SystemAdmin/Archive.js, line 149

setPreference(toolId, preference, cb)

Set a value for a single preference

Parameters:

Name	Type	Description
`toolId`	string	toolId
`preference`	string	a single preference
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SystemAdmin/Notification.js, line 78

setPreference(toolId, preference, cb)

Set a value for a single preference

Parameters:

Name	Type	Description
`toolId`	string	toolId
`preference`	string	a single preference
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SystemAdmin/Task.js, line 78

setProjectAccessibility(id, status, cb)

Set a accessibility status

Parameters:

Name	Type	Description
`id`	string	project id
`status`	string	accessibility status 'Public', 'Protected' or 'Private'
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 196

setQurantineCode(id, code, cb)

Set a project's quarantine code

Parameters:

Name	Type	Description
`id`	string	project id
`code`	integer	Valid Quarantine setting codes 0: Project is not using the Quarantine, 4: Project is using the Quarantine
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 261

setScript(projectId, script, cbopt)

Sets the project-specific anonymization script.

Parameters:

Name	Type	Attributes	Description
`projectId`	string		Project ID
`script`	string		Anonymization script
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/DicomConfig/Anonymization.js, line 54

setSingleSiteConfig(key, value, cb)

Sets a single site configuration property.

Parameters:

Name	Type	Description
`key`	string	configuration property key
`value`	string \| object	configuration property value
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SiteAdmin/SiteWideConfig.js, line 48

setSiteConfig(config, cb)

Sets a map of site configuration properties.

Parameters:

Name	Type	Description
`config`	object	configuration properrties object to be updated (added)
`cb`	function \| undefined	optional callback function

Source:

XnatAdmin/SiteAdmin/SiteWideConfig.js, line 35

setSiteWideScript(script, cbopt)

/xapi/anonymize/site

Parameters:

Name	Type	Attributes	Description
`script`	string		Anonymization script
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/DicomConfig/Anonymization.js, line 123

shareAssessor(originalProjectId, sharedProjectId, subjectIdOrLabel, experimentIdOrLabel, assessorIdOrLabel, newLabel, primary, cb) → {string}

Share An Image Assessor Into A New Project

Parameters:

Name	Type	Default	Description
`originalProjectId`	string		the ID of the project that owns a given experiment.
`sharedProjectId`	string		the ID of the project that you intend an experiment to be shared into
`subjectIdOrLabel`	string		subject id or label of the experiment to be shared
`experimentIdOrLabel`	string		experiment id or label to be shared
`assessorIdOrLabel`	string		assessor id or label
`newLabel`	string		Optional. Specify a new label for this experiment that will be used in the shared project, if desired.
`primary`	string	false	Optional. If set to "true", you are changing the primary ownership of the subject from the original project to the new project.
`cb`	function		optional callback function

Source:

XnatDataMgmt/ImageAssessor.js, line 207

Returns:

the experiment accession ID as a string

Type: string

shareExperiment(originalProjectId, sharedProjectId, subjectIdOrLabel, experimentIdOrLabel, newLabel, primary, cb) → {string}

Share An Experiment Into A New Project

Parameters:

Name	Type	Default	Description
`originalProjectId`	string		the ID of the project that owns a given experiment.
`sharedProjectId`	string		the ID of the project that you intend an experiment to be shared into
`subjectIdOrLabel`	string		subject id or label of the experiment to be shared
`experimentIdOrLabel`	string		experiment id or label to be shared
`newLabel`	string		Optional. Specify a new label for this experiment that will be used in the shared project, if desired.
`primary`	string	false	Optional. If set to "true", you are changing the primary ownership of the subject from the original project to the new project.
`cb`	function		optional callback function

Source:

XnatDataMgmt/Experiment.js, line 391

Returns:

the experiment accession ID as a string

Type: string

startAllDicomScpReceivers(cbopt) → {Array.<DicomScpDefinition>}

Starts all enabled DICOM SCP receivers.

Parameters:

Name	Type	Attributes	Description
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/DicomConfig/DicomScp.js, line 73

Returns:

DICOM SCP receiver definitions

Type: Array.<DicomScpDefinition>

startAllDicomScpReceivers(cbopt) → {Array.<DicomScpDefinition>}

Stop all enabled DICOM SCP receivers.

Parameters:

Name	Type	Attributes	Description
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/DicomConfig/DicomScp.js, line 82

Returns:

DICOM SCP receiver definitions

Type: Array.<DicomScpDefinition>

storeConfigForTool(id, toolId, filePath, contents, cb) → {undefined}

Store A Project-specific Config Value For A Specific Tool

Parameters:

Name	Type	Description
`id`	string	project id
`toolId`	string	tool id
`filePath`	string	file path
`contents`	string	contents. The format of your config value should match the format expected by the tool. If you are not sure what that is, perform a GET to get the current value.
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 518

Returns:

No response object is returned. A "201" response code indicates that the config value was stored.

Type: undefined

unshareExperiment(projectId, subjectIdOrLabel, experimentIdOrLabel, removeFiles, cb)

Delete (Or Unshare) A Subject Record

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label to be shared
`removeFiles`	boolean	Optional query param. Defaults to "FALSE", which will leave files in the file system after deleting the experiment record in Postgres. When this param is set to "TRUE", those files are permanently deleted.
`cb`	function	optional callback function

Source:

XnatDataMgmt/Experiment.js, line 471

Returns:

none

unshareExperiment(projectId, subjectIdOrLabel, experimentIdOrLabel, assessorIdOrLabel, cb)

Delete (Or Unshare) An Image Assessor

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label to be shared
`assessorIdOrLabel`	string	assessor id or label
`cb`	function	optional callback function

Source:

XnatDataMgmt/ImageAssessor.js, line 290

Returns:

none

updateAssessor(projectId, subjectIdOrLabel, experimentIdOrLabel, assessorIdOrLabel, xml, cb) → {string}

Modify An Existing Image Assessor

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label
`assessorIdOrLabel`	string	assessor id or label
`xml`	object	assessor xml
`cb`	function	optional callback function

Source:

XnatDataMgmt/ImageAssessor.js, line 150

Returns:

a simple string of the updated experiment's accession ID

Type: string

updateDicomScpReceiverDefinitionWithId(id, dicomScpDefinition, cbopt) → {DicomScpDefinition}

Updates the DICOM SCP receiver definition object with the ID specified in the path variable.

Updates the DICOM SCP receiver definition object with the ID specified in the path variable. Note that any ID specified in the serialized definition in the request body is ignored and set to the value from the path variable.

Parameters:

Name	Type	Attributes	Description
`id`	string		ID of the DICOM SCP receiver definition to fetch
`dicomScpDefinition`	DicomScpDefinition		DICOM SCP receiver definitions
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/DicomConfig/DicomScp.js, line 119

Returns:

DICOM SCP receiver definitions

Type: DicomScpDefinition

updateExperiment(projectId, subjectIdOrLabel, experimentIdOrLabel, json, cb) → {string}

Modify An Experiment Record's Metadata

Parameters:

Name	Type	Description
`projectId`	string	project id
`subjectIdOrLabel`	string	subject id or label
`experimentIdOrLabel`	string	experiment id or label
`json`	object	object type project data
`cb`	function	optional callback function

Source:

XnatDataMgmt/Experiment.js, line 335

Returns:

a simple string of the updated experiment's accession ID

Type: string

updateExperimentWithRawXml(xml, cb) → {string}

Update an experiment represented by XML

Parameters:

Name	Type	Description
`options.projectId`	string	project id
`options.subjectId`	string	subject id
`options.subjectLabel`	string	subject label
`xml`	string	project xml representation
`cb`	function	optional callback function

Source:

XnatDataMgmt/Experiment.js, line 364

Returns:

a simple string of the updated experiment's accession ID

Type: string

updateExperimentWithRawXml(xml, cb) → {string}

Update an experiment represented by XML

Parameters:

Name	Type	Description
`options.projectId`	string	project id
`options.subjectId`	string	subject id
`options.subjectLabel`	string	subject label
`xml`	string	project xml representation
`cb`	function	optional callback function

Source:

XnatDataMgmt/ImageAssessor.js, line 179

Returns:

a simple string of the updated experiment's accession ID

Type: string

updateInvestigator(id, investigator, cb) → {Investigator}

Updates the requested investigator from the submitted attributes and returns the updated investigator.

Parameters:

Name	Type	Description
`id`	Investigator	investigator id
`investigator`	Investigator	investigator object
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 337

Returns:

the updated investigator.

Type: Investigator

updateProject(id, json, cb)

Update a project

Parameters:

Name	Type	Description
`id`	string	project id
`json`	object	object type project data
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 139

updateProjectWithRawXml(id, xml, cb)

Update a project represented by XML

Parameters:

Name	Type	Description
`id`	string	project id
`xml`	string	project xml representation
`cb`	function	optional callback function

Source:

XnatDataMgmt/Project.js, line 157

updateStoredSearch(id, xml, cb)

Update A Stored Search

Parameters:

Name	Type	Description
`id`	string	The unique ID of the stored search
`xml`	string	The XML structure of the stored search you want to create. Refer to https://wiki.xnat.org/display/XNAT17/Share+Custom+Data+Tables+as+Stored+Searches+for+Project+Reporting for notes on formatting.
`cb`	function	optional callback function

Source:

XnatDataMgmt/DataProcessing.js, line 142

uploadFile(projectId, subjectIdOrLabel, experimentIdOrLabel, resourceIdOrLabel, filename, file, overwrite, cb)

Upload A New Project Resource File

Parameters:

Name	Type	Default	Description
`projectId`	string		project id
`subjectIdOrLabel`	string		subject id or label
`experimentIdOrLabel`	string		experiment id or label
`resourceIdOrLabel`	string		resource id or label (folder name)
`filename`	string		filename
`file`	Buffer		file buffer (need to check if this is compatilable from browser)
`overwrite`	boolean	false	Optional. overwrite the file if the file that has the same filename already exists in the same location
`cb`	function		optional callback function

Source:

XnatDataMgmt/Experiment.js, line 605

Returns:

none

uploadFile(projectId, subjectIdOrLabel, experimentIdOrLabel, assessorIdOrLabel, resourceIdOrLabel, filename, file, overwrite, cb)

Upload A New Project Resource File

Parameters:

Name	Type	Default	Description
`projectId`	string		project id
`subjectIdOrLabel`	string		subject id or label
`experimentIdOrLabel`	string		experiment id or label
`assessorIdOrLabel`	string		assessor id or label
`resourceIdOrLabel`	string		resource id or label (folder name)
`filename`	string		filename
`file`	Buffer		file buffer (need to check if this is compatilable from browser)
`overwrite`	boolean	false	Optional. overwrite the file if the file that has the same filename already exists in the same location
`cb`	function		optional callback function

Source:

XnatDataMgmt/ImageAssessor.js, line 434

Returns:

none

uploadFile(projectId, resourceIdOrLabel, filename, file, overwrite, cb)

Upload A New Project Resource File

Parameters:

Name	Type	Default	Description
`projectId`	string		project id
`resourceIdOrLabel`	string		resource id or label (folder name)
`filename`	string		filename
`file`	Buffer		file buffer (need to check if this is compatilable from browser)
`overwrite`	boolean	false	Optional. overwrite the file if the file that has the same filename already exists in the same location
`cb`	function		optional callback function

Source:

XnatDataMgmt/Project.js, line 662

Returns:

none

uploadFile(path, resourceIdOrLabel, filename, file, overwrite, cb)

Upload A New Resource File

Parameters:

Name	Type	Default	Description
`path`	string		the path of the entitiy for the resource (the path of Project, Subject, Image Assessor, or Scan)
`resourceIdOrLabel`	string		resource id or label
`filename`	string		filename
`file`	Buffer		file buffer (need to check if this is compatilable from browser)
`overwrite`	boolean	false	Optional. overwrite the file if the file that has the same filename already exists in the same location
`cb`	function		optional callback function

Source:

XnatDataMgmt/Resource.js, line 149

Returns:

none

uploadSession(filename, buffer, options['import-handler', options['http-session-listener', cb)

Upload (Import) An Image Session

Parameters:

Name	Type	Description
`filename`	string	filename
`buffer`	Bufer	file buffer
`options.overwrite`	string	Optional.
`options.quarantine`	string	Optional.
`options.triggerPipelines`	string	Optional.
`options.src`	string	Optional. Only used when attempting to import a previously uploaded file. You can specify multiple src attributes or separate them with commas.
`options.dest`	string	Optional.
`options['import-handler'`	string	Optional. Defaults to standard import logic ("SI"). Client can specify a key using free-form text which the server maps to a different implementation of the import logic. See above.
`options['http-session-listener'`	string	Optional. Used by the web based zip uploader
`options.rename`	string	Optional. Used with the gradual-DICOM importer, instructing XNAT to ignore the original dicom file name and rename it. Default is false.
`options.PROJECT_ID`	string	Optional. For use when not using dest attribute
`options.SUBJECT_ID`	string	Optional. For use when not using dest attribute
`options.EXPT_LABEL`	string	Optional. For use when not using dest attribute
`cb`	function	optional callback function

Source:

XnatDataMgmt/Archive.js, line 39

Returns:

none

validateArchive(src, format, cb) → {Array.<ResultSet.Result.PrearchiveSession>}

Validate An Archive Operation

Parameters:

Name	Type	Description
`src`	string	The location of the session relative to the prearchive path. Refer to the url property of PrearchiveSession object (e.g. /prearchive/projects/Sample_Project/20140411_140005287/Sample_Session)
`format`	string	Optional. Set the format of the response. json by default
`cb`	function	optional callback function

Source:

XnatDataMgmt/Prearchive.js, line 203

Returns:

Type: Array.<ResultSet.Result.PrearchiveSession>

validateToken(token, secret, cbopt) → {object}

Validate A User Alias Token

Parameters:

Name	Type	Attributes	Description
`token`	string		token
`secret`	string		secret
`cb`	function	<optional>	Callback function

Source:

XnatAdmin/UserAuth/UserAliasToken.js, line 82

Returns:

Type: object

Type Definitions

Auth

Type:

Object

Properties:

Name	Type	Attributes	Description
`authMethod`
`username`	string	<optional>	Valid XNAT username
`password`	string	<optional>	Valid XNAT password
`token`	UserAliasTokenObject	<optional>	token object

Source:

index.js, line 29

DataModelBean

Data Model Bean Class

Properties:

Name	Type	Description
`code`	string
`type`	string
`secured`	boolean
`singular`	string
`plural`	string

Source:

XnatAdmin/PluginAdmin/Plugin.js, line 34

DicomScpDefinition

Dicom Scp Definition

Type:

Object

Properties:

Name	Type	Description
`aeTitle`	string
`enabled`	boolean
`fileNamer`	string
`id`	integer
`identifier`	string
`port`	integer

Source:

XnatAdmin/DicomConfig/DicomScp.js, line 20

InstalledPlugin

Installed Plugin Class

Properties:

Name	Type	Description
`pluginClass`	string
`extendedAttributes`	object
`beanName`	string
`logConfigurationFile`	string
`entityPackages`	Array.<string>
`dataModelBeans`	Array.<DataModelBean>
`name`	string
`id`	string
`version`	string

Source:

XnatAdmin/PluginAdmin/Plugin.js, line 20

Investigator

Investigator type

Type:

object

Properties:

Name	Type	Description
`id`	string	investigator id
`type`	string	fixed with Investigator
`firstname`	string	First Name
`lastname`	string	Lat Name
`institution`	string	institution name
`department`	string	department name
`email`	string	valid email address
`phone`	string	valid phone number
`title`	string	title
`primaryProjects`	string	an array of primiary projects
`investigatorProjects`	array	an array of investigator projects

Source:

XnatDataMgmt/Project.js, line 304

PrearchiveScan

Prearchive scan

Type:

object

Properties:

Name	Type	Description
`ID`	string	scan id
`xsiType`	string	xsiType e.g. xnat:srScanData

Source:

XnatDataMgmt/Prearchive.js, line 216

PrearchiveSession

Prearchive session object

Type:

object

Properties:

Name	Type	Description
`autoarchive`	string
`folderName`	string
`lastmod`	string	YYYY-MM-DD HH:mm:SS.sss
`name`	string
`prevent_anon`	string(boolean)
`prevent_auto_commit`	string(boolean)
`project`	string
`PROTOCOL`	string
`scan_date`	date
`scan_time`	time
`SOURCE`	string	'SessionImporter'
`status`	string
`subject`	string
`tag`	string
`timestamp`	string	'YYYYMMDD_HHmmSSsss'
`TIMEZONE":`	string	"",
`uploaded`	datetime
`url`	string	/** Get A List Of All Sessions In The Prearchive

Source:

XnatDataMgmt/Prearchive.js, line 22

ToolConfigObject

Tool Config Object type

Type:

object

Properties:

Name	Type	Description
`contents`	string	The actual contents of the configuration file
`create_date`	datetime	The date/time the configuration was created
`path`	string	the path to the configuration file
`reason`	string	The user provided reason for uploading the configuration
`project`	string	project id
`status`	string	Enumerated setting: "enabled" / "disabled"
`tool`	string	The name of a tool that has configuration files
`unversioned`	boolean	Whether or not this config object is "versioned."
`user`	string	The user who created the configuration
`version`	integer	version version number of the configuration contents

Source:

XnatDataMgmt/Project.js, line 467

UserAliasTokenObject

User Alias Token Object

Properties:

Name	Type	Description
`alias`	string
`xdatUserId`	string
`secret`	string
`singleUse`	boolean
`estimatedExpirationTime`	integer
`timestamp`	integer
`enabled`	boolean
`created`	integer
`id`	string
`disabled`	integer

Source:

XnatAdmin/UserAuth/UserAliasToken.js, line 20

XnatEvent

Xnat Event

Properties:

Name	Type	Description
`event_action`	string
`event_id`	integer
`event_type`	string
`event_reason`	string
`event_date`	integer
`changesets`	Array.<string>
`event_user`	string
`event_category`	string
`event_status`	string

Source:

XnatAdmin/OtherService/Audit.js, line 25

XnatEvents

XNAT Events

Properties:

Name	Type	Description
`events`	Array.<XnatEvent>	an Array of XNAT Events

Source:

XnatAdmin/OtherService/Audit.js, line 19