{"swagger":"2.0","info":{"description":"The XNAT REST API (XAPI) functions provide access to XNAT internal functions for remote clients.","version":"1.10.0","title":"XNAT REST API","termsOfService":"http://www.xnat.org/download","contact":{"name":"XNAT","url":"http://www.xnat.org","email":"info@xnat.org"},"license":{"name":"Simplified 2-Clause BSD","url":"https://opensource.org/licenses/BSD-2-Clause"}},"host":"localhost","basePath":"/1100/xapi","tags":[{"name":"anonymize-api","description":"Anonymize Api"},{"name":"archive-processor-instance-api","description":"Archive Processor Instance Api"},{"name":"async-operations-api","description":"Asynchronous Operations Preferences API"},{"name":"automation-api","description":"Automation Service API"},{"name":"caching-api","description":"Caching Api"},{"name":"catalog-api","description":"Catalog Api"},{"name":"compute-environment-configs-api","description":"Compute Environment Configs Api"},{"name":"constraint-configs-api","description":"Constraint Configs Api"},{"name":"contrast-api","description":"Contrast Api"},{"name":"custom-fields-api","description":"Custom Fields Api"},{"name":"custom-form-display-field-api","description":"Custom Form Display Field Api"},{"name":"custom-forms-api","description":"Custom Forms Api"},{"name":"data-access-api","description":"Data Access Api"},{"name":"data-types-api","description":"Data Types Api"},{"name":"db-backed-schema-api","description":"DB Backed Schema Api"},{"name":"dicom-mapping-api","description":"Dicom Mapping Api"},{"name":"dicom-scp-api","description":"Dicom SCP Api"},{"name":"dicom-transaction-api","description":"XNAT DICOM transaction management API"},{"name":"direct-archive-session-api","description":"Direct Archive Session Api"},{"name":"element-display-api","description":"Element Display Api"},{"name":"event-handler-api","description":"Event Handler Api"},{"name":"event-service-rest-api","description":"Event Service Rest Api"},{"name":"event-tracking-data-api","description":"Event Tracking Data Api"},{"name":"hardware-configs-api","description":"Hardware Configs Api"},{"name":"investigators-api","description":"Investigators Api"},{"name":"legacy-custom-variable-api","description":"Legacy Custom Variable Api"},{"name":"logging-api","description":"Logging Api"},{"name":"notifications-api","description":"XNAT Notifications management API"},{"name":"plugin-open-urls-configuration-api","description":"Plugin Open URLs Authorization API"},{"name":"preferences-api","description":"Preferences Service API"},{"name":"resource-survey-api","description":"Resource Survey Api"},{"name":"role-based-data-access-api","description":"Role Based Data Access Api"},{"name":"schema-api","description":"Schema Api"},{"name":"schema-only-api","description":"Schema Only Api"},{"name":"site-config-api","description":"Site Config Api"},{"name":"snapshot-generation-api","description":"Snapshot Generation Api"},{"name":"spawner-api","description":"Spawner Api"},{"name":"theme-api","description":"XNAT Theme Management API"},{"name":"total-counts-api","description":"Total Counts API"},{"name":"users-api","description":"Users Api"},{"name":"xft-element-api","description":"XFT Element Api"},{"name":"xnat-plugin-api","description":"Xnat Plugin Api"},{"name":"xnat-task-api","description":"Xnat Task Api"}],"paths":{"/access/cache/flush":{"delete":{"tags":["data-access-api"],"summary":"Clears the element cache for the current user=.","operationId":"flushUserCacheStatusUsingDELETE_1","produces":["*/*"],"responses":{"200":{"description":"The user's cache was properly cleared."},"204":{"description":"No Content"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/access/cache/flush/{username}":{"delete":{"tags":["data-access-api"],"summary":"Clears the element cache for the specified user.","operationId":"flushUserCacheStatusUsingDELETE","produces":["*/*"],"parameters":[{"name":"username","in":"path","description":"Indicates the name of the user whose cache should be flushed. If not provided, this flushes the cache of the current user.","required":false,"type":"string"}],"responses":{"200":{"description":"The specified user's cache was properly cleared."},"204":{"description":"No Content"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to clear the specified user's cache.."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/access/cache/status":{"get":{"tags":["data-access-api"],"summary":"Returns a map indicating the status of the cache initialization.","operationId":"getCacheStatusUsingGET","produces":["application/json"],"responses":{"200":{"description":"A map with information on the status of cache initialization.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the list of available element displays."},"404":{"description":"Indicates that the cache implementation doesn't have the ability to report its status."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/access/displays":{"get":{"tags":["data-access-api"],"summary":"Gets a list of the available element displays.","description":"The available element displays can be used as parameters for this call in the form /xapi/access/displays/{DISPLAY}. This call is accessible to guest users when the site preference require login is set to false (i.e. open XNATs).","operationId":"getAvailableElementDisplaysUsingGET","produces":["application/json"],"responses":{"200":{"description":"A list of available element displays.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the list of available element displays."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/access/displays/modified":{"get":{"tags":["data-access-api"],"summary":"Gets the last modified timestamp for the current user.","description":"This indicates the time of the latest update to elements relevant to the user. An update to these elements can mean that permissions for the user have changed and the various displays should be refreshed if cached on the client side.","operationId":"getLastModifiedUsingGET","produces":["application/json"],"responses":{"200":{"description":"A list of available element displays.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the list of available element displays."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/access/displays/{display}":{"get":{"tags":["data-access-api"],"summary":"Gets a list of the element displays of the specified type for the current user.","description":"This call is accessible to guest users when the site preference require login is set to false (i.e. open XNATs).","operationId":"getElementDisplaysUsingGET","produces":["application/json"],"parameters":[{"name":"display","in":"path","description":"display","required":true,"type":"string"}],"responses":{"200":{"description":"A list of element displays of the specified type for the current user.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the list of available element displays."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/access/permissions/group/{projectId}":{"get":{"tags":["data-access-api"],"summary":"Finds any irregular permissions settings for standard project groups (Owners, Members, Collaborators).","operationId":"getProjectPermissionsUsingGET","produces":["*/*"],"parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"}],"responses":{"200":{"description":"Irregular permissions were found and fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"204":{"description":"There were no irregular permissions to be fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to clear the specified user's cache.."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"head":{"tags":["data-access-api"],"summary":"Finds any irregular permissions settings for standard project groups (Owners, Members, Collaborators).","operationId":"getProjectPermissionsUsingHEAD","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"}],"responses":{"200":{"description":"Irregular permissions were found and fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"204":{"description":"There were no irregular permissions to be fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to clear the specified user's cache.."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"post":{"tags":["data-access-api"],"summary":"Finds any irregular permissions settings for standard project groups (Owners, Members, Collaborators).","operationId":"getProjectPermissionsUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"}],"responses":{"200":{"description":"Irregular permissions were found and fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"201":{"description":"Created"},"204":{"description":"There were no irregular permissions to be fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to clear the specified user's cache.."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["data-access-api"],"summary":"Finds any irregular permissions settings for standard project groups (Owners, Members, Collaborators).","operationId":"getProjectPermissionsUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"}],"responses":{"200":{"description":"Irregular permissions were found and fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"201":{"description":"Created"},"204":{"description":"There were no irregular permissions to be fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to clear the specified user's cache.."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["data-access-api"],"summary":"Finds any irregular permissions settings for standard project groups (Owners, Members, Collaborators).","operationId":"getProjectPermissionsUsingDELETE","produces":["*/*"],"parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"}],"responses":{"200":{"description":"Irregular permissions were found and fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"204":{"description":"There were no irregular permissions to be fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to clear the specified user's cache.."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"options":{"tags":["data-access-api"],"summary":"Finds any irregular permissions settings for standard project groups (Owners, Members, Collaborators).","operationId":"getProjectPermissionsUsingOPTIONS","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"}],"responses":{"200":{"description":"Irregular permissions were found and fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"204":{"description":"There were no irregular permissions to be fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to clear the specified user's cache.."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"patch":{"tags":["data-access-api"],"summary":"Finds any irregular permissions settings for standard project groups (Owners, Members, Collaborators).","operationId":"getProjectPermissionsUsingPATCH","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"}],"responses":{"200":{"description":"Irregular permissions were found and fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"204":{"description":"There were no irregular permissions to be fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to clear the specified user's cache.."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/access/permissions/irregular/find":{"get":{"tags":["data-access-api"],"summary":"Finds any irregular permissions settings for standard project groups (Owners, Members, Collaborators).","operationId":"findIrregularPermissionsUsingGET","produces":["*/*"],"responses":{"200":{"description":"Irregular permissions were found and fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"204":{"description":"There were no irregular permissions to be fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to clear the specified user's cache.."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"head":{"tags":["data-access-api"],"summary":"Finds any irregular permissions settings for standard project groups (Owners, Members, Collaborators).","operationId":"findIrregularPermissionsUsingHEAD","consumes":["application/json"],"produces":["*/*"],"responses":{"200":{"description":"Irregular permissions were found and fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"204":{"description":"There were no irregular permissions to be fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to clear the specified user's cache.."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"post":{"tags":["data-access-api"],"summary":"Finds any irregular permissions settings for standard project groups (Owners, Members, Collaborators).","operationId":"findIrregularPermissionsUsingPOST","consumes":["application/json"],"produces":["*/*"],"responses":{"200":{"description":"Irregular permissions were found and fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"201":{"description":"Created"},"204":{"description":"There were no irregular permissions to be fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to clear the specified user's cache.."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["data-access-api"],"summary":"Finds any irregular permissions settings for standard project groups (Owners, Members, Collaborators).","operationId":"findIrregularPermissionsUsingPUT","consumes":["application/json"],"produces":["*/*"],"responses":{"200":{"description":"Irregular permissions were found and fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"201":{"description":"Created"},"204":{"description":"There were no irregular permissions to be fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to clear the specified user's cache.."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["data-access-api"],"summary":"Finds any irregular permissions settings for standard project groups (Owners, Members, Collaborators).","operationId":"findIrregularPermissionsUsingDELETE","produces":["*/*"],"responses":{"200":{"description":"Irregular permissions were found and fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"204":{"description":"There were no irregular permissions to be fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to clear the specified user's cache.."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"options":{"tags":["data-access-api"],"summary":"Finds any irregular permissions settings for standard project groups (Owners, Members, Collaborators).","operationId":"findIrregularPermissionsUsingOPTIONS","consumes":["application/json"],"produces":["*/*"],"responses":{"200":{"description":"Irregular permissions were found and fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"204":{"description":"There were no irregular permissions to be fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to clear the specified user's cache.."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"patch":{"tags":["data-access-api"],"summary":"Finds any irregular permissions settings for standard project groups (Owners, Members, Collaborators).","operationId":"findIrregularPermissionsUsingPATCH","consumes":["application/json"],"produces":["*/*"],"responses":{"200":{"description":"Irregular permissions were found and fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"204":{"description":"There were no irregular permissions to be fixed.","schema":{"type":"array","items":{"$ref":"#/definitions/Map"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to clear the specified user's cache.."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/access/permissions/irregular/fix":{"post":{"tags":["data-access-api"],"summary":"Finds and fixes any irregular permissions settings for standard project groups (Owners, Members, Collaborators).","operationId":"fixIrregularPermissionsUsingPOST","consumes":["application/json"],"produces":["*/*"],"responses":{"200":{"description":"Irregular permissions were found and fixed.","schema":{"type":"array","items":{"type":"integer","format":"int32"}}},"201":{"description":"Created"},"204":{"description":"There were no irregular permissions to be fixed.","schema":{"type":"array","items":{"type":"integer","format":"int32"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to clear the specified user's cache.."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/access/projects":{"get":{"tags":["data-access-api"],"summary":"Gets the projects and roles associated with the current user.","operationId":"getProjectRolesUsingGET","produces":["application/json"],"responses":{"200":{"description":"A list of projects and roles for the current user.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/access/{username}/displays/modified":{"get":{"tags":["data-access-api"],"summary":"Gets the last modified timestamp for the specified user. This can only be called by users with administrative privileges.","description":"This indicates the time of the latest update to elements relevant to the specified user. An update to these elements can mean that permissions for the specified user have changed and the various displays should be refreshed if cached on the client side.","operationId":"getLastModifiedForUserUsingGET","produces":["application/json"],"parameters":[{"name":"username","in":"path","description":"The user to get the last modified timestamp for.","required":false,"type":"string"}],"responses":{"200":{"description":"Timestamp of when the list of available element displays for the specified user was updated.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the user's cache timestamp."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/access/{username}/displays/{display}":{"get":{"tags":["data-access-api"],"summary":"Gets a list of the element displays of the specified type for the specified user. This can only be called by users with administrative privileges.","operationId":"getElementDisplaysForUserUsingGET","produces":["application/json"],"parameters":[{"name":"display","in":"path","description":"display","required":true,"type":"string"},{"name":"username","in":"path","description":"username","required":true,"type":"string"}],"responses":{"200":{"description":"A list of element displays of the specified type for the specified user.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the list of available element displays for the specified user."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/access/{username}/projects":{"get":{"tags":["data-access-api"],"summary":"Gets the projects and roles associated with the specified user. This can only be called by users with administrative privileges.","operationId":"getUserProjectRolesUsingGET","produces":["application/json"],"parameters":[{"name":"username","in":"path","description":"The user to get the project roles for.","required":false,"type":"string"}],"responses":{"200":{"description":"A list of projects and roles for the specified user.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the user's projects and roles."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/anonymize/default":{"get":{"tags":["anonymize-api"],"summary":"Gets the default anonymization script.","operationId":"getDefaultAnonScriptUsingGET","produces":["text/plain"],"responses":{"200":{"description":"Successfully retrieved the contents of the default anonymization script.","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access the default anonymization script."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/anonymize/projects/{projectId}":{"get":{"tags":["anonymize-api"],"summary":"Gets the project-specific anonymization script.","operationId":"getProjectAnonScriptUsingGET","produces":["text/plain"],"parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully retrieved the contents of the project-specific anonymization script.","schema":{"type":"string"}},"204":{"description":"The specified project was found but had no associated anonymization script.","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access the project-specific anonymization script."},"404":{"description":"The specified project wasn't found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["anonymize-api"],"summary":"Sets the project-specific anonymization script.","operationId":"setProjectAnonScriptUsingPUT","consumes":["text/plain"],"produces":["*/*"],"parameters":[{"name":"projectId","in":"path","description":"Indicates the ID of the project for which the anonymization script should be enabled or disabled.","required":true,"type":"string"},{"in":"body","name":"script","description":"Whether the specified project's anonymization script should be enabled or disabled.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully stored the contents of the project-specific anonymization script."},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to modify the project-specific anonymization script."},"404":{"description":"The specified project wasn't found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/anonymize/projects/{projectId}/enabled":{"get":{"tags":["anonymize-api"],"summary":"Indicates whether the project-specific anonymization script is enabled or disabled.","operationId":"isProjectAnonScriptEnabledUsingGET","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully retrieved the status of the project-specific anonymization script.","schema":{"type":"boolean"}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access the project-specific anonymization script settings."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["anonymize-api"],"summary":"Enables or disables the project-specific anonymization script.","operationId":"setProjectAnonScriptEnabledUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"enable","in":"query","description":"enable","required":false,"type":"boolean","default":true},{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully set the status of the project-specific anonymization script."},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to modify the project-specific anonymization script settings."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/anonymize/site":{"get":{"tags":["anonymize-api"],"summary":"Gets the site-wide anonymization script.","operationId":"getSiteWideAnonScriptUsingGET","produces":["text/plain"],"responses":{"200":{"description":"Successfully retrieved the contents of the site-wide anonymization script.","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access the site-wide anonymization script."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["anonymize-api"],"summary":"Sets the site-wide anonymization script.","operationId":"setSiteWideAnonScriptUsingPUT","consumes":["text/plain"],"produces":["*/*"],"parameters":[{"in":"body","name":"script","description":"script","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully stored the contents of the site-wide anonymization script."},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to modify the site-wide anonymization script."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/anonymize/site/enabled":{"get":{"tags":["anonymize-api"],"summary":"Indicates whether the site-wide anonymization script is enabled or disabled.","operationId":"isSiteWideAnonScriptEnabledUsingGET","produces":["application/json"],"responses":{"200":{"description":"Successfully retrieved the status of the site-wide anonymization script.","schema":{"type":"boolean"}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access the site-wide anonymization script settings."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["anonymize-api"],"summary":"Enables or disables the site-wide anonymization script.","operationId":"setSiteWideAnonScriptEnabledUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"enable","in":"query","description":"Whether the site-wide anonymization script should be enabled or disabled.","required":false,"type":"boolean","default":true,"allowEmptyValue":false}],"responses":{"200":{"description":"Successfully set the status of the site-wide anonymization script."},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to modify the site-wide anonymization script settings."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/archive/catalogs/refresh":{"put":{"tags":["catalog-api"],"summary":"Refresh the catalog entry for one or more resources.","description":"The resource should be identified by standard archive-relative paths, such as /archive/experiments/XNAT_E0001 or /archive/projects/XNAT_01/subjects/XNAT_01_01.","operationId":"refreshResourceCatalogUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"resources","description":"The list of resources to be refreshed.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"The refresh operation(s) were completed successfully."},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/archive/catalogs/refresh/{operations}":{"put":{"tags":["catalog-api"],"summary":"Refresh the catalog entry for one or more resources, performing only the operations specified.","description":"The resource should be identified by standard archive-relative paths, such as /archive/experiments/XNAT_E0001 or /archive/projects/XNAT_01/subjects/XNAT_01_01. The available operations are All, Append, Checksum, Delete, and PopulateStats. They should be comma separated but without spaces. Omitting the operations implies All.","operationId":"refreshResourceCatalogWithOptionsUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"operations","in":"path","description":"The operations to be performed","required":false,"type":"string","enum":["All","Append","Checksum","Delete","PopulateStats"]},{"in":"body","name":"resources","description":"The list of resources to be refreshed.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"The refresh operation(s) were completed successfully."},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/archive/download":{"post":{"tags":["catalog-api"],"summary":"Creates a download catalog for the submitted sessions and other data objects.","description":"The map submitted to this call supports lists of object IDs organized by key type: sessions, scan_type, scan_format, recon, assessors, and resources. The response for this method is the ID for the catalog of resolved resources, which can be submitted to the download/{catalog} function to retrieve the catalog or to the download/{catalog}/zip function to retrieve thefiles in the catalog as a zip archive.","operationId":"createDownloadSessionsCatalogUsingPOST","consumes":["application/json"],"produces":["application/xml"],"parameters":[{"in":"body","name":"resources","description":"The resources to be cataloged.","required":false,"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}],"responses":{"200":{"description":"The download catalog was successfully built.","schema":{"type":"string"}},"201":{"description":"Created"},"204":{"description":"No resources were specified.","schema":{"type":"string"}},"400":{"description":"Something is wrong with the request format."},"401":{"description":"Unauthorized"},"403":{"description":"The user is not authorized to access one or more of the specified resources."},"404":{"description":"The request was valid but one or more of the specified resources was not found."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/archive/download/{catalogId}":{"get":{"tags":["catalog-api"],"summary":"Retrieves the download catalog for the submitted catalog ID.","description":"This retrieves a catalog created earlier by the catalog service.","operationId":"getDownloadSessionsCatalogUsingGET","produces":["application/xml"],"parameters":[{"name":"catalogId","in":"path","description":"The ID of the catalog to be downloaded.","required":false,"type":"string"}],"responses":{"200":{"description":"The download catalog was successfully built.","schema":{"$ref":"#/definitions/CatCatalogBean"}},"204":{"description":"No resources were specified.","schema":{"$ref":"#/definitions/CatCatalogBean"}},"400":{"description":"Something is wrong with the request format."},"401":{"description":"Unauthorized"},"403":{"description":"The user is not authorized to access one or more of the specified resources."},"404":{"description":"The request was valid but one or more of the specified resources was not found."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/archive/download/{catalogId}/test":{"get":{"tags":["catalog-api"],"summary":"Downloads the specified catalog as a zip archive, using a small empty file for each entry.","operationId":"downloadSessionCatalogZipTestUsingGET","produces":["application/zip"],"parameters":[{"name":"catalogId","in":"path","description":"The ID of the catalog of resources to be downloaded.","required":false,"type":"string"}],"responses":{"200":{"description":"The requested resources were successfully downloaded.","schema":{"$ref":"#/definitions/StreamingResponseBody"}},"204":{"description":"No resources were specified.","schema":{"$ref":"#/definitions/StreamingResponseBody"}},"400":{"description":"Something is wrong with the request format."},"401":{"description":"Unauthorized"},"403":{"description":"The user is not authorized to access one or more of the specified resources."},"404":{"description":"The request was valid but one or more of the specified resources was not found."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/archive/download/{catalogId}/xml":{"get":{"tags":["catalog-api"],"summary":"Downloads the specified catalog as an XML file.","operationId":"downloadSessionCatalogXmlUsingGET","produces":["application/xml"],"parameters":[{"name":"catalogId","in":"path","description":"The ID of the catalog to be downloaded.","required":false,"type":"string"}],"responses":{"200":{"description":"The requested catalog was successfully downloaded.","schema":{"$ref":"#/definitions/StreamingResponseBody"}},"204":{"description":"No catalog was specified.","schema":{"$ref":"#/definitions/StreamingResponseBody"}},"400":{"description":"Something is wrong with the request format."},"401":{"description":"Unauthorized"},"403":{"description":"The user is not authorized to access the specified catalog."},"404":{"description":"The request was valid but the specified catalog was not found."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/archive/download/{catalogId}/zip":{"get":{"tags":["catalog-api"],"summary":"Downloads the contents of the specified catalog as a zip archive.","operationId":"downloadSessionCatalogZipUsingGET","produces":["application/zip"],"parameters":[{"name":"catalogId","in":"path","description":"The ID of the catalog of resources to be downloaded.","required":false,"type":"string"}],"responses":{"200":{"description":"The requested resources were successfully downloaded.","schema":{"$ref":"#/definitions/StreamingResponseBody"}},"204":{"description":"No resources were specified.","schema":{"$ref":"#/definitions/StreamingResponseBody"}},"400":{"description":"Something is wrong with the request format."},"401":{"description":"Unauthorized"},"403":{"description":"The user is not authorized to access one or more of the specified resources."},"404":{"description":"The request was valid but one or more of the specified resources was not found."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/archive/downloadwithsize":{"post":{"tags":["catalog-api"],"summary":"Creates a download catalog for the submitted sessions and other data objects.","description":"The map submitted to this call supports lists of object IDs organized by key type: sessions, scan_type, scan_format, recon, assessors, and resources. The response for this method is jsonwith the ID for the catalog of resolved resources (which can be submitted to the download/{catalog} function to retrieve the catalog or to the download/{catalog}/zip functionto retrieve the files in the catalog as a zip archive), as well as the total size of the files.","operationId":"createDownloadSessionsCatalogWithSizeUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"resources","description":"The resources to be cataloged.","required":false,"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}],"responses":{"200":{"description":"The download catalog was successfully built.","schema":{"type":"string"}},"201":{"description":"Created"},"204":{"description":"No resources were specified.","schema":{"type":"string"}},"400":{"description":"Something is wrong with the request format."},"401":{"description":"Unauthorized"},"403":{"description":"The user is not authorized to access one or more of the specified resources."},"404":{"description":"The request was valid but one or more of the specified resources was not found."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/archive/upload/xml":{"post":{"tags":["catalog-api"],"summary":"Accepts the XML payload and attempts to create or update an XNAT data object as appropriate.","operationId":"uploadXmlUsingPOST","consumes":["multipart/form-data"],"produces":["text/plain"],"parameters":[{"in":"formData","name":"allowDataDeletion","description":"Indicates whether data in existing objects should be overwritten by values in the uploaded XML","required":false,"schema":{"type":"boolean"}},{"in":"formData","name":"event_action","description":"Describes the event action for audit entries","required":false,"schema":{"type":"string"}},{"in":"formData","name":"event_comment","description":"Includes any comments about the change.","required":false,"schema":{"type":"string"}},{"in":"formData","name":"event_reason","description":"Describes the reason for the change.","required":false,"schema":{"type":"string"}},{"name":"item","in":"formData","description":"The XML body.","required":false,"type":"file"}],"responses":{"200":{"description":"The requested XML was successfully uploaded.","schema":{"type":"string"}},"201":{"description":"Created"},"204":{"description":"No resources were specified.","schema":{"type":"string"}},"400":{"description":"Something is wrong with the request format."},"401":{"description":"Unauthorized"},"403":{"description":"The user is not authorized to access one or more of the specified resources."},"404":{"description":"The request was valid but one or more of the specified resources was not found."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false},"put":{"tags":["catalog-api"],"summary":"Accepts the XML payload and attempts to create or update an XNAT data object as appropriate.","operationId":"uploadXmlUsingPUT","consumes":["application/xml","text/plain"],"produces":["text/plain"],"parameters":[{"name":"allowDataDeletion","in":"query","description":"Indicates whether data in existing objects should be overwritten by values in the uploaded XML","required":false,"type":"boolean","allowEmptyValue":false},{"name":"event_action","in":"query","description":"Describes the event action for audit entries","required":false,"type":"string","default":"REST","allowEmptyValue":false},{"name":"event_comment","in":"query","description":"Includes any comments about the change.","required":false,"type":"string","allowEmptyValue":false},{"name":"event_reason","in":"query","description":"Describes the reason for the change.","required":false,"type":"string","allowEmptyValue":false},{"in":"body","name":"xml","description":"The XML body.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested XML was successfully uploaded.","schema":{"type":"string"}},"201":{"description":"Created"},"204":{"description":"No resources were specified.","schema":{"type":"string"}},"400":{"description":"Something is wrong with the request format."},"401":{"description":"Unauthorized"},"403":{"description":"The user is not authorized to access one or more of the specified resources."},"404":{"description":"The request was valid but one or more of the specified resources was not found."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/asyncOps":{"get":{"tags":["async-operations-api"],"summary":"Returns the full map of async operations preferences for this XNAT application.","operationId":"getAsyncOperationsPreferencesUsingGET","produces":["application/json"],"responses":{"200":{"description":"Async operations preferences successfully retrieved.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Insufficient privileges to retrieve the requested settings."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"post":{"tags":["async-operations-api"],"summary":"Sets a map of async operations preferences.","description":"Sets the async operations preferences specified in the map.","operationId":"setAsyncOperationsPreferencesUsingPOST","consumes":["application/json","application/x-www-form-urlencoded"],"produces":["*/*"],"parameters":[{"in":"body","name":"preferences","description":"The map of async operations preferences to be set.","required":true,"schema":{"type":"object"}}],"responses":{"200":{"description":"Async operations preferences successfully set.","schema":{"type":"integer","format":"int32"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set async operations preferences."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/asyncOps/{preference}":{"get":{"tags":["async-operations-api"],"summary":"Returns the value of a particular async operations preference.","operationId":"getAsyncOperationsPreferenceUsingGET","produces":["application/json"],"parameters":[{"name":"preference","in":"path","description":"preference","required":true,"type":"string"}],"responses":{"200":{"description":"Preference settings successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Insufficient privileges to retrieve the requested setting."},"404":{"description":"Tool ID not found in the system."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"head":{"tags":["async-operations-api"],"summary":"Returns the value of a particular async operations preference.","operationId":"getAsyncOperationsPreferenceUsingHEAD","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"preference","in":"path","description":"preference","required":true,"type":"string"}],"responses":{"200":{"description":"Preference settings successfully retrieved.","schema":{"type":"string"}},"204":{"description":"No Content"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Insufficient privileges to retrieve the requested setting."},"404":{"description":"Tool ID not found in the system."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"post":{"tags":["async-operations-api"],"summary":"Returns the value of a particular async operations preference.","operationId":"getAsyncOperationsPreferenceUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"preference","in":"path","description":"preference","required":true,"type":"string"}],"responses":{"200":{"description":"Preference settings successfully retrieved.","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Insufficient privileges to retrieve the requested setting."},"404":{"description":"Tool ID not found in the system."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["async-operations-api"],"summary":"Returns the value of a particular async operations preference.","operationId":"getAsyncOperationsPreferenceUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"preference","in":"path","description":"preference","required":true,"type":"string"}],"responses":{"200":{"description":"Preference settings successfully retrieved.","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Insufficient privileges to retrieve the requested setting."},"404":{"description":"Tool ID not found in the system."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["async-operations-api"],"summary":"Returns the value of a particular async operations preference.","operationId":"getAsyncOperationsPreferenceUsingDELETE","produces":["application/json"],"parameters":[{"name":"preference","in":"path","description":"preference","required":true,"type":"string"}],"responses":{"200":{"description":"Preference settings successfully retrieved.","schema":{"type":"string"}},"204":{"description":"No Content"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Insufficient privileges to retrieve the requested setting."},"404":{"description":"Tool ID not found in the system."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"options":{"tags":["async-operations-api"],"summary":"Returns the value of a particular async operations preference.","operationId":"getAsyncOperationsPreferenceUsingOPTIONS","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"preference","in":"path","description":"preference","required":true,"type":"string"}],"responses":{"200":{"description":"Preference settings successfully retrieved.","schema":{"type":"string"}},"204":{"description":"No Content"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Insufficient privileges to retrieve the requested setting."},"404":{"description":"Tool ID not found in the system."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"patch":{"tags":["async-operations-api"],"summary":"Returns the value of a particular async operations preference.","operationId":"getAsyncOperationsPreferenceUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"preference","in":"path","description":"preference","required":true,"type":"string"}],"responses":{"200":{"description":"Preference settings successfully retrieved.","schema":{"type":"string"}},"204":{"description":"No Content"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Insufficient privileges to retrieve the requested setting."},"404":{"description":"Tool ID not found in the system."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/automation":{"get":{"tags":["automation-api"],"summary":"Returns the full map of automation settings for this XNAT application.","description":"Complex objects may be returned as encapsulated JSON strings.","operationId":"getAllAutomationPreferencesUsingGET","produces":["application/json"],"responses":{"200":{"description":"Automation settings successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Insufficient privileges to retrieve the requested setting."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"post":{"tags":["automation-api"],"summary":"Sets a map of automation properties.","description":"Sets the automation properties specified in the map.","operationId":"setBatchAutomationPreferencesUsingPOST","consumes":["application/json","application/x-www-form-urlencoded"],"produces":["*/*"],"parameters":[{"in":"body","name":"properties","description":"The map of automation preferences to be set.","required":true,"schema":{"type":"object","additionalProperties":{"type":"string"}}}],"responses":{"200":{"description":"Automation properties successfully set."},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set automation properties."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/automation/enabled":{"get":{"tags":["automation-api"],"summary":"Indicates whether internal scripting is enabled for this XNAT system.","description":"Internal scripting may be used by XNAT itself even when disabled, but this setting indicates whether users and administrators can configure and execute scripts internally to the application process. Access to this setting is restricted to site administrators.","operationId":"isInternalScriptingEnabledUsingGET","produces":["application/json"],"responses":{"200":{"description":"Internal scripting setting successfully retrieved.","schema":{"type":"boolean"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Insufficient privileges to retrieve the requested setting."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/automation/enabled/{setting}":{"put":{"tags":["automation-api"],"summary":"Sets the internal scripting enabled flag for this XNAT application to the submitted value.","description":"Internal scripting may be used by XNAT itself even when disabled, but this setting indicates whether users and administrators can configure and execute scripts internally to the application process. Access to this setting is restricted to site administrators.Note that automation can also be 'hard disabled' via the application property 'automation.enabled'. That setting can *not* be overridden by calling this endpoint to set the internal preference to true.","operationId":"setInternalScriptingEnabledUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"setting","in":"path","description":"setting","required":true,"type":"boolean"}],"responses":{"200":{"description":"Internal scripting setting successfully set.","schema":{"type":"boolean"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Insufficient privileges to change the requested setting."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/caching":{"get":{"tags":["caching-api"],"summary":"Returns a list of all of the existing caches on the system.","operationId":"getAllCacheNamesUsingGET","produces":["application/json"],"responses":{"200":{"description":"XNAT cache names successfully retrieved.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Must be an administrator to view XNAT caches."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/caching/{cacheName}/info":{"get":{"tags":["caching-api"],"summary":"Returns the configuration for the specified cache.","description":"Throws NotFoundException if a cache with the specified name doesn't exist.","operationId":"getCacheInfoUsingGET","produces":["application/json"],"parameters":[{"name":"cacheName","in":"path","description":"cacheName","required":true,"type":"string"}],"responses":{"200":{"description":"XNAT cache configuration successfully retrieved.","schema":{"$ref":"#/definitions/CompleteConfiguration"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Must be an administrator to view XNAT caches."},"404":{"description":"No cache with the specified name exists."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/caching/{cacheName}/keys":{"get":{"tags":["caching-api"],"summary":"Returns a list of the keys in the specified cache.","description":"Throws NotFoundException if a cache with the specified name doesn't exist.","operationId":"getCacheKeysUsingGET","produces":["application/json"],"parameters":[{"name":"cacheName","in":"path","description":"cacheName","required":true,"type":"string"}],"responses":{"200":{"description":"XNAT cache keys successfully retrieved.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Must be an administrator to view XNAT caches."},"404":{"description":"No cache with the specified name exists."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/caching/{cacheName}/keys/{key}":{"get":{"tags":["caching-api"],"summary":"Returns a list of the keys in the specified cache.","description":"Throws NotFoundException if a cache with the specified name doesn't exist.","operationId":"getCacheValueUsingGET","produces":["application/json"],"parameters":[{"name":"cacheName","in":"path","description":"cacheName","required":true,"type":"string"},{"name":"key","in":"path","description":"key","required":true,"type":"string"}],"responses":{"200":{"description":"XNAT cache keys successfully retrieved.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Must be an administrator to view XNAT caches."},"404":{"description":"No cache with the specified name exists."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/compute/constraints":{"get":{"tags":["constraint-configs-api"],"summary":"Get all constraint configs.","operationId":"getAllUsingGET_1","produces":["application/json"],"responses":{"200":{"description":"Placement constraint configs successfully retrieved.","schema":{"type":"array","items":{"$ref":"#/definitions/ConstraintConfig"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["constraint-configs-api"],"summary":"Create a constraint config.","operationId":"createUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"constraintConfig","description":"constraintConfig","required":true,"schema":{"$ref":"#/definitions/ConstraintConfig"}}],"responses":{"201":{"description":"Placement constraint config successfully created.","schema":{"$ref":"#/definitions/ConstraintConfig"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/compute/constraints/{id}":{"get":{"tags":["constraint-configs-api"],"summary":"Get a constraint config.","operationId":"getUsingGET_1","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Placement constraint config successfully retrieved.","schema":{"$ref":"#/definitions/ConstraintConfig"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized."},"404":{"description":"Placement constraint config not found."},"500":{"description":"Unexpected error"}},"deprecated":false},"put":{"tags":["constraint-configs-api"],"summary":"Update a constraint config.","operationId":"updateUsingPUT_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"constraintConfig","description":"constraintConfig","required":true,"schema":{"$ref":"#/definitions/ConstraintConfig"}},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Placement constraint config successfully updated.","schema":{"$ref":"#/definitions/ConstraintConfig"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized."},"404":{"description":"Placement constraint config not found."},"500":{"description":"Unexpected error"}},"deprecated":false},"delete":{"tags":["constraint-configs-api"],"summary":"Delete a constraint config.","operationId":"deleteUsingDELETE_1","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"204":{"description":"Placement constraint config successfully deleted."},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized."},"404":{"description":"Placement constraint config not found."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/compute/environments":{"get":{"tags":["compute-environment-configs-api"],"summary":"Get all compute environment configs or all compute environment configs for a given type.","operationId":"getAllUsingGET","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"type","required":false,"type":"string","enum":["JUPYTERHUB","CONTAINER_SERVICE","GENERAL"]}],"responses":{"200":{"description":"Compute environment configs successfully retrieved.","schema":{"$ref":"#/definitions/ComputeEnvironmentConfig"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["compute-environment-configs-api"],"summary":"Create a compute environment config.","operationId":"createUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"computeEnvironmentConfig","description":"computeEnvironmentConfig","required":true,"schema":{"$ref":"#/definitions/ComputeEnvironmentConfig"}}],"responses":{"201":{"description":"Compute environment config successfully created.","schema":{"$ref":"#/definitions/ComputeEnvironmentConfig"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/compute/environments/available":{"get":{"tags":["compute-environment-configs-api"],"summary":"Get all available compute environment configs for the provided execution scope.","operationId":"getAvailableUsingGET","produces":["application/json"],"parameters":[{"name":"params","in":"query","description":"params","required":true,"items":{"type":"object","additionalProperties":{"type":"string"}}}],"responses":{"200":{"description":"Compute environment configs successfully retrieved.","schema":{"type":"array","items":{"$ref":"#/definitions/ComputeEnvironmentConfig"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/compute/environments/{id}":{"get":{"tags":["compute-environment-configs-api"],"summary":"Get a compute environment config.","operationId":"getUsingGET","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Compute environment config successfully retrieved.","schema":{"$ref":"#/definitions/ComputeEnvironmentConfig"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized."},"404":{"description":"Compute environment config not found."},"500":{"description":"Unexpected error"}},"deprecated":false},"put":{"tags":["compute-environment-configs-api"],"summary":"Update a compute environment config.","operationId":"updateUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"computeEnvironmentConfig","description":"computeEnvironmentConfig","required":true,"schema":{"$ref":"#/definitions/ComputeEnvironmentConfig"}},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Compute environment config successfully updated.","schema":{"$ref":"#/definitions/ComputeEnvironmentConfig"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized."},"404":{"description":"Compute environment config not found."},"500":{"description":"Unexpected error"}},"deprecated":false},"delete":{"tags":["compute-environment-configs-api"],"summary":"Delete a compute environment config.","operationId":"deleteUsingDELETE","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"204":{"description":"Compute environment config successfully deleted."},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized."},"404":{"description":"Compute environment config not found."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/compute/hardware":{"get":{"tags":["hardware-configs-api"],"summary":"Get all hardware configs.","operationId":"getAllUsingGET_3","produces":["application/json"],"responses":{"200":{"description":"Hardware configs successfully retrieved.","schema":{"$ref":"#/definitions/HardwareConfig"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["hardware-configs-api"],"summary":"Create a hardware config.","operationId":"createUsingPOST_2","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"hardwareConfig","description":"hardwareConfig","required":true,"schema":{"$ref":"#/definitions/HardwareConfig"}}],"responses":{"201":{"description":"Hardware config successfully created.","schema":{"$ref":"#/definitions/HardwareConfig"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/compute/hardware/{id}":{"get":{"tags":["hardware-configs-api"],"summary":"Get a hardware config.","operationId":"getUsingGET_2","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Hardware config successfully retrieved.","schema":{"$ref":"#/definitions/HardwareConfig"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized."},"404":{"description":"Hardware config not found."},"500":{"description":"Unexpected error"}},"deprecated":false},"put":{"tags":["hardware-configs-api"],"summary":"Update a hardware config.","operationId":"updateUsingPUT_3","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"hardwareConfig","description":"hardwareConfig","required":true,"schema":{"$ref":"#/definitions/HardwareConfig"}},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Hardware config successfully updated.","schema":{"$ref":"#/definitions/HardwareConfig"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized."},"404":{"description":"Hardware config not found."},"500":{"description":"Unexpected error"}},"deprecated":false},"delete":{"tags":["hardware-configs-api"],"summary":"Delete a hardware config.","operationId":"deleteUsingDELETE_6","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"204":{"description":"Hardware config successfully deleted."},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized."},"404":{"description":"Hardware config not found."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/contrasts/create/{sessionID}":{"put":{"tags":["contrast-api"],"summary":"Create a new contrast entry for a specific scan.","operationId":"createContrastUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"contrast","description":"contrast","required":true,"schema":{"$ref":"#/definitions/ContrastBolus"}},{"name":"sessionID","in":"path","description":"sessionID","required":true,"type":"string"}],"responses":{"200":{"description":"Contrast bolus successfully created.","schema":{"$ref":"#/definitions/ContrastBolus"}},"201":{"description":"Created"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/contrasts/delete/{sessionID}":{"delete":{"tags":["contrast-api"],"summary":"Delete contrast entry for a specific scan","operationId":"deleteContrastUsingDELETE","produces":["application/json"],"parameters":[{"in":"body","name":"contrast","description":"contrast","required":true,"schema":{"$ref":"#/definitions/ContrastBolus"}},{"name":"sessionID","in":"path","description":"sessionID","required":true,"type":"string"}],"responses":{"200":{"description":"The deleted contrast bolus."},"204":{"description":"No Content"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/contrasts/save/{sessionID}":{"put":{"tags":["contrast-api"],"summary":"Update a specific contrast entry for a given scan.","operationId":"updateContrastUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"contrast","description":"contrast","required":true,"schema":{"$ref":"#/definitions/ContrastBolus"}},{"name":"sessionID","in":"path","description":"sessionID","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully updated contrast bolus.","schema":{"$ref":"#/definitions/ContrastBolus"}},"201":{"description":"Created"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/contrasts/{sessionID}":{"get":{"tags":["contrast-api"],"summary":"Get contrast entries for session.","description":"Returns a list of Contrast Bolus entries","operationId":"getContrastEntriesUsingGET","produces":["application/json"],"parameters":[{"name":"sessionID","in":"path","description":"The session ID (Accesssion Number).","required":true,"type":"string"}],"responses":{"200":{"description":"A list of Contrast Bolus elements","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/custom-fields/experiments/{experiment}/assessors/{assessor}/fields":{"get":{"tags":["custom-fields-api"],"summary":"Get custom fields for an item.","operationId":"getFieldsUsingGET","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldNames","in":"query","description":"fieldNames","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A list of custom fields.","schema":{"$ref":"#/definitions/JsonNode"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["custom-fields-api"],"summary":"Set the value for one or more custom fields.","operationId":"updateFieldsUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"in":"body","name":"newFields","description":"newFields","required":true,"schema":{"$ref":"#/definitions/JsonNode"}},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"The updated list of fields.","schema":{"$ref":"#/definitions/JsonNode"}},"201":{"description":"Created"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/experiments/{experiment}/assessors/{assessor}/fields/{fieldName}":{"get":{"tags":["custom-fields-api"],"summary":"Get the text value of a custom field.","operationId":"getFieldValueUsingGET","produces":["text/plain"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A custom field value.","schema":{"type":"string"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["custom-fields-api"],"summary":"Delete a custom field.","operationId":"deleteFieldUsingDELETE","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"Field deleted.","schema":{"$ref":"#/definitions/JsonNode"}},"204":{"description":"No Content"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/experiments/{experiment}/fields":{"get":{"tags":["custom-fields-api"],"summary":"Get custom fields for an item.","operationId":"getFieldsUsingGET_1","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldNames","in":"query","description":"fieldNames","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A list of custom fields.","schema":{"$ref":"#/definitions/JsonNode"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["custom-fields-api"],"summary":"Set the value for one or more custom fields.","operationId":"updateFieldsUsingPUT_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"in":"body","name":"newFields","description":"newFields","required":true,"schema":{"$ref":"#/definitions/JsonNode"}},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"The updated list of fields.","schema":{"$ref":"#/definitions/JsonNode"}},"201":{"description":"Created"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/experiments/{experiment}/fields/{fieldName}":{"get":{"tags":["custom-fields-api"],"summary":"Get the text value of a custom field.","operationId":"getFieldValueUsingGET_1","produces":["text/plain"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A custom field value.","schema":{"type":"string"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["custom-fields-api"],"summary":"Delete a custom field.","operationId":"deleteFieldUsingDELETE_1","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"Field deleted.","schema":{"$ref":"#/definitions/JsonNode"}},"204":{"description":"No Content"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/experiments/{experiment}/scans/{scan}/fields":{"get":{"tags":["custom-fields-api"],"summary":"Get custom fields for an item.","operationId":"getFieldsUsingGET_2","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldNames","in":"query","description":"fieldNames","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A list of custom fields.","schema":{"$ref":"#/definitions/JsonNode"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["custom-fields-api"],"summary":"Set the value for one or more custom fields.","operationId":"updateFieldsUsingPUT_2","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"in":"body","name":"newFields","description":"newFields","required":true,"schema":{"$ref":"#/definitions/JsonNode"}},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"The updated list of fields.","schema":{"$ref":"#/definitions/JsonNode"}},"201":{"description":"Created"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/experiments/{experiment}/scans/{scan}/fields/{fieldName}":{"get":{"tags":["custom-fields-api"],"summary":"Get the text value of a custom field.","operationId":"getFieldValueUsingGET_2","produces":["text/plain"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A custom field value.","schema":{"type":"string"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["custom-fields-api"],"summary":"Delete a custom field.","operationId":"deleteFieldUsingDELETE_2","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"Field deleted.","schema":{"$ref":"#/definitions/JsonNode"}},"204":{"description":"No Content"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/projects/{project}/experiments/{experiment}/assessors/{assessor}/fields":{"get":{"tags":["custom-fields-api"],"summary":"Get custom fields for an item.","operationId":"getFieldsUsingGET_3","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldNames","in":"query","description":"fieldNames","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A list of custom fields.","schema":{"$ref":"#/definitions/JsonNode"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["custom-fields-api"],"summary":"Set the value for one or more custom fields.","operationId":"updateFieldsUsingPUT_3","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"in":"body","name":"newFields","description":"newFields","required":true,"schema":{"$ref":"#/definitions/JsonNode"}},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"The updated list of fields.","schema":{"$ref":"#/definitions/JsonNode"}},"201":{"description":"Created"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/projects/{project}/experiments/{experiment}/assessors/{assessor}/fields/{fieldName}":{"get":{"tags":["custom-fields-api"],"summary":"Get the text value of a custom field.","operationId":"getFieldValueUsingGET_3","produces":["text/plain"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A custom field value.","schema":{"type":"string"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["custom-fields-api"],"summary":"Delete a custom field.","operationId":"deleteFieldUsingDELETE_3","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"Field deleted.","schema":{"$ref":"#/definitions/JsonNode"}},"204":{"description":"No Content"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/projects/{project}/experiments/{experiment}/fields":{"get":{"tags":["custom-fields-api"],"summary":"Get custom fields for an item.","operationId":"getFieldsUsingGET_4","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldNames","in":"query","description":"fieldNames","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A list of custom fields.","schema":{"$ref":"#/definitions/JsonNode"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["custom-fields-api"],"summary":"Set the value for one or more custom fields.","operationId":"updateFieldsUsingPUT_4","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"in":"body","name":"newFields","description":"newFields","required":true,"schema":{"$ref":"#/definitions/JsonNode"}},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"The updated list of fields.","schema":{"$ref":"#/definitions/JsonNode"}},"201":{"description":"Created"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/projects/{project}/experiments/{experiment}/fields/{fieldName}":{"get":{"tags":["custom-fields-api"],"summary":"Get the text value of a custom field.","operationId":"getFieldValueUsingGET_4","produces":["text/plain"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A custom field value.","schema":{"type":"string"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["custom-fields-api"],"summary":"Delete a custom field.","operationId":"deleteFieldUsingDELETE_4","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"Field deleted.","schema":{"$ref":"#/definitions/JsonNode"}},"204":{"description":"No Content"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/projects/{project}/experiments/{experiment}/scans/{scan}/fields":{"get":{"tags":["custom-fields-api"],"summary":"Get custom fields for an item.","operationId":"getFieldsUsingGET_5","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldNames","in":"query","description":"fieldNames","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A list of custom fields.","schema":{"$ref":"#/definitions/JsonNode"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["custom-fields-api"],"summary":"Set the value for one or more custom fields.","operationId":"updateFieldsUsingPUT_5","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"in":"body","name":"newFields","description":"newFields","required":true,"schema":{"$ref":"#/definitions/JsonNode"}},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"The updated list of fields.","schema":{"$ref":"#/definitions/JsonNode"}},"201":{"description":"Created"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/projects/{project}/experiments/{experiment}/scans/{scan}/fields/{fieldName}":{"get":{"tags":["custom-fields-api"],"summary":"Get the text value of a custom field.","operationId":"getFieldValueUsingGET_5","produces":["text/plain"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A custom field value.","schema":{"type":"string"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["custom-fields-api"],"summary":"Delete a custom field.","operationId":"deleteFieldUsingDELETE_5","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"Field deleted.","schema":{"$ref":"#/definitions/JsonNode"}},"204":{"description":"No Content"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/projects/{project}/fields":{"get":{"tags":["custom-fields-api"],"summary":"Get custom fields for an item.","operationId":"getFieldsUsingGET_6","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldNames","in":"query","description":"fieldNames","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A list of custom fields.","schema":{"$ref":"#/definitions/JsonNode"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["custom-fields-api"],"summary":"Set the value for one or more custom fields.","operationId":"updateFieldsUsingPUT_6","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"in":"body","name":"newFields","description":"newFields","required":true,"schema":{"$ref":"#/definitions/JsonNode"}},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"The updated list of fields.","schema":{"$ref":"#/definitions/JsonNode"}},"201":{"description":"Created"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/projects/{project}/fields/{fieldName}":{"get":{"tags":["custom-fields-api"],"summary":"Get the text value of a custom field.","operationId":"getFieldValueUsingGET_6","produces":["text/plain"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A custom field value.","schema":{"type":"string"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["custom-fields-api"],"summary":"Delete a custom field.","operationId":"deleteFieldUsingDELETE_6","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"Field deleted.","schema":{"$ref":"#/definitions/JsonNode"}},"204":{"description":"No Content"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/projects/{project}/subjects/{subject}/experiments/{experiment}/assessors/{assessor}/fields":{"get":{"tags":["custom-fields-api"],"summary":"Get custom fields for an item.","operationId":"getFieldsUsingGET_7","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldNames","in":"query","description":"fieldNames","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A list of custom fields.","schema":{"$ref":"#/definitions/JsonNode"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["custom-fields-api"],"summary":"Set the value for one or more custom fields.","operationId":"updateFieldsUsingPUT_7","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"in":"body","name":"newFields","description":"newFields","required":true,"schema":{"$ref":"#/definitions/JsonNode"}},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"The updated list of fields.","schema":{"$ref":"#/definitions/JsonNode"}},"201":{"description":"Created"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/projects/{project}/subjects/{subject}/experiments/{experiment}/assessors/{assessor}/fields/{fieldName}":{"get":{"tags":["custom-fields-api"],"summary":"Get the text value of a custom field.","operationId":"getFieldValueUsingGET_7","produces":["text/plain"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A custom field value.","schema":{"type":"string"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["custom-fields-api"],"summary":"Delete a custom field.","operationId":"deleteFieldUsingDELETE_7","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"Field deleted.","schema":{"$ref":"#/definitions/JsonNode"}},"204":{"description":"No Content"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/projects/{project}/subjects/{subject}/experiments/{experiment}/fields":{"get":{"tags":["custom-fields-api"],"summary":"Get custom fields for an item.","operationId":"getFieldsUsingGET_8","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldNames","in":"query","description":"fieldNames","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A list of custom fields.","schema":{"$ref":"#/definitions/JsonNode"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["custom-fields-api"],"summary":"Set the value for one or more custom fields.","operationId":"updateFieldsUsingPUT_8","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"in":"body","name":"newFields","description":"newFields","required":true,"schema":{"$ref":"#/definitions/JsonNode"}},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"The updated list of fields.","schema":{"$ref":"#/definitions/JsonNode"}},"201":{"description":"Created"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/projects/{project}/subjects/{subject}/experiments/{experiment}/fields/{fieldName}":{"get":{"tags":["custom-fields-api"],"summary":"Get the text value of a custom field.","operationId":"getFieldValueUsingGET_8","produces":["text/plain"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A custom field value.","schema":{"type":"string"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["custom-fields-api"],"summary":"Delete a custom field.","operationId":"deleteFieldUsingDELETE_8","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"Field deleted.","schema":{"$ref":"#/definitions/JsonNode"}},"204":{"description":"No Content"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/projects/{project}/subjects/{subject}/experiments/{experiment}/scans/{scan}/fields":{"get":{"tags":["custom-fields-api"],"summary":"Get custom fields for an item.","operationId":"getFieldsUsingGET_9","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldNames","in":"query","description":"fieldNames","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A list of custom fields.","schema":{"$ref":"#/definitions/JsonNode"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["custom-fields-api"],"summary":"Set the value for one or more custom fields.","operationId":"updateFieldsUsingPUT_9","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"in":"body","name":"newFields","description":"newFields","required":true,"schema":{"$ref":"#/definitions/JsonNode"}},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"The updated list of fields.","schema":{"$ref":"#/definitions/JsonNode"}},"201":{"description":"Created"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/projects/{project}/subjects/{subject}/experiments/{experiment}/scans/{scan}/fields/{fieldName}":{"get":{"tags":["custom-fields-api"],"summary":"Get the text value of a custom field.","operationId":"getFieldValueUsingGET_9","produces":["text/plain"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A custom field value.","schema":{"type":"string"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["custom-fields-api"],"summary":"Delete a custom field.","operationId":"deleteFieldUsingDELETE_9","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"Field deleted.","schema":{"$ref":"#/definitions/JsonNode"}},"204":{"description":"No Content"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/projects/{project}/subjects/{subject}/fields":{"get":{"tags":["custom-fields-api"],"summary":"Get custom fields for an item.","operationId":"getFieldsUsingGET_10","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldNames","in":"query","description":"fieldNames","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A list of custom fields.","schema":{"$ref":"#/definitions/JsonNode"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["custom-fields-api"],"summary":"Set the value for one or more custom fields.","operationId":"updateFieldsUsingPUT_10","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"in":"body","name":"newFields","description":"newFields","required":true,"schema":{"$ref":"#/definitions/JsonNode"}},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"The updated list of fields.","schema":{"$ref":"#/definitions/JsonNode"}},"201":{"description":"Created"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/projects/{project}/subjects/{subject}/fields/{fieldName}":{"get":{"tags":["custom-fields-api"],"summary":"Get the text value of a custom field.","operationId":"getFieldValueUsingGET_10","produces":["text/plain"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A custom field value.","schema":{"type":"string"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["custom-fields-api"],"summary":"Delete a custom field.","operationId":"deleteFieldUsingDELETE_10","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"Field deleted.","schema":{"$ref":"#/definitions/JsonNode"}},"204":{"description":"No Content"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/subjects/{subject}/fields":{"get":{"tags":["custom-fields-api"],"summary":"Get custom fields for an item.","operationId":"getFieldsUsingGET_11","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldNames","in":"query","description":"fieldNames","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A list of custom fields.","schema":{"$ref":"#/definitions/JsonNode"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["custom-fields-api"],"summary":"Set the value for one or more custom fields.","operationId":"updateFieldsUsingPUT_11","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"in":"body","name":"newFields","description":"newFields","required":true,"schema":{"$ref":"#/definitions/JsonNode"}},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"The updated list of fields.","schema":{"$ref":"#/definitions/JsonNode"}},"201":{"description":"Created"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/custom-fields/subjects/{subject}/fields/{fieldName}":{"get":{"tags":["custom-fields-api"],"summary":"Get the text value of a custom field.","operationId":"getFieldValueUsingGET_11","produces":["text/plain"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"A custom field value.","schema":{"type":"string"}},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Cannot access data item."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["custom-fields-api"],"summary":"Delete a custom field.","operationId":"deleteFieldUsingDELETE_11","produces":["application/json"],"parameters":[{"name":"assessor","in":"path","description":"The assessor","required":false,"type":"string"},{"name":"experiment","in":"path","description":"The experiment","required":false,"type":"string"},{"name":"fieldName","in":"path","description":"fieldName","required":true,"type":"string"},{"name":"project","in":"path","description":"The project","required":false,"type":"string"},{"name":"scan","in":"path","description":"The scan","required":false,"type":"string"},{"name":"subject","in":"path","description":"The subject","required":false,"type":"string"}],"responses":{"200":{"description":"Field deleted.","schema":{"$ref":"#/definitions/JsonNode"}},"204":{"description":"No Content"},"400":{"description":"Bad request."},"401":{"description":"Unauthorized"},"403":{"description":"Not allowed."},"404":{"description":"Item not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/customforms":{"get":{"tags":["custom-forms-api"],"summary":"Gets list of all site wide and projects which have custom forms","description":"Gets Site wide and project Custom Form configurations","operationId":"getAllCustomFormConfigurationsUsingGET","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"projectId","in":"query","description":"projectId","required":false,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"delete":{"tags":["custom-forms-api"],"summary":"Deletes a form","description":"Deletes a form is not backed up by data","operationId":"deleteCustomFormUsingDELETE","consumes":["application/json;charset=UTF-8"],"produces":["*/*"],"parameters":[{"in":"body","name":"jsonbody","description":"jsonbody","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/customforms/disable":{"post":{"tags":["custom-forms-api"],"summary":"Marks a form as disabled","description":"Marks a form as disabled","operationId":"disableCustomFormUsingPOST","consumes":["application/json;charset=UTF-8"],"produces":["*/*"],"parameters":[{"in":"body","name":"jsonbody","description":"jsonbody","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/customforms/displayfields/reload":{"post":{"tags":["custom-form-display-field-api"],"summary":"Reloads Custom Form Display fields","description":"Reloads Custom Form Display fields","operationId":"reloadCustomFormDisplayFieldsUsingPOST","consumes":["application/json"],"produces":["*/*"],"responses":{"200":{"description":"Success"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/customforms/element":{"get":{"tags":["custom-forms-api"],"summary":"Gets Custom Form JSON for a given entity","description":"Gets Custom Form JSON for a given entity","operationId":"getCustomFormUsingGET","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"appendPrevNextButtons","in":"query","description":"appendPrevNextButtons","required":true,"type":"boolean"},{"name":"id","in":"query","description":"id","required":false,"type":"string"},{"name":"projectId","in":"query","description":"projectId","required":false,"type":"string"},{"name":"subtype","in":"query","description":"subtype","required":false,"type":"string"},{"name":"visitId","in":"query","description":"visitId","required":false,"type":"string"},{"name":"xsiType","in":"query","description":"xsiType","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/customforms/enable":{"post":{"tags":["custom-forms-api"],"summary":"Marks a form as enabled","description":"Marks a form as enabled","operationId":"enableCustomFormUsingPOST","consumes":["application/json;charset=UTF-8"],"produces":["*/*"],"parameters":[{"in":"body","name":"jsonbody","description":"jsonbody","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/customforms/env":{"get":{"tags":["custom-forms-api"],"summary":"Get the XNAT Deployment environment related to FormsIO","description":"Get the XNAT Deployment environment related to FormsIO","operationId":"getXnatEnvironmentForFormsIOUsingGET","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"projectId","in":"query","description":"projectId","required":false,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/customforms/formId/{formId}":{"post":{"tags":["custom-forms-api"],"summary":"Set display order of a form","description":"The order must be within the range [-11000000, 1000000]","operationId":"modifyFormDisplayOrderUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"displayOrder","in":"query","description":"displayOrder","required":true,"type":"integer","format":"int32"},{"name":"formId","in":"path","description":"formId","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/customforms/hasdata/{rowId}":{"get":{"tags":["custom-forms-api"],"summary":"Checks to see if any data has been created and associated with a given custom form.","operationId":"checkForCustomFormHasDataUsingGET","produces":["*/*"],"parameters":[{"name":"rowId","in":"path","description":"rowId","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/customforms/optin/{rowId}":{"post":{"tags":["custom-forms-api"],"summary":"Add projects to an existing form","description":"Add projects to an existing form","operationId":"optInCustomFormUsingPOST","consumes":["application/json;charset=UTF-8"],"produces":["*/*"],"parameters":[{"in":"body","name":"jsonbody","description":"jsonbody","required":true,"schema":{"type":"string"}},{"name":"rowId","in":"path","description":"rowId","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/customforms/optout/{formId}":{"post":{"tags":["custom-forms-api"],"summary":"Opt out of a form","description":"Opt out of a form","operationId":"optOutCustomFormUsingPOST","consumes":["application/json;charset=UTF-8"],"produces":["*/*"],"parameters":[{"name":"formId","in":"path","description":"formId","required":true,"type":"string"},{"in":"body","name":"jsonbody","description":"jsonbody","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/customforms/promote":{"post":{"tags":["custom-forms-api"],"summary":"Promote a Project specific form to Site Repository","description":"Promote a form to site repository","operationId":"promoteformUsingPOST","consumes":["application/json;charset=UTF-8"],"produces":["*/*"],"parameters":[{"in":"body","name":"jsonbody","description":"jsonbody","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/customforms/save":{"put":{"tags":["custom-forms-api"],"summary":"Accepts a JSON","description":"Accepts a JSON","operationId":"addCustomFormsToProtocolsAndProjectsUsingPUT","consumes":["application/json;charset=UTF-8"],"produces":["*/*"],"parameters":[{"in":"body","name":"jsonbody","description":"jsonbody","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/datatypes":{"get":{"tags":["data-types-api"],"summary":"Get all data types","description":"Returns a list of all XNAT data types with their properties.","operationId":"getDataTypesUsingGET","produces":["application/json"],"parameters":[{"name":"readable","in":"query","description":"Use readable counts instead of total counts","required":false,"type":"boolean","allowEmptyValue":false},{"name":"secured","in":"query","description":"Filter to only secured data types","required":false,"type":"boolean","allowEmptyValue":false},{"name":"used","in":"query","description":"Filter to only data types with existing data","required":false,"type":"boolean","allowEmptyValue":false}],"responses":{"200":{"description":"Successfully retrieved data types","schema":{"type":"array","items":{"$ref":"#/definitions/Map«string,object»"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal server error"}},"deprecated":false}},"/datatypes/create":{"post":{"tags":["data-types-api"],"summary":"Create a new data type","description":"Creates a new XNAT data type with the specified parameters. Requires administrator privileges.","operationId":"createDataTypeUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"complexType","in":"query","description":"Complex type name (optional, will derive from name if not provided)","required":false,"type":"string","allowEmptyValue":false},{"name":"extends","in":"query","description":"Base type to extend (e.g., 'subjectAssessorData', 'imageAssessorData')","required":true,"type":"string","allowEmptyValue":false},{"name":"name","in":"query","description":"Backend name of the data type","required":true,"type":"string","allowEmptyValue":false},{"name":"plural","in":"query","description":"Plural display name","required":true,"type":"string","allowEmptyValue":false},{"name":"prefix","in":"query","description":"Schema prefix (optional, will auto-generate if not provided)","required":false,"type":"string","allowEmptyValue":false},{"name":"singular","in":"query","description":"Singular display name","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Data type created successfully","schema":{"type":"string"}},"400":{"description":"Invalid request parameters"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions or extension type not allowed"},"404":{"description":"Not Found"},"409":{"description":"Data type already exists"},"500":{"description":"Internal server error"}},"deprecated":false}},"/datatypes/{elementName}":{"get":{"tags":["data-types-api"],"summary":"Get a specific data type","description":"Returns detailed information about a specific data type including all its properties.","operationId":"getDataTypeUsingGET","produces":["application/json"],"parameters":[{"name":"elementName","in":"path","description":"Element name of the data type","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully retrieved data type","schema":{"type":"object","additionalProperties":{"type":"object"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Data type not found"},"500":{"description":"Internal server error"}},"deprecated":false}},"/datatypes/{elementName}/actions":{"get":{"tags":["data-types-api"],"summary":"Get actions for a data type","description":"Returns the list of actions configured for a specific data type.","operationId":"getDataTypeActionsUsingGET","produces":["application/json"],"parameters":[{"name":"elementName","in":"path","description":"Element name of the data type","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully retrieved actions","schema":{"type":"array","items":{"$ref":"#/definitions/Map«string,object»"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Data type not found"},"500":{"description":"Internal server error"}},"deprecated":false},"post":{"tags":["data-types-api"],"summary":"Add actions to a data type","description":"Adds one or more actions to a data type. Requires administrator privileges.","operationId":"addDataTypeActionsUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"actionsToAdd","description":"List of actions to add","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/Map«string,string»"}}},{"name":"elementName","in":"path","description":"Element name of the data type","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully added actions","schema":{"type":"string"}},"201":{"description":"Created"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Data type not found"},"500":{"description":"Internal server error"}},"deprecated":false}},"/dbschemas":{"get":{"tags":["db-backed-schema-api"],"summary":"getAllSchemas","operationId":"getAllSchemasUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Map«string,object»"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/dbschemas/{id}":{"delete":{"tags":["db-backed-schema-api"],"summary":"deleteSchema","operationId":"deleteSchemaUsingDELETE","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/dbschemas/{id}/load":{"post":{"tags":["db-backed-schema-api"],"summary":"loadSchema","operationId":"loadSchemaUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/dbschemas/{id}/schema":{"get":{"tags":["db-backed-schema-api"],"summary":"downloadSchema","operationId":"downloadSchemaUsingGET","produces":["application/xml"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/dicom/list/active":{"get":{"tags":["dicom-transaction-api"],"summary":"Get a list of all outstanding (i.e. not completed or failed) inbox import requests.","operationId":"getOutstandingDicomInboxImportRequestsUsingGET","produces":["application/json"],"responses":{"200":{"description":"All outstanding inbox import requests are returned.","schema":{"type":"array","items":{"$ref":"#/definitions/DicomInboxImportRequest"}}},"401":{"description":"Unauthorized"},"403":{"description":"The user has insufficient authorization to access the list of inbox import requests."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/dicom/list/all":{"get":{"tags":["dicom-transaction-api"],"summary":"Get a list of all inbox import requests.","operationId":"getDicomInboxImportRequestsUsingGET","produces":["application/json"],"responses":{"200":{"description":"All inbox import requests are returned.","schema":{"type":"array","items":{"$ref":"#/definitions/DicomInboxImportRequest"}}},"401":{"description":"Unauthorized"},"403":{"description":"The user has insufficient authorization to access the list of inbox import requests."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/dicom/{id}":{"get":{"tags":["dicom-transaction-api"],"summary":"Retrieves the requested inbox import request.","operationId":"getDicomInboxImportRequestUsingGET","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"All outstanding inbox import requests are returned.","schema":{"$ref":"#/definitions/DicomInboxImportRequest"}},"401":{"description":"Unauthorized"},"403":{"description":"The user has insufficient authorization to access the list of inbox import requests."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/dicom_mappings":{"get":{"tags":["dicom-mapping-api"],"summary":"getAll","operationId":"getAllUsingGET_2","produces":["application/json"],"responses":{"200":{"description":"The operation completed successfully.","schema":{"type":"array","items":{"$ref":"#/definitions/DicomMapping"}}},"400":{"description":"Something is wrong with your request"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error."}},"deprecated":false}},"/dicom_mappings/update":{"put":{"tags":["dicom-mapping-api"],"summary":"Create or update.","operationId":"updateUsingPUT_2","consumes":["application/json"],"produces":["text/html"],"parameters":[{"in":"body","name":"pojo","description":"pojo","required":true,"schema":{"$ref":"#/definitions/DicomMapping"}}],"responses":{"200":{"description":"The operation completed successfully.","schema":{"type":"string"}},"201":{"description":"Created"},"400":{"description":"Something is wrong with your request"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error."}},"deprecated":false}},"/dicom_mappings/{id}":{"delete":{"tags":["dicom-mapping-api"],"summary":"Delete.","operationId":"deleteUsingDELETE_2","produces":["text/html"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"The operation completed successfully.","schema":{"type":"string"}},"204":{"description":"No Content"},"400":{"description":"Something is wrong with your request"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"500":{"description":"Unexpected error."}},"deprecated":false}},"/dicomscp":{"get":{"tags":["dicom-scp-api"],"summary":"Get list of all configured DICOM SCP receiver definitions.","description":"The primary DICOM SCP retrieval function returns a list of all DICOM SCP receivers defined for the current system.","operationId":"getDicomSCPInstancesUsingGET","produces":["application/json"],"responses":{"200":{"description":"A list of DICOM SCP receiver definitions.","schema":{"type":"array","items":{"$ref":"#/definitions/DicomSCPInstance"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["dicom-scp-api"],"summary":"Creates a new DICOM SCP receiver from the request body.","description":"The newly created DICOM SCP receiver instance is returned from the call. This should include the instance ID for the new object.","operationId":"createDicomSCPInstanceUsingPOST","consumes":["application/json","multipart/form-data","application/x-www-form-urlencoded"],"produces":["application/json"],"parameters":[{"in":"body","name":"instance","description":"instance","required":true,"schema":{"$ref":"#/definitions/DicomSCPInstance"}}],"responses":{"200":{"description":"The newly created DICOM SCP receiver definition.","schema":{"$ref":"#/definitions/DicomSCPInstance"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to view this DICOM SCP receiver definition."},"404":{"description":"Not Found"},"409":{"description":"A DICOM SCP receiver already exists and is enabled at the same AE title and port."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/dicomscp/identifiers":{"get":{"tags":["dicom-scp-api"],"summary":"Get map of all configured DICOM object identifiers and names.","description":"This function returns a map of all DICOM object identifiers defined for the current system along with each identifier's readable name. The default identifier will be the first in the list.","operationId":"getDicomObjectIdentifiersUsingGET","produces":["application/json"],"responses":{"200":{"description":"A map of DICOM object identifiers and names.","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"put":{"tags":["dicom-scp-api"],"summary":"Resets all configured DICOM object identifiers.","description":"This function resets all of the DICOM object identifiers defined for the current system. This causes each identifier to reload its configuration on next access.","operationId":"resetDicomObjectIdentifiersUsingPUT","consumes":["application/json"],"produces":["application/json"],"responses":{"200":{"description":"The DICOM object identifiers were successfully reset."},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/dicomscp/identifiers/{beanId}":{"get":{"tags":["dicom-scp-api"],"summary":"Get implementation name of the specified DICOM object identifier.","description":"This function returns the fully-qualified class name of the specified DICOM object identifier. You can use the value 'default' to retrieve the default identifier even if you don't know the specific name.","operationId":"getDicomObjectIdentifierUsingGET","produces":["application/json"],"parameters":[{"name":"beanId","in":"path","description":"beanId","required":true,"type":"string"}],"responses":{"200":{"description":"The implementation class of the specified DICOM object identifier.","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"No DICOM object identifier with the specified ID was found."},"500":{"description":"Unexpected error"}},"deprecated":false},"put":{"tags":["dicom-scp-api"],"summary":"Resets the specified DICOM object identifier.","description":"This function resets the specified DICOM object identifier. This causes the identifier to reload its configuration on next access.","operationId":"resetDicomObjectIdentifierUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"beanId","in":"path","description":"beanId","required":true,"type":"string"}],"responses":{"200":{"description":"The DICOM object identifiers were successfully reset."},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"No DICOM object identifier with the specified ID was found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/dicomscp/start":{"put":{"tags":["dicom-scp-api"],"summary":"Starts all enabled DICOM SCP receivers.","description":"This starts all enabled DICOM SCP receivers. The return value contains the AE titles and ports of all of the started receivers.","operationId":"startAllUsingPUT","consumes":["application/json"],"produces":["application/json"],"responses":{"200":{"description":"DICOM SCP receivers successfully started.","schema":{"type":"array","items":{"type":"string"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to enable or disable this DICOM SCP receiver definition."},"404":{"description":"DICOM SCP receiver definition not found."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/dicomscp/stop":{"put":{"tags":["dicom-scp-api"],"summary":"Stops all enabled DICOM SCP receivers.","description":"This stops all enabled DICOM SCP receivers. The return value contains the AE titles of all of the stopped receivers.","operationId":"stopDicomSCPInstancesUsingPUT","consumes":["application/json"],"produces":["application/json"],"responses":{"200":{"description":"DICOM SCP receivers successfully stopped.","schema":{"type":"array","items":{"type":"string"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to enable or disable this DICOM SCP receiver definition."},"404":{"description":"DICOM SCP receiver definition not found."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/dicomscp/title/{title}/{port}":{"get":{"tags":["dicom-scp-api"],"summary":"Gets the DICOM SCP receiver definition with the specified AE title and port.","description":"Returns the DICOM SCP receiver definition with the specified AE title and port.","operationId":"getDicomSCPInstanceByTitleAndPortUsingGET","produces":["application/json"],"parameters":[{"name":"port","in":"path","description":"Port of the DICOM SCP receiver definition to fetch","required":true,"type":"integer","format":"int32"},{"name":"title","in":"path","description":"AE title of the DICOM SCP receiver definition to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"DICOM SCP receiver definition successfully retrieved.","schema":{"$ref":"#/definitions/DicomSCPInstance"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to view this DICOM SCP receiver definition."},"404":{"description":"DICOM SCP receiver definition not found."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/dicomscp/{id}":{"get":{"tags":["dicom-scp-api"],"summary":"Gets the DICOM SCP receiver definition with the specified ID.","description":"Returns the DICOM SCP receiver definition with the specified ID.","operationId":"getDicomSCPInstanceUsingGET","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"ID of the DICOM SCP receiver definition to fetch","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"DICOM SCP receiver definition successfully retrieved.","schema":{"$ref":"#/definitions/DicomSCPInstance"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to view this DICOM SCP receiver definition."},"404":{"description":"DICOM SCP receiver definition not found."},"500":{"description":"Unexpected error"}},"deprecated":false},"put":{"tags":["dicom-scp-api"],"summary":"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.","description":"Returns the updated DICOM SCP receiver definition.","operationId":"updateDicomSCPInstanceUsingPUT","consumes":["application/json","multipart/form-data","application/x-www-form-urlencoded"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"The ID of the DICOM SCP receiver definition to update.","required":true,"type":"integer","format":"int32"},{"in":"body","name":"instanceJson","description":"instanceJson","required":false,"schema":{"type":"string"},"x-examples":{"application/json":"{\"aeTitle\": \"TITLE\", \"port\": 8104, \"enabled\": true}"}}],"responses":{"200":{"description":"DICOM SCP receiver definition successfully updated.","schema":{"$ref":"#/definitions/DicomSCPInstance"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to create or update this DICOM SCP receiver definition."},"404":{"description":"DICOM SCP receiver definition not found."},"500":{"description":"Unexpected error"}},"deprecated":false},"delete":{"tags":["dicom-scp-api"],"summary":"Deletes the DICOM SCP receiver definition object with the specified ID.","description":"This call will stop the receiver if it's currently running.","operationId":"deleteDicomSCPInstanceUsingDELETE","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"The ID of the DICOM SCP receiver definition to delete.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"DICOM SCP receiver definition successfully deleted."},"204":{"description":"No Content"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to delete this DICOM SCP receiver definition."},"404":{"description":"DICOM SCP receiver definition not found."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/dicomscp/{id}/enabled":{"get":{"tags":["dicom-scp-api"],"summary":"Returns whether the DICOM SCP receiver definition with the specified ID is enabled.","description":"Returns true or false based on whether the specified DICOM SCP receiver definition is enabled or not.","operationId":"getDicomSCPInstanceEnabledUsingGET","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"The ID of the DICOM SCP receiver definition to retrieve the enabled status for.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"DICOM SCP receiver definition enabled status successfully retrieved.","schema":{"type":"boolean"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to view this DICOM SCP receiver definition."},"404":{"description":"DICOM SCP receiver definition not found."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/dicomscp/{id}/enabled/{flag}":{"put":{"tags":["dicom-scp-api"],"summary":"Sets the DICOM SCP receiver definition's enabled state.","description":"Sets the enabled state of the DICOM SCP receiver definition with the specified ID to the value of the flag parameter.","operationId":"enableDicomSCPInstanceUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"flag","in":"path","description":"The value to set for the enabled status.","required":true,"type":"boolean"},{"name":"id","in":"path","description":"ID of the DICOM SCP receiver definition to modify","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"DICOM SCP receiver definition enabled status successfully set.","schema":{"$ref":"#/definitions/DicomSCPInstance"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to enable or disable this DICOM SCP receiver definition."},"404":{"description":"DICOM SCP receiver definition not found."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/direct-archive":{"post":{"tags":["direct-archive-session-api"],"summary":"Get direct archive sessions","operationId":"getPaginatedUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/DirectArchiveSessionPaginatedRequest"}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SessionData"}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/direct-archive/{id}":{"delete":{"tags":["direct-archive-session-api"],"summary":"Delete direct archive session","operationId":"deleteUsingDELETE_3","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK"},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/direct-archive/{project}/{tag}/{name}":{"get":{"tags":["direct-archive-session-api"],"summary":"Get direct archive session","operationId":"getSessionUsingGET","produces":["application/json"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"type":"string"},{"name":"project","in":"path","description":"project","required":true,"type":"string"},{"name":"tag","in":"path","description":"tag","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SessionData"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"post":{"tags":["direct-archive-session-api"],"summary":"Trigger direct archive of session","operationId":"triggerArchiveUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"type":"string"},{"name":"project","in":"path","description":"project","required":true,"type":"string"},{"name":"tag","in":"path","description":"tag","required":true,"type":"string"}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/elementdisplays":{"get":{"tags":["element-display-api"],"summary":"Get all element displays","description":"Returns a list of all database-backed element display configurations.","operationId":"getAllElementDisplaysUsingGET","produces":["application/json"],"responses":{"200":{"description":"Successfully retrieved element displays","schema":{"type":"array","items":{"$ref":"#/definitions/ElementDisplayDB"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal server error"}},"deprecated":false}},"/elementdisplays/{elementName}":{"get":{"tags":["element-display-api"],"summary":"Get an element display by element name","description":"Returns the database-backed element display configuration for the specified element name (xsi:type).","operationId":"getElementDisplayUsingGET","produces":["application/json"],"parameters":[{"name":"elementName","in":"path","description":"The element name (xsi:type) of the element display","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully retrieved element display","schema":{"$ref":"#/definitions/ElementDisplayDB"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Element display not found"},"500":{"description":"Internal server error"}},"deprecated":false},"delete":{"tags":["element-display-api"],"summary":"Delete an element display by element name","description":"Deletes the database-backed element display configuration for the specified element name and removes it from the in-memory DisplayManager.","operationId":"deleteElementDisplayUsingDELETE","produces":["application/json"],"parameters":[{"name":"elementName","in":"path","description":"The element name (xsi:type) of the element display to delete","required":true,"type":"string"}],"responses":{"200":{"description":"Element display deleted successfully","schema":{"type":"string"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Element display not found"},"500":{"description":"Internal server error"}},"deprecated":false}},"/eventHandlers/automationEventClasses":{"get":{"tags":["event-handler-api"],"summary":"Get list of event classes.","description":"Returns a list of classes implementing AutomationEventI.","operationId":"automationEventClassesGetUsingGET","produces":["application/json"],"responses":{"200":{"description":"An array of class names","schema":{"type":"array","items":{"$ref":"#/definitions/EventClassInfo"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/eventHandlers/{triggerId}":{"get":{"tags":["event-handler-api"],"summary":"getEventHandler","operationId":"getEventHandlerUsingGET","produces":["application/json"],"parameters":[{"name":"triggerId","in":"path","description":"triggerId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScriptTrigger"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/event_tracking/{key}":{"get":{"tags":["event-tracking-data-api"],"summary":"getData","operationId":"getDataUsingGET","produces":["application/json"],"parameters":[{"name":"key","in":"path","description":"key","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EventTrackingDataPojo"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/event_tracking/{key}/payload":{"get":{"tags":["event-tracking-data-api"],"summary":"getPayload","operationId":"getPayloadUsingGET","produces":["text/plain"],"parameters":[{"name":"key","in":"path","description":"key","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/events/action":{"get":{"tags":["event-service-rest-api"],"summary":"Get a actions by key in the form of \"ProviderID:ActionID\"","operationId":"getActionUsingGET","produces":["*/*"],"parameters":[{"name":"actionkey","in":"query","description":"actionkey","required":true,"type":"string"},{"name":"project","in":"query","description":"project","required":false,"type":"string"},{"name":"xnattype","in":"query","description":"xnattype","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Action"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/events/actions":{"get":{"tags":["event-service-rest-api"],"summary":"getActions","operationId":"getActionsUsingGET","produces":["*/*"],"parameters":[{"name":"project","in":"query","description":"project","required":false,"type":"string"},{"name":"xnattype","in":"query","description":"xnattype","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Action"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/events/actionsbyevent":{"get":{"tags":["event-service-rest-api"],"summary":"Get actions that can act on a particular Event type","operationId":"getActionsByEventUsingGET","produces":["*/*"],"parameters":[{"name":"event-type","in":"query","description":"event-type","required":true,"type":"string"},{"name":"project","in":"query","description":"project","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Action"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/events/allactions":{"get":{"tags":["event-service-rest-api"],"summary":"getAllActions","operationId":"getAllActionsUsingGET","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Action"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/events/delivered":{"post":{"tags":["event-service-rest-api"],"summary":"Get paginated event history results per request","operationId":"getDeliveredSubscriptionsUsingPOST","consumes":["application/json;charset=UTF-8"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"include-filter-mismatch","in":"query","description":"include-filter-mismatch","required":false,"type":"boolean"},{"name":"load-children","in":"query","description":"load-children","required":false,"type":"boolean","default":true},{"name":"project","in":"query","description":"project","required":false,"type":"string"},{"in":"body","name":"request","description":"request","required":false,"schema":{"$ref":"#/definitions/SubscriptionDeliveryEntityPaginatedRequest"}},{"name":"subscription-id","in":"query","description":"subscription-id","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SubscriptionDelivery"}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/events/delivered/cleanup/":{"post":{"tags":["event-service-rest-api"],"summary":"Cleanup Event Service history by deleting old serialized payload objects. Keep N most recent.","operationId":"deactivateSubscriptionUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"keep-recent","in":"query","description":"keep-recent","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/events/delivered/count":{"get":{"tags":["event-service-rest-api"],"summary":"getDeliveredSubscriptionsCount","operationId":"getDeliveredSubscriptionsCountUsingGET","produces":["*/*"],"parameters":[{"name":"include-filter-mismatch","in":"query","description":"include-filter-mismatch","required":false,"type":"boolean"},{"name":"project","in":"query","description":"project","required":false,"type":"string"},{"name":"subscription-id","in":"query","description":"subscription-id","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"integer","format":"int64"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/events/delivered/summary":{"get":{"tags":["event-service-rest-api"],"summary":"getDeliveredSubscriptionsSummary","operationId":"getDeliveredSubscriptionsSummaryUsingGET","produces":["*/*"],"parameters":[{"name":"project","in":"query","description":"project","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SubscriptionDeliverySummary"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":true}},"/events/delivered/{id}":{"get":{"tags":["event-service-rest-api"],"summary":"getDeliveredSubscriptions","operationId":"getDeliveredSubscriptionsUsingGET","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SubscriptionDelivery"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/events/event":{"get":{"tags":["event-service-rest-api"],"summary":"getEvent","operationId":"getEventUsingGET","produces":["*/*"],"parameters":[{"name":"event-type","in":"query","description":"event-type","required":true,"type":"string"},{"name":"load-details","in":"query","description":"load-details","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SimpleEvent"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/events/event/properties":{"get":{"tags":["event-service-rest-api"],"summary":"Get a event properties for a given Event ID","operationId":"retrieveEventPropertiesUsingGET","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"event-type","in":"query","description":"event-type","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/EventPropertyNode"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/events/events":{"get":{"tags":["event-service-rest-api"],"summary":"getEvents","operationId":"getEventsUsingGET","produces":["*/*"],"parameters":[{"name":"load-details","in":"query","description":"load-details","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SimpleEvent"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/events/prefs":{"get":{"tags":["event-service-rest-api"],"summary":"Get Event Service Preferences","operationId":"getPrefsUsingGET","produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EventServicePrefs"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"put":{"tags":["event-service-rest-api"],"summary":"Update Event Service Preferences","operationId":"updatePrefsUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"prefs","description":"prefs","required":true,"schema":{"$ref":"#/definitions/EventServicePrefs"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/events/subscription":{"post":{"tags":["event-service-rest-api"],"summary":"Create a Subscription","operationId":"createSubscriptionUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"overpopulate-attributes","in":"query","description":"overpopulate-attributes","required":false,"type":"boolean"},{"in":"body","name":"subscription","description":"subscription","required":true,"schema":{"$ref":"#/definitions/SubscriptionCreator"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/events/subscription/filter":{"get":{"tags":["event-service-rest-api"],"summary":"Generate a subscription RegEx filter string from filter node set","operationId":"generateFilterRegExUsingGET","produces":["application/json;charset=UTF-8"],"parameters":[{"in":"body","name":"filterNodes","description":"filterNodes","required":true,"schema":{"type":"object","additionalProperties":{"$ref":"#/definitions/JsonPathFilterNode"}}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/events/subscription/filter/validate":{"post":{"tags":["event-service-rest-api"],"summary":"Validate a JsonPath predicate for use in event service filter.","operationId":"validateFilterJsonPathPredicateUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"jsonPathPredicate","description":"jsonPathPredicate","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Valid JsonPath Predicate."},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"424":{"description":"Invalid JsonPath Predicate."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/events/subscription/{id}":{"get":{"tags":["event-service-rest-api"],"summary":"Get a Subscription by ID","operationId":"retrieveSubscriptionUsingGET","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Subscription"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"put":{"tags":["event-service-rest-api"],"summary":"Update an existing Subscription","operationId":"updateSubscriptionUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"},{"in":"body","name":"update","description":"update","required":true,"schema":{"$ref":"#/definitions/SubscriptionUpdate"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"delete":{"tags":["event-service-rest-api"],"summary":"Deactivate and delete a subscription by ID","operationId":"deleteUsingDELETE_4","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK"},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/events/subscription/{id}/activate":{"post":{"tags":["event-service-rest-api"],"summary":"Activate an existing Subscription","operationId":"activateSubscriptionUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/events/subscription/{id}/deactivate":{"post":{"tags":["event-service-rest-api"],"summary":"deactivate an existing Subscription","operationId":"deactivateSubscriptionUsingPOST_1","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/events/subscriptions":{"get":{"tags":["event-service-rest-api"],"summary":"getAllSubscriptions","operationId":"getAllSubscriptionsUsingGET","produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Subscription"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/experiments/{session}/scan/{scanId}/snapshot":{"get":{"tags":["snapshot-generation-api"],"summary":"Get a single image or montage of full-size images from the scan. Generate the resource if necessary.","operationId":"getSnapshotUsingGET","produces":["image/gif"],"parameters":[{"name":"project","in":"path","description":"Specifies the project that contains the image session","required":false,"type":"string"},{"name":"scanId","in":"path","description":"The scan for which the thumbnail should be generated","required":false,"type":"string"},{"name":"session","in":"path","description":"Specifies the ID or label for the image session (if this is the label, you must also specify the project at least)","required":false,"type":"string"},{"name":"subject","in":"path","description":"Specifies the subject associated with the image session","required":false,"type":"string"},{"name":"view","in":"path","description":"Specifies the grid layout for montage views; must be in the format *numRows*X*numColumns*, e.g. 3X3, 5X2, etc.","required":false,"type":"string"}],"responses":{"200":{"description":"Snapshot located or generated and returned.","schema":{"$ref":"#/definitions/Resource"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The session or scan requested doesn't exist."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/experiments/{session}/scan/{scanId}/snapshot/{view}":{"get":{"tags":["snapshot-generation-api"],"summary":"Get a single image or montage of full-size images from the scan. Generate the resource if necessary.","operationId":"getSnapshotUsingGET_1","produces":["image/gif"],"parameters":[{"name":"project","in":"path","description":"Specifies the project that contains the image session","required":false,"type":"string"},{"name":"scanId","in":"path","description":"The scan for which the thumbnail should be generated","required":false,"type":"string"},{"name":"session","in":"path","description":"Specifies the ID or label for the image session (if this is the label, you must also specify the project at least)","required":false,"type":"string"},{"name":"subject","in":"path","description":"Specifies the subject associated with the image session","required":false,"type":"string"},{"name":"view","in":"path","description":"Specifies the grid layout for montage views; must be in the format *numRows*X*numColumns*, e.g. 3X3, 5X2, etc.","required":false,"type":"string"}],"responses":{"200":{"description":"Snapshot located or generated and returned.","schema":{"$ref":"#/definitions/Resource"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The session or scan requested doesn't exist."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/experiments/{session}/scan/{scanId}/thumbnail":{"get":{"tags":["snapshot-generation-api"],"summary":"Get a single thumbnail or montage of thumbnails. Generate the resource if necessary.","operationId":"getThumbnailUsingGET","produces":["image/gif"],"parameters":[{"name":"project","in":"path","description":"Specifies the project that contains the image session","required":false,"type":"string"},{"name":"scanId","in":"path","description":"The scan for which the thumbnail should be generated","required":false,"type":"string"},{"name":"session","in":"path","description":"Specifies the ID or label for the image session (if this is the label, you must also specify the project at least)","required":false,"type":"string"},{"name":"subject","in":"path","description":"Specifies the subject associated with the image session","required":false,"type":"string"},{"name":"view","in":"path","description":"Specifies the grid layout for montage views; must be in the format *numRows*X*numColumns*, e.g. 3X3, 5X2, etc.","required":false,"type":"string"}],"responses":{"200":{"description":"Thumbnail located or generated and returned.","schema":{"$ref":"#/definitions/Resource"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The session or scan requested doesn't exist."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/experiments/{session}/scan/{scanId}/thumbnail/{view}":{"get":{"tags":["snapshot-generation-api"],"summary":"Get a single thumbnail or montage of thumbnails. Generate the resource if necessary.","operationId":"getThumbnailUsingGET_1","produces":["image/gif"],"parameters":[{"name":"project","in":"path","description":"Specifies the project that contains the image session","required":false,"type":"string"},{"name":"scanId","in":"path","description":"The scan for which the thumbnail should be generated","required":false,"type":"string"},{"name":"session","in":"path","description":"Specifies the ID or label for the image session (if this is the label, you must also specify the project at least)","required":false,"type":"string"},{"name":"subject","in":"path","description":"Specifies the subject associated with the image session","required":false,"type":"string"},{"name":"view","in":"path","description":"Specifies the grid layout for montage views; must be in the format *numRows*X*numColumns*, e.g. 3X3, 5X2, etc.","required":false,"type":"string"}],"responses":{"200":{"description":"Thumbnail located or generated and returned.","schema":{"$ref":"#/definitions/Resource"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The session or scan requested doesn't exist."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/investigators":{"get":{"tags":["investigators-api"],"summary":"Get list of investigators.","description":"The investigators function returns a list of all investigators configured in the XNAT system.","operationId":"getInvestigatorsUsingGET","produces":["application/json"],"responses":{"200":{"description":"Returns a list of all of the currently configured investigators.","schema":{"type":"array","items":{"$ref":"#/definitions/Investigator"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false},"post":{"tags":["investigators-api"],"summary":"Creates a new investigator from the submitted attributes.","description":"Returns the newly created investigator with the submitted attributes.","operationId":"createInvestigatorUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"investigator","description":"investigator","required":true,"schema":{"$ref":"#/definitions/Investigator"}}],"responses":{"200":{"description":"Returns the newly created investigator.","schema":{"$ref":"#/definitions/Investigator"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient privileges to create the submitted investigator."},"404":{"description":"The requested investigator wasn't found."},"500":{"description":"An unexpected or unknown error occurred."}},"deprecated":false}},"/investigators/{investigatorId}":{"get":{"tags":["investigators-api"],"summary":"Gets the requested investigator.","description":"Returns the investigator with the specified ID.","operationId":"getInvestigatorUsingGET","produces":["application/json"],"parameters":[{"name":"investigatorId","in":"path","description":"investigatorId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Returns the requested investigator.","schema":{"$ref":"#/definitions/Investigator"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The requested investigator wasn't found."},"500":{"description":"An unexpected or unknown error occurred."}},"deprecated":false},"put":{"tags":["investigators-api"],"summary":"Updates the requested investigator from the submitted attributes.","description":"Returns the updated investigator.","operationId":"updateInvestigatorUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"investigator","description":"investigator","required":true,"schema":{"$ref":"#/definitions/Investigator"}},{"name":"investigatorId","in":"path","description":"investigatorId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Returns the updated investigator.","schema":{"$ref":"#/definitions/Investigator"}},"201":{"description":"Created"},"304":{"description":"The requested investigator is the same as the submitted investigator."},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient privileges to edit the requested investigator."},"404":{"description":"The requested investigator wasn't found."},"500":{"description":"An unexpected or unknown error occurred."}},"deprecated":false},"delete":{"tags":["investigators-api"],"summary":"Deletes the requested investigator.","description":"Returns true if the requested investigator was successfully deleted. Returns false otherwise.","operationId":"deleteInvestigatorUsingDELETE","produces":["application/json"],"parameters":[{"name":"investigatorId","in":"path","description":"investigatorId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Returns true to indicate the requested investigator was successfully deleted.","schema":{"type":"boolean"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"The user doesn't have permission to delete investigators."},"404":{"description":"The requested investigator wasn't found."},"500":{"description":"An unexpected or unknown error occurred."}},"deprecated":false}},"/legacycustomvariable":{"get":{"tags":["legacy-custom-variable-api"],"summary":"Get List of All Custom Variables","description":"Gets a list of existing legacy custom variables","operationId":"getAllLegacyCustomVariablesUsingGET","produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/legacycustomvariable/migratetoformio/{field_definition_id}":{"post":{"tags":["legacy-custom-variable-api"],"summary":"Migrate legacy custom variable to Dynamic Variable","description":"Generate a forms IO JSON for pre-formsio Custom Variable Definition","operationId":"migrateCustomVariableToDynamicVariableUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"field_definition_id","in":"path","description":"field_definition_id","required":true,"type":"string"},{"name":"trackingId","in":"query","description":"trackingId","required":false,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"string"}},"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Not enabled"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/logs/appenders":{"get":{"tags":["logging-api"],"summary":"Gets a map of the appenders defined in XNAT's logging configurations, along with the loggers for each appender and the current log level for that logger.","operationId":"getAppendersUsingGET","produces":["application/json"],"responses":{"200":{"description":"XNAT appenders, loggers, and levels successfully retrieved.","schema":{"type":"array","items":{"$ref":"#/definitions/AppenderHierarchy"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/logs/appenders/{appenderName}":{"get":{"tags":["logging-api"],"summary":"Gets the specified appender along with the associated loggers and the current log level for each logger.","operationId":"getAppenderUsingGET","produces":["application/json"],"parameters":[{"name":"appenderName","in":"path","description":"appenderName","required":true,"type":"string"}],"responses":{"200":{"description":"XNAT appender, loggers, and levels successfully retrieved.","schema":{"$ref":"#/definitions/AppenderHierarchy"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/logs/configs":{"get":{"tags":["logging-api"],"summary":"Gets a list of all logging configuration files located either in XNAT itself or in plugins.","operationId":"getLoggingConfigurationsUsingGET","produces":["application/json"],"responses":{"200":{"description":"XNAT logging configurations successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/logs/configs/{resourceId}":{"get":{"tags":["logging-api"],"summary":"Gets the requested logging configuration file located either in XNAT itself or in plugins.","operationId":"getLoggingConfigurationUsingGET","produces":["application/xml"],"parameters":[{"name":"resourceId","in":"path","description":"resourceId","required":true,"type":"string"}],"responses":{"200":{"description":"XNAT logging configuration successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/logs/download":{"get":{"tags":["logging-api"],"summary":"Downloads the XNAT log files as a zip archive.","operationId":"downloadLogFilesUsingGET_1","produces":["application/zip"],"responses":{"200":{"description":"XNAT logs successfully downloaded.","schema":{"$ref":"#/definitions/StreamingResponseBody"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"The user is not authorized to access one or more of the specified resources."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"post":{"tags":["logging-api"],"summary":"Downloads the XNAT log files as a zip archive.","description":"This call takes a string map as JSON. PUT and POST are the same operation. Acceptable values in the map include: \"logFileSpec\" is a glob-style  wild card, e.g. '*.log', 'application.*', etc. This defaults to '*'. \"path\" specifies the path to the folder containing the log files you want to access. The default value is the logs folder in your XNAT home directory, but you can specify other paths to which the XNAT application server user has access, e.g. \"/var/log/tomcat\" to retrieve the Tomcat logs. The \"asZip\" parameter indicates whether the log file(s) should be downloaded as a zip. By default, a single file is downloaded as plain text unless asZip is explicitly set to true, while multiple files are always downloaded as a zip. Finally \"includeEmptyFiles\" indicates whether empty files should be included. By default only files that contain data are included.","operationId":"downloadLogFilesUsingPOST","consumes":["application/json"],"produces":["application/zip"],"parameters":[{"name":"asZip","in":"query","description":"asZip","required":false,"type":"boolean","default":false,"allowEmptyValue":false,"x-example":false},{"in":"body","name":"parameters","description":"parameters","required":true,"schema":{"type":"object","additionalProperties":{"type":"string"}}}],"responses":{"200":{"description":"XNAT logs successfully downloaded.","schema":{"$ref":"#/definitions/StreamingResponseBody"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"The user is not authorized to access one or more of the specified resources."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["logging-api"],"summary":"Downloads the XNAT log files as a zip archive.","description":"This call takes a string map as JSON. PUT and POST are the same operation. Acceptable values in the map include: \"logFileSpec\" is a glob-style  wild card, e.g. '*.log', 'application.*', etc. This defaults to '*'. \"path\" specifies the path to the folder containing the log files you want to access. The default value is the logs folder in your XNAT home directory, but you can specify other paths to which the XNAT application server user has access, e.g. \"/var/log/tomcat\" to retrieve the Tomcat logs. The \"asZip\" parameter indicates whether the log file(s) should be downloaded as a zip. By default, a single file is downloaded as plain text unless asZip is explicitly set to true, while multiple files are always downloaded as a zip. Finally \"includeEmptyFiles\" indicates whether empty files should be included. By default only files that contain data are included.","operationId":"downloadLogFilesUsingPUT","consumes":["application/json"],"produces":["application/zip"],"parameters":[{"name":"asZip","in":"query","description":"asZip","required":false,"type":"boolean","default":false,"allowEmptyValue":false,"x-example":false},{"in":"body","name":"parameters","description":"parameters","required":true,"schema":{"type":"object","additionalProperties":{"type":"string"}}}],"responses":{"200":{"description":"XNAT logs successfully downloaded.","schema":{"$ref":"#/definitions/StreamingResponseBody"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"The user is not authorized to access one or more of the specified resources."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/logs/download/{logFileSpec}":{"get":{"tags":["logging-api"],"summary":"Downloads the XNAT log files as a zip archive.","operationId":"downloadLogFilesUsingGET","produces":["application/zip"],"parameters":[{"name":"asZip","in":"query","description":"asZip","required":false,"type":"boolean","default":false},{"name":"logFileSpec","in":"path","description":"logFileSpec","required":true,"type":"string"}],"responses":{"200":{"description":"XNAT logs successfully downloaded.","schema":{"$ref":"#/definitions/StreamingResponseBody"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"The user is not authorized to access one or more of the specified resources."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/logs/elements":{"get":{"tags":["logging-api"],"summary":"Gets a list of the logger and appender elements defined in XNAT's logging configurations.","operationId":"getPrimaryElementsUsingGET","produces":["application/json"],"responses":{"200":{"description":"XNAT logger and appender elements successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/logs/home":{"get":{"tags":["logging-api"],"summary":"Gets the location of the default folder for logs on the system.","operationId":"getLogsFolderUsingGET","produces":["application/json"],"responses":{"200":{"description":"XNAT log folder successfully retrieved.","schema":{"$ref":"#/definitions/Path"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/logs/levels":{"get":{"tags":["logging-api"],"summary":"Gets a map of the loggers defined in the primary logging configuration file in XNAT itself, along with the current log level for that logger.","operationId":"getLoggerLevelsUsingGET","produces":["application/json"],"responses":{"200":{"description":"XNAT loggers and levels successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/logs/levels/{logger}":{"get":{"tags":["logging-api"],"summary":"Gets the current logging level for the logger with the specified name.","operationId":"getLoggerLevelUsingGET","produces":["application/json"],"parameters":[{"name":"logger","in":"path","description":"logger","required":true,"type":"string"}],"responses":{"200":{"description":"XNAT logger logging level successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"No logger with the specified name was found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/logs/loggers/{logger}/{level}":{"put":{"tags":["logging-api"],"summary":"Sets the logging level for the logger with the specified name.","operationId":"setLoggerLevelUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"level","in":"path","description":"level","required":true,"type":"string"},{"name":"logger","in":"path","description":"logger","required":true,"type":"string"}],"responses":{"200":{"description":"XNAT logging level successfully set.","schema":{"type":"string"}},"201":{"description":"Created"},"400":{"description":"Invalid value specified for logging level."},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"No logger with the specified name was found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/logs/paths":{"get":{"tags":["logging-api"],"summary":"Gets a list of the loggers defined in the primary logging configuration file in XNAT itself, along with the location of the logger's output file.","description":"Note that not all loggers necessarily have a log file, e.g. a logger that only routes to a console appender won't have a log file. Those loggers will be omitted from this map. Additionally, some loggers may have multiple appenders, each with its own log file. This method returns the path to the log file for the first file-based appender in each logger's list of appenders.","operationId":"getLoggerPathsUsingGET","produces":["application/json"],"responses":{"200":{"description":"XNAT loggers and paths successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/logs/paths/{logger}":{"get":{"tags":["logging-api"],"summary":"Gets the location of the log file for the logger with the specified name.","description":"Note that not all loggers necessarily have a log file, e.g. a logger that only routes to a console appender won't have a log file. This endpoint will return null for those loggers. Additionally, some loggers may have multiple appenders, each with its own log file. This method returns the path to the log file for the first file-based appender in each logger's list of appenders.","operationId":"getLoggerPathUsingGET","produces":["application/json"],"parameters":[{"name":"logger","in":"path","description":"logger","required":true,"type":"string"}],"responses":{"200":{"description":"XNAT logger logging path successfully retrieved.","schema":{"$ref":"#/definitions/Path"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"No logger with the specified name was found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/logs/reset":{"post":{"tags":["logging-api"],"summary":"Resets and reloads logging configuration from all logging configuration files located either in XNAT itself or in plugins.","operationId":"resetLoggingConfigurationUsingPOST","consumes":["application/json"],"produces":["application/json"],"responses":{"200":{"description":"XNAT logging configurations successfully retrieved.","schema":{"type":"array","items":{"type":"string"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/notifications":{"get":{"tags":["notifications-api"],"summary":"Returns the full map of site configuration properties.","description":"Complex objects may be returned as encapsulated JSON strings.","operationId":"getNotificationsPropertiesUsingGET","produces":["application/json"],"responses":{"200":{"description":"Site configuration properties successfully retrieved.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set site configuration properties."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets a map of notifications properties.","description":"Sets the notifications properties specified in the map.","operationId":"setNotificationsPropertiesUsingPOST","consumes":["application/json","application/x-www-form-urlencoded"],"produces":["*/*"],"parameters":[{"in":"body","name":"properties","description":"The map of notifications properties to be set.","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"Notifications properties successfully set."},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set notifications properties."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/allow/nonusersubscribers":{"get":{"tags":["notifications-api"],"summary":"Returns whether non-users should be able to subscribe to notifications.","description":"This returns whether non-users should be able to subscribe to notifications.","operationId":"getEmailAllowNonuserSubscribersUsingGET","produces":["application/json"],"responses":{"200":{"description":"Whether non-users should be able to subscribe to notifications successfully returned.","schema":{"type":"boolean"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get whether non-users should be able to subscribe to notifications."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/allow/nonusersubscribers/{setting}":{"post":{"tags":["notifications-api"],"summary":"Sets whether non-users should be able to subscribe to notifications.","description":"Sets whether non-users should be able to subscribe to notifications.","operationId":"setEmailAllowNonuserSubscribersUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"setting","in":"path","description":"Whether non-users should be able to subscribe to notifications.","required":true,"type":"boolean"}],"responses":{"200":{"description":"Whether non-users should be able to subscribe to notifications.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set whether non-users should be able to subscribe to notifications."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/approveprojectaccess":{"get":{"tags":["notifications-api"],"summary":"Returns the email message for approving a project access request.","operationId":"getEmailMessageApproveProjectAccessUsingGET","produces":["application/json"],"responses":{"200":{"description":"Project access approval email message successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for project access approval."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message for approving a project access request.","description":"Sets the email message that a new user should receive when they have received approval to access a project. Link should be auto-populated.","operationId":"setEmailMessageApproveProjectAccessUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The email message for project access approval.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Project access approval email message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the project access approval email message."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/batchtransfer":{"get":{"tags":["notifications-api"],"summary":"Returns the email message when a batch data transfer to the archive has been successfully completed.","operationId":"getEmailMessageBatchTransferUsingGET","produces":["application/json"],"responses":{"200":{"description":"Batch transfer completed email message successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for batch transfer completed."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message when a batch data transfer to the archive has been successfully completed.","description":"Link should be auto-populated.","operationId":"setEmailMessageBatchTransferUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The new email message sent out when a batch data transfer to the archive has been successfully completed.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Batch transfer email message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the batch transfer email message."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/dataalertcustom":{"get":{"tags":["notifications-api"],"summary":"Returns the email message sent out by from one user to another to alert them of possibly useful data.","operationId":"getEmailMessageDataAlertCustomUsingGET","produces":["application/json"],"responses":{"200":{"description":"Data alert email message successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for data alerts."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message sent out by from one user to another to alert them of possibly useful data.","operationId":"setEmailMessageDataAlertCustomUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The new email message sent out by from one user to another to alert them of possibly useful data.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Data alert email message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set email message for data alerts."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/denyprojectaccess":{"get":{"tags":["notifications-api"],"summary":"Returns the email message for denying a project access request.","operationId":"getEmailMessageDenyProjectAccessUsingGET","produces":["application/json"],"responses":{"200":{"description":"Project access denial email message successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for project access denial."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message for denying a project access request.","description":"Sets the email message that a new user should receive when they have been denied in their request to access a project. Link should be auto-populated.","operationId":"setEmailMessageDenyProjectAccessUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The email message for project access denial.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Project access denial email message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the project access denial email message."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/diableduseraccountverification":{"get":{"tags":["notifications-api"],"summary":"Returns the email message sent after a user re-enables an account disabled due to inactivity.","operationId":"getEmailMessageDisabledAccountUserVerificationUsingGET","produces":["application/json"],"responses":{"200":{"description":"Disabled account user verification email message successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for disabled account user verification."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message sent after a user re-enables an account disabled due to inactivity.","description":"Link should be auto-populated.","operationId":"setEmailMessageDisabledAccountUserVerificationUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The new email message for disabled account user verification.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Disabled user account verification email message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the email message for disabled account user verification."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/emailadresschangedconfirmation":{"get":{"tags":["notifications-api"],"summary":"Returns the email message sent to both the former and new email address associated with an account to alert the user that the email has successfully been changed.","operationId":"getMessageEmailAddressChangedConfirmationUsingGET","produces":["application/json"],"responses":{"200":{"description":"Confirm account email address changed email message successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for confirmation of an account email address change."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message sent to both the former and new email address associated with an account to alert the user that the email has successfully been changed.","operationId":"setEmailAddressChangedConfirmationUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The new email message sent to both the former and new email address associated with an account to alert the user that the email has successfully been changed.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Confirm account email address changed email message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set email message for confirmation of an account email address change."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/emailchangerequest":{"get":{"tags":["notifications-api"],"summary":"Returns the email message sent to alert a user that someone has requested to change the email for the account associated with that email address.","operationId":"getEmailMessageEmailChangedRequestUsingGET","produces":["application/json"],"responses":{"200":{"description":"Account email change request email message successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for an email address change request."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message sent to both the former and new email address associated with an account to alert the user that the email has successfully been changed.","operationId":"setEmailMessageEmailChangedRequestUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The new email message sent to both the former and new email address associated with an account to alert the user that the email has successfully been changed.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Account email change request email message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set email message for an email address change request."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/emailchangeverification":{"get":{"tags":["notifications-api"],"summary":"Returns the email message sent to a new email address for a user to verify the change made to the account's associated email.","operationId":"getEmailMessageEmailChangeVerificationUsingGET","produces":["application/json"],"responses":{"200":{"description":"Verify new email address email message successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for verification of a new account email address."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message sent to a new email address for a user to verify the change made to the account's associated email.","operationId":"setEmailMessageEmailChangeVerificationUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The new email message sent to a new email address for a user to verify the change made to the account's associated email.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Verify new email address email message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set email message for verification of a new account email address."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/error":{"get":{"tags":["notifications-api"],"summary":"Returns the email message sent when an error occurs.","operationId":"getEmailMessageErrorUsingGET","produces":["application/json"],"responses":{"200":{"description":"Error email message successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for errors occurring within the system."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message sent when an error occurs.","description":"Link should be auto-populated.","operationId":"setEmailMessageErrorUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The new email message to be sent when an error occurs.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Email message sent when an error occurs successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the error email message."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/forgotusername":{"get":{"tags":["notifications-api"],"summary":"Returns the email message for forgot username.","description":"This returns the email message that people should receive when they click that they forgot their username.","operationId":"getEmailMessageForgotUsernameRequestUsingGET","produces":["application/json"],"responses":{"200":{"description":"Email message for forgot username successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for forgot username."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message for forgot username.","description":"Sets the email message that people should receive when they click that they forgot their username.","operationId":"setEmailMessageForgotUsernameRequestUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The email message for forgot username.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Forgot username email message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the forgot username email message."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/help":{"get":{"tags":["notifications-api"],"summary":"Returns the email message for contacting help.","description":"This returns the email message that people should receive when contacting help.","operationId":"getHelpContactInfoUsingGET","produces":["application/json"],"responses":{"200":{"description":"Email message for contacting help successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for contacting help."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message for contacting help.","description":"Sets the email message that people should receive when contacting help.","operationId":"setHelpContactInfoUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The email message for contacting help.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Help email message successfully set."},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the help email message."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/inviteprojectacess":{"get":{"tags":["notifications-api"],"summary":"Returns the email message for inviting a new user to the project by email address.","operationId":"getEmailMessageProjectAccessInviteUsingGET","produces":["application/json"],"responses":{"200":{"description":"Project access invite email message successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for project access invite."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message for inviting a new user to the project by email address.","description":"Sets the email message that a new user should receive when they have been invited to a new project by email address. Link should be auto-populated.","operationId":"setEmailMessageProjectAccessInviteUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The email message for project access invite.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Project access invite email message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the project access invite email message."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/newusernotification":{"get":{"tags":["notifications-api"],"summary":"Returns the email message sent to subscribers when a new user has been created.","operationId":"getEmailMessageNewUserNotificationUsingGET","produces":["application/json"],"responses":{"200":{"description":"New user created email message successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for new user creation."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message sent to subscribers when a new user has been created.","description":"Link should be auto-populated.","operationId":"setEmailMessageNewUserNotificationUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The new email message to be sent to subscribers when new users are created.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Email message sent to subscribers upon new user creation successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the new user notification email message."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/newuserrequest":{"get":{"tags":["notifications-api"],"summary":"Returns the email message sent to subscribers when a new user account has been created but auto-enable has been turned off.","operationId":"getEmailMessageNewUserRequestUsingGET","produces":["application/json"],"responses":{"200":{"description":"New user requested email message successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for new user requests."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message sent to subscribers when a new user account has been created but auto-enable has been turned off.","description":"Link should be auto-populated.","operationId":"setEmailMessageNewUserRequestUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The new email message to be sent to subscribers when a new user account has been created but auto-enable has been turned off.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Email message sent to subscribers upon new user request successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the new user request email message."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/newuserverification":{"get":{"tags":["notifications-api"],"summary":"Returns the email message for new user verification.","operationId":"getEmailMessageNewUserVerificationUsingGET","produces":["application/json"],"responses":{"200":{"description":"Email message for new user verification successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for new user verification."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message for new user verification.","description":"Sets the email message that people should receive when are requested to verify their email address for a new account. Link should be auto-populated.","operationId":"setEmailMessageNewUserVerificationUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The email message for user registration.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"User verification email message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the user verification email message."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/passwordreset":{"get":{"tags":["notifications-api"],"summary":"Returns the email message for password reset.","description":"This returns the email message that people should receive when they click to reset their password.  Link for password reset is auto-populated.","operationId":"getEmailMessageForgotPasswordResetUsingGET","produces":["application/json"],"responses":{"200":{"description":"Email message for password reset successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for password reset."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message for password reset.","description":"Sets the email message that people should receive when they click to reset their password.  Link for password reset is auto-populated.","operationId":"setEmailMessageForgotPasswordResetUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The email message for password reset.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Password reset message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the password reset message."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/pipelinefailure":{"get":{"tags":["notifications-api"],"summary":"Returns the email message sent out when an experiment pipeline fails before completion due to error.","operationId":"getEmailMessagePipelineFailureUsingGET","produces":["application/json"],"responses":{"200":{"description":"Pipeline failure email message successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for pipeline failure."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message sent out when an experiment pipeline fails before completion due to error.","description":"Link should be auto-populated.","operationId":"setEmailMessagePipelineFailureUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The new email message sent out when an experiment pipeline fails before completion due to error.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Pipeline failure email message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the pipeline failure email message."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/pipelinesuccessautorun":{"get":{"tags":["notifications-api"],"summary":"Returns the email message sent out when an automated pipeline is run successfully and a session is archived in the system.","operationId":"getEmailMessagePipelineSuccessAutorunUsingGET","produces":["application/json"],"responses":{"200":{"description":"Pipeline autorun success email message successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for pipeline autorun success."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message sent out when an automated pipeline is run successfully and a session is archived in the system.","description":"Link should be auto-populated.","operationId":"setEmailMessagePipelineSuccessAutorunUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The new email message sent out when an automated pipeline is run successfully and a session is archived in the system.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Pipeline autorun success email message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the pipeline autorun success email message."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/pipelinesuccessdefault":{"get":{"tags":["notifications-api"],"summary":"Returns the email message sent out when an experiment pipeline has completed successfully without errors.","operationId":"getEmailMessagePipelineSuccessDefaultUsingGET","produces":["application/json"],"responses":{"200":{"description":"Pipeline success email message successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for experiment pipeline success."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message sent out when an experiment pipeline has completed successfully without errors.","description":"Link should be auto-populated.","operationId":"setEmailMessagePipelineSuccessDefaultUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The new email message to be sent when an experiment pipeline has completed successfully without errors.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Email message sent upon pipeline success successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the pipeline success email message."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/projectaccessrequest":{"get":{"tags":["notifications-api"],"summary":"Returns the email message for a user project access request.","operationId":"getEmailMessageProjectAccessRequestUsingGET","produces":["application/json"],"responses":{"200":{"description":"Email message for project access request successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for project access request."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message for a user project access request.","description":"Sets the email message that owners/members/etc. should receive when a user requests access to a project. Link should be auto-populated.","operationId":"setEmailMessageProjectAccessRequestUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The email message for project access request.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Project access request email message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the project access request email message."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/registration":{"get":{"tags":["notifications-api"],"summary":"Returns the email message for user registration.","description":"This returns the email message that people should receive when they register. Link for email validation is auto-populated.","operationId":"getEmailMessageUserRegistrationUsingGET","produces":["application/json"],"responses":{"200":{"description":"Email message for user registration successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for user registration."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message for user registration.","description":"Sets the email message that people should receive when they register. Link for email validation is auto-populated.","operationId":"setEmailMessageUserRegistrationUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The email message for user registration.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"User registration email message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the user registration email message."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/resetemailmessage":{"post":{"tags":["notifications-api"],"summary":"Resets the email message for the specified api call to its original value.","operationId":"resetEmailMessageUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"apiToReset","in":"query","description":"The API call corresponding to the email which should be reset.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Email message successfully reset.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to reset email message."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/systempatherror":{"get":{"tags":["notifications-api"],"summary":"Returns the email message sent when XNAT is unable to find the filesystem (e.g,, archive, build, prearchive directories).","operationId":"getEmailMessageSystemPathErrorUsingGET","produces":["application/json"],"responses":{"200":{"description":"System path error email message successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for system path errors."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message sent when XNAT is unable to find the filesystem (e.g,, archive, build, prearchive directories).","operationId":"setEmailMessageSystemPathErrorUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The new email message sent when XNAT is unable to find the filesystem (e.g,, archive, build, prearchive directories).","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"System path error email message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set email message for system path errors."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/unauthorizeddataattempt":{"get":{"tags":["notifications-api"],"summary":"Returns the email message sent when one of several types of unauthorized data or login access attempts are recognized by the system.","operationId":"getEmailMessageUnauthorizedDataAttemptUsingGET","produces":["application/json"],"responses":{"200":{"description":"Unauthorized data attempt email message successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for unauthorized data attempt."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message sent when one of several types of unauthorized data or login access attempts are recognized by the system.","description":"Individual type of access attempt should automatically be populated based on the situation.","operationId":"setEmailMessageUnauthorizedDataAttemptUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The new email message sent when one of several types of unauthorized data or login access attempts are recognized by the system.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Unauthorized data attempt message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the unauthorized data attempt email message."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/uploadbyreference":{"get":{"tags":["notifications-api"],"summary":"Returns the email message sent when a user has uploaded a file or files to the system by reference.","operationId":"getEmailMessageUploadByReferenceUsingGET","produces":["application/json"],"responses":{"200":{"description":"Upload by reference email message successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for upload by reference notification."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message sent when a user has uploaded a file or files to the system by reference.","operationId":"setEmailMessageUploadByReferenceUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The new email message sent when a user has uploaded a file or files to the system by reference.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Upload by reference email message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set email message for upload by reference notification."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/messages/uploadbyreferencefailure":{"get":{"tags":["notifications-api"],"summary":"Returns the email message sent when a user has attempted to upload a file or files to the system by reference but the process failed.","operationId":"getEmailMessageUploadByReferenceFailureUsingGET","produces":["application/json"],"responses":{"200":{"description":"Upload by reference failure email message successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for upload by reference failure notification."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email message sent when a user has attempted to upload a file or files to the system by reference but the process failed.","operationId":"setEmailMessageUploadByReferenceFailureUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"message","in":"query","description":"The new email message sent when a user has attempted to upload a file or files to the system by reference but the process failed.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Upload by reference failure email message successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set email message for upload by reference failure notification."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/notify/par":{"get":{"tags":["notifications-api"],"summary":"Returns whether admins should be notified of project access requests.","description":"This returns whether admins should be notified of project access requests.","operationId":"getNotifyAdminProjectAccessRequestUsingGET","produces":["application/json"],"responses":{"200":{"description":"Email message for forgot username successfully returned.","schema":{"type":"boolean"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for forgot username."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets whether admins should be notified of project access requests.","description":"Sets whether admins should be notified of project access requests.","operationId":"setNotifyAdminProjectAccessRequestUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"notify","in":"query","description":"Whether admins should be notified of project access requests successfully set.","required":true,"type":"boolean","allowEmptyValue":false}],"responses":{"200":{"description":"Whether admins should be notified of project access requests successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set whether admins should be notified of project access requests."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/notify/pipeline":{"get":{"tags":["notifications-api"],"summary":"Returns whether admins should be notified of pipeline processing submit.","description":"This returns whether admins should be notified of pipeline processing submit.","operationId":"getNotifyAdminPipelineEmailsUsingGET","produces":["application/json"],"responses":{"200":{"description":"Email message for user registration successfully returned.","schema":{"type":"boolean"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for user registration."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets whether admins should be notified of pipeline processing submit.","description":"Sets whether admins should be notified of pipeline processing submit.","operationId":"setNotifyAdminPipelineEmailsUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"notify","in":"query","description":"Whether admins should be notified of pipeline processing submit successfully set.","required":true,"type":"boolean","allowEmptyValue":false}],"responses":{"200":{"description":"Whether admins should be notified of pipeline processing submit successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set whether admins should be notified of pipeline processing submit."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/notify/registration":{"get":{"tags":["notifications-api"],"summary":"Returns whether admins should be notified of user registration.","description":"This returns whether admins should be notified of user registration.","operationId":"getNotifyAdminUserRegistrationUsingGET","produces":["application/json"],"responses":{"200":{"description":"Email message for contacting help successfully returned.","schema":{"type":"boolean"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for contacting help."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets whether admins should be notified of user registration.","description":"Sets whether admins should be notified of user registration.","operationId":"setNotifyAdminUserRegistrationUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"notify","in":"query","description":"Whether admins should be notified of user registration successfully set.","required":true,"type":"boolean","allowEmptyValue":false}],"responses":{"200":{"description":"Whether admins should be notified of user registration successfully set."},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set whether admins should be notified of user registration."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/notify/transfer":{"get":{"tags":["notifications-api"],"summary":"Returns whether admins should be notified of session transfer.","description":"This returns whether admins should be notified of session transfer.","operationId":"getNotifyAdminSessionTransferUsingGET","produces":["application/json"],"responses":{"200":{"description":"Email message for password reset successfully returned.","schema":{"type":"boolean"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get email message for password reset."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets whether admins should be notified of session transfer.","description":"Sets whether admins should be notified of session transfer by user.","operationId":"setNotifyAdminSessionTransferUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"notify","in":"query","description":"Whether admins should be notified of session transfer successfully set.","required":true,"type":"boolean","allowEmptyValue":false}],"responses":{"200":{"description":"Whether admins should be notified of session transfer successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set whether admins should be notified of session transfer."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/smtp":{"get":{"tags":["notifications-api"],"summary":"Returns the full SMTP server configuration.","description":"Returns the configuration as a map of the standard Java mail sender properties–host, port, protocol, username, and password–along with any extended properties required for the configuration, e.g. configuring SSL- or TLS-secured SMTP services.","operationId":"getSmtpServerPropertiesUsingGET","produces":["application/json"],"responses":{"200":{"description":"SMTP service configuration properties successfully retrieved.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set site configuration properties."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the mail service properties. This return the SMTP server configuration as it exists after being set.","description":"Sets the mail service host, port, username, password, and protocol. You can set extra properties on the mail sender (e.g. for configuring SSL or TLS transport) by specifying the property name and value. Any parameters submitted that are not one of the standard mail sender attributes is set as a mail sender property. You can remove existing properties by setting the property with an empty value. This will override any existing configuration. You can change the values of properties by calling the API method for that specific property or by calling the PUT version of this method.","operationId":"setAllMailPropertiesUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"hostname","in":"query","description":"The value to set for the email host.","required":false,"type":"string","default":"NotSet","allowEmptyValue":false},{"name":"password","in":"query","description":"The value to set for the email password.","required":false,"type":"string","default":"NotSet","allowEmptyValue":false},{"name":"port","in":"query","description":"The value to set for the email port.","required":false,"type":"integer","default":-1,"format":"int32","allowEmptyValue":false},{"name":"properties","in":"query","description":"Values to set for extra mail properties. An empty value indicates that an existing property should be removed.","required":false,"items":{"type":"object","additionalProperties":{"type":"string"}},"allowEmptyValue":false},{"name":"protocol","in":"query","description":"The value to set for the email protocol.","required":false,"type":"string","default":"NotSet","allowEmptyValue":false},{"name":"username","in":"query","description":"The value to set for the email username.","required":false,"type":"string","default":"NotSet","allowEmptyValue":false}],"responses":{"200":{"description":"Mail service properties successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the mail service properties."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"put":{"tags":["notifications-api"],"summary":"Sets the submitted mail service properties. This returns the SMTP server configuration as it exists after being set.","description":"Sets the mail service host, port, username, password, and protocol. You can set extra properties on the mail sender (e.g. for configuring SSL or TLS transport) by specifying the property name and value. Any parameters submitted that are not one of the standard mail sender attributes is set as a mail sender property. You can remove existing properties by setting the property with an empty value. This will modify the existing server configuration. You can completely replace the configuration by calling the POST version of this method.","operationId":"setSubmittedMailPropertiesUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"hostname","in":"query","description":"The value to set for the email host.","required":false,"type":"string","default":"NotSet","allowEmptyValue":false},{"name":"password","in":"query","description":"The value to set for the email password.","required":false,"type":"string","default":"NotSet","allowEmptyValue":false},{"name":"port","in":"query","description":"The value to set for the email port.","required":false,"type":"integer","default":-1,"format":"int32","allowEmptyValue":false},{"name":"properties","in":"query","description":"Values to set for extra mail properties. An empty value indicates that an existing property should be removed.","required":false,"items":{"type":"object","additionalProperties":{"type":"string"}},"allowEmptyValue":false},{"name":"protocol","in":"query","description":"The value to set for the email protocol.","required":false,"type":"string","default":"NotSet","allowEmptyValue":false},{"name":"username","in":"query","description":"The value to set for the email username.","required":false,"type":"string","default":"NotSet","allowEmptyValue":false}],"responses":{"200":{"description":"Mail service properties successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the mail service properties."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/smtp/host/{host}":{"put":{"tags":["notifications-api"],"summary":"Sets the mail service host.","description":"Sets the mail service host.","operationId":"setHostPropertyUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"host","in":"path","description":"The value to set for the email host.","required":true,"type":"string"}],"responses":{"200":{"description":"Mail service host successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the mail service host."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/smtp/password/{password}":{"put":{"tags":["notifications-api"],"summary":"Sets the mail service password.","description":"Sets the mail service password.","operationId":"setPasswordPropertyUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"password","in":"path","description":"The value to set for the email password.","required":true,"type":"string"}],"responses":{"200":{"description":"Mail service password successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the mail service password."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/smtp/port/{port}":{"put":{"tags":["notifications-api"],"summary":"Sets the mail service port.","description":"Sets the mail service port.","operationId":"setPortPropertyUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"port","in":"path","description":"The value to set for the email port.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Mail service port successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the mail service port."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/smtp/property/{property}":{"get":{"tags":["notifications-api"],"summary":"Gets the value for a specified Java mail property.","description":"The value is always returned as a string.","operationId":"getExtendedPropertyUsingGET","produces":["application/json"],"parameters":[{"name":"property","in":"path","description":"The mail property to be retrieved.","required":true,"type":"string"}],"responses":{"200":{"description":"Property found and returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the mail service properties."},"404":{"description":"Specified key not found in the mail service properties."},"500":{"description":"Unexpected error"}},"deprecated":false},"put":{"tags":["notifications-api"],"summary":"Sets a Java mail property with the submitted name and value.","description":"Setting a property to an existing value will overwrite the existing value. The value returned by this function contains the previous value (if any).","operationId":"setExtendedPropertyUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"property","in":"path","description":"The name of the extended mail property to set.","required":true,"type":"string"},{"in":"body","name":"value","description":"The value to set for the extended mail property.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Property found and returned.","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the mail service properties."},"404":{"description":"Specified key not found in the mail service properties."},"500":{"description":"Unexpected error"}},"deprecated":false},"delete":{"tags":["notifications-api"],"summary":"Removes the value for a specified Java mail property.","description":"This completely removes the specified mail property. The value returned by this function contains the previous value (if any).","operationId":"removeExtendedPropertyUsingDELETE","produces":["application/json"],"parameters":[{"name":"property","in":"path","description":"The mail property to be removed.","required":true,"type":"string"}],"responses":{"200":{"description":"Property found and returned.","schema":{"type":"string"}},"204":{"description":"No Content"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the mail service properties."},"404":{"description":"Specified key not found in the mail service properties."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/smtp/property/{property}/{value}":{"put":{"tags":["notifications-api"],"summary":"Sets a Java mail property with the submitted name and value.","description":"Setting a property to an existing value will overwrite the existing value. The value returned by this function contains the previous value (if any).","operationId":"setExtendedPropertyFromPathUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"property","in":"path","description":"The name of the extended mail property to set.","required":true,"type":"string"},{"name":"value","in":"path","description":"The value to set for the extended mail property.","required":true,"type":"string"}],"responses":{"200":{"description":"Mail service password successfully set.","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the mail service password."},"404":{"description":"Specified key not found in the mail service properties."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/smtp/protocol/{protocol}":{"put":{"tags":["notifications-api"],"summary":"Sets the mail service protocol.","description":"Sets the mail service protocol.","operationId":"setProtocolPropertyUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"protocol","in":"path","description":"The value to set for the email protocol.","required":true,"type":"string"}],"responses":{"200":{"description":"Mail service protocol successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the mail service protocol."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/smtp/username/{username}":{"put":{"tags":["notifications-api"],"summary":"Sets the mail service username.","description":"Sets the mail service username.","operationId":"setUsernamePropertyUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"username","in":"path","description":"The value to set for the email username.","required":true,"type":"string"}],"responses":{"200":{"description":"Mail service username successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the mail service username."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/subscribers/error":{"get":{"tags":["notifications-api"],"summary":"Returns list of email addresses subscribed to error notifications.","description":"This returns a list of all the email addresses that are subscribed to receive error notifications.","operationId":"getErrorSubscribersUsingGET","produces":["application/json"],"responses":{"200":{"description":"Error notification subscribers successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get subscribers for email notifications."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email addresses for error notifications.","description":"Sets the email addresses that should be subscribed to error notifications.","operationId":"setErrorSubscribersUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"subscribers","in":"query","description":"The values to set for email addresses for error notifications.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Error subscribers successfully set."},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the error subscribers."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/subscribers/issue":{"get":{"tags":["notifications-api"],"summary":"Returns list of email addresses subscribed to issue notifications.","description":"This returns a list of all the email addresses that are subscribed to receive issue notifications.","operationId":"getIssueSubscribersUsingGET","produces":["application/json"],"responses":{"200":{"description":"Issue notification subscribers successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get subscribers for email notifications."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email addresses for issue notifications.","description":"Sets the email addresses that should be subscribed to issue notifications.","operationId":"setIssueSubscribersUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"subscribers","in":"query","description":"The values to set for email addresses for issue notifications.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Issue subscribers successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the issue subscribers."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/subscribers/newuser":{"get":{"tags":["notifications-api"],"summary":"Returns list of email addresses subscribed to new user notifications.","description":"This returns a list of all the email addresses that are subscribed to receive new user notifications.","operationId":"getNewUserSubscribersUsingGET","produces":["application/json"],"responses":{"200":{"description":"New user notification subscribers successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get subscribers for email notifications."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email addresses for new user notifications.","description":"Sets the email addresses that should be subscribed to new user notifications.","operationId":"setNewUserSubscribersUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"subscribers","in":"query","description":"The values to set for email addresses for new user notifications.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"New user subscribers successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the new user subscribers."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/notifications/subscribers/update":{"get":{"tags":["notifications-api"],"summary":"Returns list of email addresses subscribed to update notifications.","description":"This returns a list of all the email addresses that are subscribed to receive update notifications.","operationId":"getUpdateSubscribersUsingGET","produces":["application/json"],"responses":{"200":{"description":"Update notification subscribers successfully returned.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get subscribers for email notifications."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["notifications-api"],"summary":"Sets the email addresses for update notifications.","description":"Sets the email addresses that should be subscribed to update notifications.","operationId":"setUpdateSubscribersUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"subscribers","in":"query","description":"The values to set for email addresses for update notifications.","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Update subscribers successfully set.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set the update subscribers."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/pluginOpenUrls/settings":{"get":{"tags":["plugin-open-urls-configuration-api"],"summary":"Gets the plugin open URL configuration.","description":"Returns plugin open URL configuration for this installation.","operationId":"getPluginOpenUrlsConfigurationUsingGET","produces":["application/json"],"responses":{"200":{"description":"An array of properties","schema":{"type":"object","additionalProperties":{"type":"object"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["plugin-open-urls-configuration-api"],"summary":"Sets the plugin open URL configuration.","description":"Sets plugin open URL configuration for this installation.","operationId":"setPluginOpenUrlsConfigurationUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"config","description":"config","required":true,"schema":{"type":"object","additionalProperties":{"type":"boolean"}}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/plugins":{"get":{"tags":["xnat-plugin-api"],"summary":"Returns a list of all of the installed and active XNAT plugins with their properties.","description":"The maps returned from this call include all of the properties specified in the plugin's property file.","operationId":"getAllPluginsUsingGET","produces":["application/json"],"responses":{"200":{"description":"XNAT plugin properties successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/plugins/{plugin}":{"get":{"tags":["xnat-plugin-api"],"summary":"Returns the indicated XNAT plugin with its properties.","description":"The map returned from this call include all of the properties specified in the plugin's property file.","operationId":"getRequestedPluginUsingGET","produces":["application/json"],"parameters":[{"name":"plugin","in":"path","description":"plugin","required":true,"type":"string"}],"responses":{"200":{"description":"XNAT plugin properties successfully retrieved.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource wasn't found."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/prefs":{"get":{"tags":["preferences-api"],"summary":"Returns the full map of preferences and values for this XNAT application.","operationId":"getAllPreferenceSettingsUsingGET","produces":["application/json"],"responses":{"200":{"description":"Preference settings successfully retrieved.","schema":{"type":"object","additionalProperties":{"type":"object"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Insufficient privileges to retrieve the requested setting."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/prefs/ini":{"get":{"tags":["preferences-api"],"summary":"Returns the full map of preferences and values for this XNAT application.","operationId":"getPreferenceSettingsInisUsingGET","produces":["text/plain"],"responses":{"200":{"description":"Preference settings successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Insufficient privileges to retrieve the requested setting."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/prefs/ini/{toolId}":{"get":{"tags":["preferences-api"],"summary":"Returns the full map of preferences and values for this XNAT application.","operationId":"getPreferenceSettingsIniUsingGET","produces":["text/plain"],"parameters":[{"name":"toolId","in":"path","description":"toolId","required":true,"type":"string"}],"responses":{"200":{"description":"Preference settings successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Insufficient privileges to retrieve the requested setting."},"404":{"description":"Tool ID not found in the system."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/prefs/props/{toolId}":{"get":{"tags":["preferences-api"],"summary":"Returns the full map of preferences and values for this XNAT application.","operationId":"getToolPreferencesUsingGET","produces":["text/plain"],"parameters":[{"name":"toolId","in":"path","description":"toolId","required":true,"type":"string"}],"responses":{"200":{"description":"Preference settings successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Insufficient privileges to retrieve the requested setting."},"404":{"description":"Tool ID not found in the system."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/prefs/props/{toolId}/{preference}":{"get":{"tags":["preferences-api"],"summary":"Returns the full map of preferences and values for this XNAT application.","operationId":"getToolPreferenceUsingGET","produces":["text/plain"],"parameters":[{"name":"preference","in":"path","description":"preference","required":true,"type":"string"},{"name":"toolId","in":"path","description":"toolId","required":true,"type":"string"}],"responses":{"200":{"description":"Preference settings successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Insufficient privileges to retrieve the requested setting."},"404":{"description":"Tool ID not found in the system."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["preferences-api"],"summary":"Sets the value for the indicated preference associated with the specified tool ID.","operationId":"setToolPreferenceUsingPUT","consumes":["application/json"],"produces":["text/plain"],"parameters":[{"name":"preference","in":"path","description":"preference","required":true,"type":"string"},{"name":"toolId","in":"path","description":"toolId","required":true,"type":"string"},{"in":"body","name":"value","description":"value","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Preference value successfully stored."},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Insufficient privileges to retrieve the requested setting."},"404":{"description":"Tool ID not found in the system."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/processors/classes":{"get":{"tags":["archive-processor-instance-api"],"summary":"Get list of processor classes.","description":"The processor classes function returns a list of all processor classes in the XNAT system.","operationId":"getProcessorClassesUsingGET","produces":["application/json"],"responses":{"200":{"description":"Returns a list of all of the processor classes.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/processors/site/canRemap/receiver/{aeAndPort}":{"get":{"tags":["archive-processor-instance-api"],"summary":"Returns whether the provided AE and port are able to remap the data.","operationId":"receiverCanRemapUsingGET","produces":["application/json"],"parameters":[{"name":"aeAndPort","in":"path","description":"aeAndPort","required":true,"type":"string"}],"responses":{"200":{"description":"Remapping successfully checked.","schema":{"type":"boolean"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected or unknown error occurred."}},"deprecated":false}},"/processors/site/create":{"post":{"tags":["archive-processor-instance-api"],"summary":"Creates a new site processor instance from the submitted attributes.","description":"Returns the newly created site processor instance with the submitted attributes.","operationId":"createSiteProcessorUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"processor","description":"processor","required":true,"schema":{"$ref":"#/definitions/ArchiveProcessorInstance"}}],"responses":{"200":{"description":"Returns the newly created site processor instance.","schema":{"$ref":"#/definitions/ArchiveProcessorInstance"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient privileges to create the submitted site processor instance."},"404":{"description":"The requested site processor instance wasn't found."},"500":{"description":"An unexpected or unknown error occurred."}},"deprecated":false}},"/processors/site/enabled":{"get":{"tags":["archive-processor-instance-api"],"summary":"Get list of enabled site processor instances.","description":"The enabled site processors function returns a list of all enabled site processor instances configured in the XNAT system.","operationId":"getAllEnabledSiteProcessorsUsingGET","produces":["application/json"],"responses":{"200":{"description":"Returns a list of all of the currently enabled site processor instances.","schema":{"type":"array","items":{"$ref":"#/definitions/ArchiveProcessorInstance"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/processors/site/enabled/receiver/{aeAndPort}":{"get":{"tags":["archive-processor-instance-api"],"summary":"Get list of enabled site processor instances for specified SCP receiver.","description":"The enabled site processors function returns a list of all enabled site processor instances configured in the XNAT system for this receiver. Receiver should be specified like aeTitle:port.","operationId":"getAllEnabledSiteProcessorsForAeUsingGET","produces":["application/json"],"parameters":[{"name":"aeAndPort","in":"path","description":"aeAndPort","required":true,"type":"string"}],"responses":{"200":{"description":"Returns a list of all of the currently enabled site processor instances for this receiver.","schema":{"type":"array","items":{"$ref":"#/definitions/ArchiveProcessorInstance"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/processors/site/enabled/summary":{"get":{"tags":["archive-processor-instance-api"],"summary":"Get basic information about all enabled site processor instances.","description":"The enabled site processors summary information function returns a list of basic information for all enabled site processor instances configured in the XNAT system.","operationId":"getAllEnabledSiteProcessorsSummaryInformationUsingGET","produces":["application/json"],"responses":{"200":{"description":"Returns a list of basic information for all of the currently enabled site processor instances.","schema":{"type":"array","items":{"$ref":"#/definitions/ArchiveProcessorInstanceSummary"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/processors/site/id/{instanceId}":{"get":{"tags":["archive-processor-instance-api"],"summary":"Get the requested site processor instance by ID.","description":"Returns the requested site processor instance.","operationId":"getSiteProcessorUsingGET","produces":["application/json"],"parameters":[{"name":"instanceId","in":"path","description":"instanceId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Returns the requested site processor instance.","schema":{"$ref":"#/definitions/ArchiveProcessorInstance"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The requested site processor instance wasn't found."},"500":{"description":"An unexpected or unknown error occurred."}},"deprecated":false},"put":{"tags":["archive-processor-instance-api"],"summary":"Updates the requested site processor instance from the submitted attributes.","description":"Returns the updated site processor instance.","operationId":"updateSiteProcessorUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"instanceId","in":"path","description":"instanceId","required":true,"type":"integer","format":"int64"},{"in":"body","name":"processor","description":"processor","required":true,"schema":{"$ref":"#/definitions/ArchiveProcessorInstance"}}],"responses":{"200":{"description":"Returns the updated site processor instance.","schema":{"$ref":"#/definitions/ArchiveProcessorInstance"}},"201":{"description":"Created"},"304":{"description":"The requested site processor is the same as the submitted site processor instance."},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient privileges to edit the requested site processor instance."},"404":{"description":"The requested site processor instance wasn't found."},"500":{"description":"An unexpected or unknown error occurred."}},"deprecated":false},"delete":{"tags":["archive-processor-instance-api"],"summary":"Deletes the requested site processor instance from the submitted attributes.","operationId":"deleteSiteProcessorUsingDELETE","produces":["application/json"],"parameters":[{"name":"instanceId","in":"path","description":"instanceId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Site processor instance was successfully removed.","schema":{"type":"boolean"}},"204":{"description":"No Content"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Insufficient privileges to edit the requested site processor instance."},"404":{"description":"The requested site processor instance wasn't found."},"500":{"description":"An unexpected or unknown error occurred."}},"deprecated":false}},"/processors/site/list":{"get":{"tags":["archive-processor-instance-api"],"summary":"Get list of site processor instances.","description":"The site processors function returns a list of all site processor instances configured in the XNAT system.","operationId":"getAllSiteProcessorsUsingGET","produces":["application/json"],"responses":{"200":{"description":"Returns a list of all of the currently configured site processor instances.","schema":{"type":"array","items":{"$ref":"#/definitions/ArchiveProcessorInstance"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/projects/{projectId}/eventHandlers/automationEventClasses":{"get":{"tags":["event-handler-api"],"summary":"Get list of event classes.","description":"Returns a list of classes implementing AutomationEventI.","operationId":"automationEventClassesGetByProjectUsingGET","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"}],"responses":{"200":{"description":"An array of class names","schema":{"type":"array","items":{"$ref":"#/definitions/EventClassInfo"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/projects/{project}/events/actions":{"get":{"tags":["event-service-rest-api"],"summary":"getProjectActions","operationId":"getProjectActionsUsingGET","produces":["*/*"],"parameters":[{"name":"project","in":"path","description":"project","required":true,"type":"string"},{"name":"xnattype","in":"query","description":"xnattype","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Action"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/projects/{project}/events/actionsbyevent":{"get":{"tags":["event-service-rest-api"],"summary":"Get actions that can act on a particular Event type","operationId":"getProjectActionsByEventUsingGET","produces":["*/*"],"parameters":[{"name":"event-type","in":"query","description":"event-type","required":true,"type":"string"},{"name":"project","in":"path","description":"project","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Action"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/projects/{project}/events/delivered":{"post":{"tags":["event-service-rest-api"],"summary":"getDeliveredProjectSubscriptions","operationId":"getDeliveredProjectSubscriptionsUsingPOST","consumes":["application/json;charset=UTF-8"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"include-filter-mismatch","in":"query","description":"include-filter-mismatch","required":false,"type":"boolean"},{"name":"load-children","in":"query","description":"load-children","required":false,"type":"boolean","default":true},{"name":"project","in":"path","description":"project","required":true,"type":"string"},{"in":"body","name":"request","description":"request","required":false,"schema":{"$ref":"#/definitions/SubscriptionDeliveryEntityPaginatedRequest"}},{"name":"subscription-id","in":"query","description":"subscription-id","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SubscriptionDelivery"}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/projects/{project}/events/delivered/count":{"get":{"tags":["event-service-rest-api"],"summary":"getDeliveredProjectSubscriptionsCount","operationId":"getDeliveredProjectSubscriptionsCountUsingGET","produces":["*/*"],"parameters":[{"name":"include-filter-mismatch","in":"query","description":"include-filter-mismatch","required":false,"type":"boolean"},{"name":"project","in":"path","description":"project","required":true,"type":"string"},{"name":"subscription-id","in":"query","description":"subscription-id","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"integer","format":"int64"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/projects/{project}/events/delivered/summary":{"get":{"tags":["event-service-rest-api"],"summary":"getDeliveredProjectSubscriptionsSummary","operationId":"getDeliveredProjectSubscriptionsSummaryUsingGET","produces":["*/*"],"parameters":[{"name":"project","in":"path","description":"project","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SubscriptionDeliverySummary"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":true}},"/projects/{project}/events/delivered/{id}":{"get":{"tags":["event-service-rest-api"],"summary":"getDeliveredProjectSubscriptions","operationId":"getDeliveredProjectSubscriptionsUsingGET","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"},{"name":"project","in":"path","description":"project","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SubscriptionDelivery"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/projects/{project}/events/events":{"get":{"tags":["event-service-rest-api"],"summary":"getProjectEvents","operationId":"getProjectEventsUsingGET","produces":["*/*"],"parameters":[{"name":"load-details","in":"query","description":"load-details","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SimpleEvent"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/projects/{project}/events/subscription":{"post":{"tags":["event-service-rest-api"],"summary":"Create a Subscription for (project)","operationId":"createSubscriptionUsingPOST_1","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"project","in":"path","description":"project","required":true,"type":"string"},{"in":"body","name":"subscription","description":"subscription","required":true,"schema":{"$ref":"#/definitions/ProjectSubscriptionCreator"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/projects/{project}/events/subscription/{id}":{"get":{"tags":["event-service-rest-api"],"summary":"Get a Subscription by ID","operationId":"retrieveSubscriptionUsingGET_1","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"},{"name":"project","in":"path","description":"project","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SubscriptionDisplay"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"put":{"tags":["event-service-rest-api"],"summary":"Update an existing Subscription for (project)","operationId":"updateSubscriptionUsingPUT_1","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"},{"name":"project","in":"path","description":"project","required":true,"type":"string"},{"in":"body","name":"update","description":"update","required":true,"schema":{"$ref":"#/definitions/SubscriptionUpdate"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false},"delete":{"tags":["event-service-rest-api"],"summary":"Deactivate and delete a subscription by ID","operationId":"deleteUsingDELETE_5","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"},{"name":"project","in":"path","description":"project","required":true,"type":"string"}],"responses":{"200":{"description":"OK"},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"deprecated":false}},"/projects/{project}/events/subscription/{id}/activate":{"post":{"tags":["event-service-rest-api"],"summary":"Activate an existing Subscription","operationId":"activateSubscriptionUsingPOST_1","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"},{"name":"project","in":"path","description":"project","required":true,"type":"string"}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/projects/{project}/events/subscription/{id}/deactivate":{"post":{"tags":["event-service-rest-api"],"summary":"Activate an existing Subscription","operationId":"deactivateSubscriptionUsingPOST_2","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"},{"name":"project","in":"path","description":"project","required":true,"type":"string"}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/projects/{project}/events/subscriptions":{"get":{"tags":["event-service-rest-api"],"summary":"getAllSubscriptions","operationId":"getAllSubscriptionsUsingGET_1","produces":["application/json;charset=UTF-8"],"parameters":[{"name":"project","in":"path","description":"project","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SubscriptionDisplay"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/projects/{project}/experiments/{session}/scan/{scanId}/snapshot":{"get":{"tags":["snapshot-generation-api"],"summary":"Get a single image or montage of full-size images from the scan. Generate the resource if necessary.","operationId":"getSnapshotUsingGET_2","produces":["image/gif"],"parameters":[{"name":"project","in":"path","description":"Specifies the project that contains the image session","required":false,"type":"string"},{"name":"scanId","in":"path","description":"The scan for which the thumbnail should be generated","required":false,"type":"string"},{"name":"session","in":"path","description":"Specifies the ID or label for the image session (if this is the label, you must also specify the project at least)","required":false,"type":"string"},{"name":"subject","in":"path","description":"Specifies the subject associated with the image session","required":false,"type":"string"},{"name":"view","in":"path","description":"Specifies the grid layout for montage views; must be in the format *numRows*X*numColumns*, e.g. 3X3, 5X2, etc.","required":false,"type":"string"}],"responses":{"200":{"description":"Snapshot located or generated and returned.","schema":{"$ref":"#/definitions/Resource"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The session or scan requested doesn't exist."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/projects/{project}/experiments/{session}/scan/{scanId}/snapshot/{view}":{"get":{"tags":["snapshot-generation-api"],"summary":"Get a single image or montage of full-size images from the scan. Generate the resource if necessary.","operationId":"getSnapshotUsingGET_3","produces":["image/gif"],"parameters":[{"name":"project","in":"path","description":"Specifies the project that contains the image session","required":false,"type":"string"},{"name":"scanId","in":"path","description":"The scan for which the thumbnail should be generated","required":false,"type":"string"},{"name":"session","in":"path","description":"Specifies the ID or label for the image session (if this is the label, you must also specify the project at least)","required":false,"type":"string"},{"name":"subject","in":"path","description":"Specifies the subject associated with the image session","required":false,"type":"string"},{"name":"view","in":"path","description":"Specifies the grid layout for montage views; must be in the format *numRows*X*numColumns*, e.g. 3X3, 5X2, etc.","required":false,"type":"string"}],"responses":{"200":{"description":"Snapshot located or generated and returned.","schema":{"$ref":"#/definitions/Resource"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The session or scan requested doesn't exist."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/projects/{project}/experiments/{session}/scan/{scanId}/thumbnail":{"get":{"tags":["snapshot-generation-api"],"summary":"Get a single thumbnail or montage of thumbnails. Generate the resource if necessary.","operationId":"getThumbnailUsingGET_2","produces":["image/gif"],"parameters":[{"name":"project","in":"path","description":"Specifies the project that contains the image session","required":false,"type":"string"},{"name":"scanId","in":"path","description":"The scan for which the thumbnail should be generated","required":false,"type":"string"},{"name":"session","in":"path","description":"Specifies the ID or label for the image session (if this is the label, you must also specify the project at least)","required":false,"type":"string"},{"name":"subject","in":"path","description":"Specifies the subject associated with the image session","required":false,"type":"string"},{"name":"view","in":"path","description":"Specifies the grid layout for montage views; must be in the format *numRows*X*numColumns*, e.g. 3X3, 5X2, etc.","required":false,"type":"string"}],"responses":{"200":{"description":"Thumbnail located or generated and returned.","schema":{"$ref":"#/definitions/Resource"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The session or scan requested doesn't exist."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/projects/{project}/experiments/{session}/scan/{scanId}/thumbnail/{view}":{"get":{"tags":["snapshot-generation-api"],"summary":"Get a single thumbnail or montage of thumbnails. Generate the resource if necessary.","operationId":"getThumbnailUsingGET_3","produces":["image/gif"],"parameters":[{"name":"project","in":"path","description":"Specifies the project that contains the image session","required":false,"type":"string"},{"name":"scanId","in":"path","description":"The scan for which the thumbnail should be generated","required":false,"type":"string"},{"name":"session","in":"path","description":"Specifies the ID or label for the image session (if this is the label, you must also specify the project at least)","required":false,"type":"string"},{"name":"subject","in":"path","description":"Specifies the subject associated with the image session","required":false,"type":"string"},{"name":"view","in":"path","description":"Specifies the grid layout for montage views; must be in the format *numRows*X*numColumns*, e.g. 3X3, 5X2, etc.","required":false,"type":"string"}],"responses":{"200":{"description":"Thumbnail located or generated and returned.","schema":{"$ref":"#/definitions/Resource"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The session or scan requested doesn't exist."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/projects/{project}/subjects/{subject}/experiments/{session}/scan/{scanId}/snapshot":{"get":{"tags":["snapshot-generation-api"],"summary":"Get a single image or montage of full-size images from the scan. Generate the resource if necessary.","operationId":"getSnapshotUsingGET_4","produces":["image/gif"],"parameters":[{"name":"project","in":"path","description":"Specifies the project that contains the image session","required":false,"type":"string"},{"name":"scanId","in":"path","description":"The scan for which the thumbnail should be generated","required":false,"type":"string"},{"name":"session","in":"path","description":"Specifies the ID or label for the image session (if this is the label, you must also specify the project at least)","required":false,"type":"string"},{"name":"subject","in":"path","description":"Specifies the subject associated with the image session","required":false,"type":"string"},{"name":"view","in":"path","description":"Specifies the grid layout for montage views; must be in the format *numRows*X*numColumns*, e.g. 3X3, 5X2, etc.","required":false,"type":"string"}],"responses":{"200":{"description":"Snapshot located or generated and returned.","schema":{"$ref":"#/definitions/Resource"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The session or scan requested doesn't exist."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/projects/{project}/subjects/{subject}/experiments/{session}/scan/{scanId}/snapshot/{view}":{"get":{"tags":["snapshot-generation-api"],"summary":"Get a single image or montage of full-size images from the scan. Generate the resource if necessary.","operationId":"getSnapshotUsingGET_5","produces":["image/gif"],"parameters":[{"name":"project","in":"path","description":"Specifies the project that contains the image session","required":false,"type":"string"},{"name":"scanId","in":"path","description":"The scan for which the thumbnail should be generated","required":false,"type":"string"},{"name":"session","in":"path","description":"Specifies the ID or label for the image session (if this is the label, you must also specify the project at least)","required":false,"type":"string"},{"name":"subject","in":"path","description":"Specifies the subject associated with the image session","required":false,"type":"string"},{"name":"view","in":"path","description":"Specifies the grid layout for montage views; must be in the format *numRows*X*numColumns*, e.g. 3X3, 5X2, etc.","required":false,"type":"string"}],"responses":{"200":{"description":"Snapshot located or generated and returned.","schema":{"$ref":"#/definitions/Resource"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The session or scan requested doesn't exist."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/projects/{project}/subjects/{subject}/experiments/{session}/scan/{scanId}/thumbnail":{"get":{"tags":["snapshot-generation-api"],"summary":"Get a single thumbnail or montage of thumbnails. Generate the resource if necessary.","operationId":"getThumbnailUsingGET_4","produces":["image/gif"],"parameters":[{"name":"project","in":"path","description":"Specifies the project that contains the image session","required":false,"type":"string"},{"name":"scanId","in":"path","description":"The scan for which the thumbnail should be generated","required":false,"type":"string"},{"name":"session","in":"path","description":"Specifies the ID or label for the image session (if this is the label, you must also specify the project at least)","required":false,"type":"string"},{"name":"subject","in":"path","description":"Specifies the subject associated with the image session","required":false,"type":"string"},{"name":"view","in":"path","description":"Specifies the grid layout for montage views; must be in the format *numRows*X*numColumns*, e.g. 3X3, 5X2, etc.","required":false,"type":"string"}],"responses":{"200":{"description":"Thumbnail located or generated and returned.","schema":{"$ref":"#/definitions/Resource"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The session or scan requested doesn't exist."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/projects/{project}/subjects/{subject}/experiments/{session}/scan/{scanId}/thumbnail/{view}":{"get":{"tags":["snapshot-generation-api"],"summary":"Get a single thumbnail or montage of thumbnails. Generate the resource if necessary.","operationId":"getThumbnailUsingGET_5","produces":["image/gif"],"parameters":[{"name":"project","in":"path","description":"Specifies the project that contains the image session","required":false,"type":"string"},{"name":"scanId","in":"path","description":"The scan for which the thumbnail should be generated","required":false,"type":"string"},{"name":"session","in":"path","description":"Specifies the ID or label for the image session (if this is the label, you must also specify the project at least)","required":false,"type":"string"},{"name":"subject","in":"path","description":"Specifies the subject associated with the image session","required":false,"type":"string"},{"name":"view","in":"path","description":"Specifies the grid layout for montage views; must be in the format *numRows*X*numColumns*, e.g. 3X3, 5X2, etc.","required":false,"type":"string"}],"responses":{"200":{"description":"Thumbnail located or generated and returned.","schema":{"$ref":"#/definitions/Resource"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The session or scan requested doesn't exist."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/resources/mitigate/project/{projectId}":{"post":{"tags":["resource-survey-api"],"summary":"Queues resource survey requests for the specified project for mitigation operations","description":"Returns a list of IDs for the queued requests. The optional querystring parameters \"reason\" and \"comment\" are used when committing the workflow entries recording the file mitigation.","operationId":"mitigateProjectResourcesUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"comment","in":"query","description":"comment","required":false,"type":"string"},{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"},{"name":"reason","in":"query","description":"reason","required":false,"type":"string"}],"responses":{"200":{"description":"Returns a list of IDs for newly resource survey requests for the specified project.","schema":{"type":"array","items":{"type":"integer","format":"int64"}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests for the specified project."},"404":{"description":"No project exists with the specified ID."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/mitigate/project/{projectId}/report":{"get":{"tags":["resource-survey-api"],"summary":"Get the mitigation reports for the latest resource survey requests for the specified project","description":"Returns a list of mitigation reports for the project.","operationId":"getMitigationReportsUsingGET","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"}],"responses":{"200":{"description":"Returns a list of mitigation reports for the specified project.","schema":{"type":"array","items":{"$ref":"#/definitions/ResourceMitigationReport"}}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access resource mitigation report."},"404":{"description":"No mitigation report exists for the specified resource ID."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/mitigate/request/{requestId}":{"post":{"tags":["resource-survey-api"],"summary":"Queues the specified resource survey request for mitigation","description":"Returns the ID of the queued request. If the specified ID doesn't exist as a resource survey request, 404 is returned. If the resource survey request exists but the status is not DIVERGENT, 400 is returned. The optional querystring parameters \"reason\" and \"comment\" are used when committing the workflow entries recording the file mitigation.","operationId":"mitigateRequestUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"comment","in":"query","description":"comment","required":false,"type":"string"},{"name":"reason","in":"query","description":"reason","required":false,"type":"string"},{"name":"requestId","in":"path","description":"requestId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Returns the ID of the newly queued resource survey request.","schema":{"type":"integer","format":"int64"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"The resource survey request is not in a divergent state so mitigation can't be performed."},"404":{"description":"Either the specified ID is not a valid resource survey request."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/mitigate/request/{requestId}/report":{"get":{"tags":["resource-survey-api"],"summary":"Get the mitigation report for the specified resource survey request","description":"Returns the requested mitigation report.","operationId":"getMitigationReportUsingGET","produces":["application/json"],"parameters":[{"name":"requestId","in":"path","description":"requestId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Returns the mitigation report for the specified resource survey request.","schema":{"$ref":"#/definitions/ResourceMitigationReport"}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access resource mitigation report."},"404":{"description":"No mitigation report exists for the specified resource ID."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/mitigate/resource/{resourceId}":{"post":{"tags":["resource-survey-api"],"summary":"Queues the latest open resource survey request for the specified resource for mitigation","description":"Returns the ID of the queued request. If the specified ID doesn't exist as a resource ID or no open resource survey request is associated with the specified resource, 404 is returned. The optional querystring parameters \"reason\" and \"comment\" are used when committing the workflow entries recording the file mitigation.","operationId":"mitigateResourceUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"comment","in":"query","description":"comment","required":false,"type":"string"},{"name":"reason","in":"query","description":"reason","required":false,"type":"string"},{"name":"resourceId","in":"path","description":"resourceId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Returns the ID of the newly queued resource survey request.","schema":{"type":"integer","format":"int64"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests in the project containing the specified resource."},"404":{"description":"Either the specified ID is not a valid resource ID or the resource has no associated resource survey requests."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/mitigate/resource/{resourceId}/report":{"get":{"tags":["resource-survey-api"],"summary":"Get the mitigation report for the specified resource","description":"Returns the requested mitigation report.","operationId":"getMitigationReportUsingGET_1","produces":["application/json"],"parameters":[{"name":"resourceId","in":"path","description":"resourceId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Returns the mitigation report for the specified resource ID.","schema":{"$ref":"#/definitions/ResourceMitigationReport"}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access resource mitigation report."},"404":{"description":"No mitigation report exists for the specified resource ID."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/mitigate/resources":{"post":{"tags":["resource-survey-api"],"summary":"Queues the latest open resource survey requests for the specified resources for mitigation","description":"Returns a map with a list of IDs for newly queued requests as \"queued\" and non-queued requests under \"invalid\" and \"forbidden\".","operationId":"mitigateResourcesUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"resourceIds","description":"resourceIds","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}}],"responses":{"200":{"description":"Returns a map with a list of IDs for newly queued requests as \"queued\" and non-queued requests under \"invalid\" and \"forbidden\".","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests in the project(s) containing the specified resource."},"404":{"description":"Either one or more ID are not valid resource IDs or have no associated resource survey requests."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/mitigate/resources/csv":{"post":{"tags":["resource-survey-api"],"summary":"Queues the resource survey requests from the uploaded csv file for mitigation","operationId":"mitigateResourcesUsingPOST","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"name":"uploadFile","in":"formData","description":"uploadFile","required":true,"type":"file"}],"responses":{"200":{"description":"Returns a list of resource survey requests for the specified project.","schema":{"type":"string"}},"201":{"description":"Created"},"204":{"description":"No resources were specified.","schema":{"type":"string"}},"400":{"description":"Something is wrong with the request format."},"401":{"description":"Unauthorized"},"403":{"description":"The user is not authorized to access one or more of the specified resources."},"404":{"description":"The request was valid but one or more of the specified resources was not found."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/survey/project/{projectId}":{"get":{"tags":["resource-survey-api"],"summary":"Gets resource survey requests in the specified project that have been created or surveyed but not yet mitigated or otherwise closed","description":"This call returns the full resource survey request, including completed resource scan requests","operationId":"getResourceSurveyRequestsByProjectUsingGET","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"}],"responses":{"200":{"description":"Returns resource survey requests for the specified project.","schema":{"type":"array","items":{"$ref":"#/definitions/ResourceSurveyRequest"}}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests for the specified project."},"404":{"description":"No project exists with the specified ID."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false},"post":{"tags":["resource-survey-api"],"summary":"Create resource survey requests for resources in the specified project that have been modified since the specified date (if provided)","description":"Returns the IDs of newly generated survey requests for resources in the specified project. This call also queues tasks to survey the contents of the matching resources. To specify a date limiting survey requests to just those resources that were modified since that date, add a querystring parameter in the format 'since=YYYY-MM-DD' (compliant with the ISO-8601 date format).","operationId":"createResourceSurveyRequestsForProjectUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"},{"name":"since","in":"query","description":"since","required":false,"type":"string"}],"responses":{"200":{"description":"Returns a list of IDs for new resource survey requests for the specified project.","schema":{"type":"array","items":{"type":"integer","format":"int64"}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests."},"404":{"description":"No project exists with the specified ID."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false},"delete":{"tags":["resource-survey-api"],"summary":"Cancels all open resource survey requests in the specified project","description":"Returns a list of the IDs of the canceled resource survey requests. If the project contains no open resource survey requests to be canceled, an empty list is returned.","operationId":"cancelResourceSurveyRequestsByProjectUsingDELETE","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"}],"responses":{"200":{"description":"Returns a list of the canceled resource survey requests in the project with the specified ID.","schema":{"type":"array","items":{"type":"integer","format":"int64"}}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests in the specified project."},"404":{"description":"No project exists with the specified ID."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/survey/project/{projectId}/report":{"get":{"tags":["resource-survey-api"],"summary":"Gets the survey reports for resource survey requests associated with the specified project that have been created or surveyed but not yet mitigated or otherwise closed","description":"This call returns a map of resource IDs for the associated resource for each resource survey request in the specified project that have a survey report but not yet mitigated or otherwise closed, along with the survey report itself.","operationId":"getResourceReportUsingGET","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"}],"responses":{"200":{"description":"Retrieved the survey reports for the specified project.","schema":{"type":"integer","format":"int64"}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access resource mitigation report."},"404":{"description":"No project exists for the specified ID."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/survey/project/{projectId}/report/summary":{"get":{"tags":["resource-survey-api"],"summary":"Returns the summarized survey report for the specified project","operationId":"summarizeSurveyReportUsingGET","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"}],"responses":{"200":{"description":"Return the summarized survey report for a project or the site.","schema":{"$ref":"#/definitions/SurveyReportSummary"}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests."},"404":{"description":"No resource survey request exists on the server."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/survey/project/{projectId}/status":{"get":{"tags":["resource-survey-api"],"summary":"Gets the status of survey requests for the specified project that have been created or surveyed but not yet mitigated or otherwise closed","description":"Returns a map containing the ID of each resource in the specified project with at least one resource survey request, along with the status of the latest resource survey request for each resource.","operationId":"getRequestStatusUsingGET","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"}],"responses":{"200":{"description":"Returns the status of the latest survey operations for the specified project.","schema":{"type":"integer","format":"int32"}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests for the specified project."},"404":{"description":"No project exists with the specified ID."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/survey/project/{projectId}/{status}":{"get":{"tags":["resource-survey-api"],"summary":"Get the resource survey requests with the indicated status for resources in the specified project. The status value can be one of the following case-insensitive options: all, created, queued_for_survey, surveying, divergent, conforming, queued_for_mitigation, mitigating, canceled, error","description":"This call returns the full resource survey request, including completed resource scan requests","operationId":"getResourceSurveyRequestsByProjectAndStatusUsingGET","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"type":"string"},{"name":"status","in":"path","description":"status","required":true,"type":"string","enum":["all","created","queued_for_survey","surveying","divergent","conforming","queued_for_mitigation","mitigating","canceled","error"]}],"responses":{"200":{"description":"Returns resource survey requests with the indicated status for the specified project ID.","schema":{"type":"array","items":{"$ref":"#/definitions/ResourceSurveyRequest"}}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests for the specified project."},"404":{"description":"No project exists with the specified ID."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/survey/report/download":{"get":{"tags":["resource-survey-api"],"summary":"Downloads all the summarized survey reports associated with the project if a project ID is provided, regardless of their status; otherwise, download all the summarized survey reports for the whole site.","description":"Returns the summarized survey report for a project or the whole site ","operationId":"downloadSurveyReportsUsingGET","produces":["application/octet-stream"],"parameters":[{"name":"projectId","in":"query","description":"projectId","required":false,"type":"string"}],"responses":{"200":{"description":"Downloads the summarized survey report for a project or the site.","schema":{"$ref":"#/definitions/Resource"}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests."},"404":{"description":"No resource survey request exists on the server."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/survey/report/summary":{"get":{"tags":["resource-survey-api"],"summary":"Returns the summarized survey reports for a project or the entire site","description":"The response is limited to a single project if the projectId querystring parameter is specified, but reports for all projects on the site if not.","operationId":"summarizeSurveyReportsUsingGET","produces":["application/json"],"parameters":[{"name":"projectId","in":"query","description":"projectId","required":false,"type":"string"}],"responses":{"200":{"description":"Return the summarized survey reports for a project or the site.","schema":{"type":"array","items":{"$ref":"#/definitions/SurveyReportSummary"}}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests."},"404":{"description":"No resource survey request exists on the server."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/survey/request":{"delete":{"tags":["resource-survey-api"],"summary":"Cancels the specified resource survey requests","description":"Returns the IDs of the canceled survey requests. If one or more of the IDs doesn't exist as a resource survey request ID, none of the requests are canceled and 404 is returned.","operationId":"cancelResourceSurveyRequestUsingDELETE_1","produces":["application/json"],"parameters":[{"in":"body","name":"requestIds","description":"requestIds","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}],"responses":{"200":{"description":"Returns the canceled resource survey request IDs.","schema":{"type":"array","items":{"type":"integer","format":"int64"}}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests."},"404":{"description":"One or more of the specified IDs do not exist as resource survey request IDs."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/survey/request/{requestId}":{"get":{"tags":["resource-survey-api"],"summary":"Get the resource survey request with the specified ID","operationId":"getResourceSurveyRequestUsingGET","produces":["application/json"],"parameters":[{"name":"requestId","in":"path","description":"requestId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Returns the specified resource survey request.","schema":{"$ref":"#/definitions/ResourceSurveyRequest"}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests in the project containing the specified resource."},"404":{"description":"No resource survey request exists with the specified ID."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false},"delete":{"tags":["resource-survey-api"],"summary":"Cancels the specified resource survey request","description":"Returns the ID of the canceled survey request","operationId":"cancelResourceSurveyRequestUsingDELETE","produces":["application/json"],"parameters":[{"name":"requestId","in":"path","description":"requestId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Returns the canceled resource survey request ID.","schema":{"type":"integer","format":"int64"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests."},"404":{"description":"The specified ID does not exist as a resource survey request ID."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/survey/request/{requestId}/report":{"get":{"tags":["resource-survey-api"],"summary":"Gets the survey report for the specified resource survey request","operationId":"getRequestReportUsingGET","produces":["application/json"],"parameters":[{"name":"requestId","in":"path","description":"requestId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Retrieved the survey report for the specified resource survey request.","schema":{"$ref":"#/definitions/ResourceSurveyReport"}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access resource survey report."},"404":{"description":"No resource survey request exists for the specified request ID."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false},"delete":{"tags":["resource-survey-api"],"summary":"Clean the survey and mitigation reports for the specified resource survey request","description":"This removes filenames and other possible sources of PHI from the survey and mitigation reports. The optional querystring parameters \"reason\" and \"comment\" are used when committing the workflow entries recording the report cleaning.","operationId":"cleanRequestReportsUsingDELETE","produces":["application/json"],"parameters":[{"name":"comment","in":"query","description":"comment","required":false,"type":"string"},{"name":"reason","in":"query","description":"reason","required":false,"type":"string"},{"name":"requestId","in":"path","description":"requestId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Cleaned the survey and mitigation reports for the specified resource survey request."},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access resource survey report."},"404":{"description":"No resource survey request exists for the specified request ID."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/survey/request/{requestId}/status":{"get":{"tags":["resource-survey-api"],"summary":"Gets the survey status for the specified request","description":"Returns the status of the resource survey request with the specified ID. If the ID doesn't exist as a resource survey request ID, 404 is returned.","operationId":"getRequestStatusUsingGET_1","produces":["*/*"],"parameters":[{"name":"requestId","in":"path","description":"requestId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Returns the status of the latest survey for the specified resource.","schema":{"type":"string","enum":["CREATED","QUEUED_FOR_SURVEY","SURVEYING","DIVERGENT","CONFORMING","NONCOMPLIANT","QUEUED_FOR_MITIGATION","MITIGATING","RESOURCE_DELETED","CANCELED","ERROR"]}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests in the project containing the resource."},"404":{"description":"Either the specified ID is not a valid resource ID or the resource has no associated resource survey requests."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/survey/resource":{"delete":{"tags":["resource-survey-api"],"summary":"Cancels the resource survey requests for the specified resources","description":"Returns a map of the resource IDs and canceled resource survey request IDs. If one or more of the IDs doesn't exist as a resource ID, none of the requests are canceled and 404 is returned.","operationId":"cancelResourceSurveyRequestsByResourceIdsUsingDELETE","produces":["*/*"],"parameters":[{"in":"body","name":"resourceIds","description":"resourceIds","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}}],"responses":{"200":{"description":"Returns a map of the resource IDs and canceled resource survey request IDs.","schema":{"type":"integer","format":"int32"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests in the project(s) containing the specified resources."},"404":{"description":"Either one or more of the specified IDs are not valid resource IDs or have no associated resource survey requests."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/survey/resource/status":{"post":{"tags":["resource-survey-api"],"summary":"Gets the survey status for the specified resources","description":"Returns a map containing the ID of each resource with at least one resource survey request, along with the status of the latest resource survey request for each resource. If one or more of the IDs doesn't exist as a resource ID, 404 is returned. If one or more of the existing resources doesn't have any associated resource survey requests, that resource is omitted from the results.","operationId":"getRequestStatusUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"resourceIds","description":"resourceIds","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}}],"responses":{"200":{"description":"Returns the resource ID and status of the latest resource survey request for each specified resource.","schema":{"type":"integer","format":"int32"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests in the project(s) containing the specified resources."},"404":{"description":"Either one or more of the specified IDs are not valid resource IDs or have no associated resource survey requests."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/survey/resource/{resourceId}":{"get":{"tags":["resource-survey-api"],"summary":"Get the latest resource survey request for the specified resource","description":"Returns a resource survey request for the specified resource. If no resource with the specified ID exists or if the resource exists but no resource survey requests exist for that resource, this method returns a 404 status. If multiple resource survey requests exist for the resource, only the latest request is returned.","operationId":"getResourceSurveyRequestByResourceIdUsingGET","produces":["application/json"],"parameters":[{"name":"resourceId","in":"path","description":"resourceId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Returns the latest resource survey request for the specified resource ID.","schema":{"$ref":"#/definitions/ResourceSurveyRequest"}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests in the project containing the specified resource."},"404":{"description":"Either no resource exists with the specified ID or there are no resource survey requests for that resource."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false},"post":{"tags":["resource-survey-api"],"summary":"Creates a resource survey request for the specified resource","description":"Returns the ID of the newly generated survey request for the specified resource. This call also queues a task to survey the contents of the specified resource.","operationId":"createResourceSurveyRequestUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"resourceId","in":"path","description":"resourceId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Returns the ID of the new resource survey request for the specified resource.","schema":{"type":"integer","format":"int64"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests."},"404":{"description":"Not Found"},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false},"delete":{"tags":["resource-survey-api"],"summary":"Cancels the resource survey request for the specified resource","description":"Returns the ID of the canceled resource survey request. If the ID doesn't exist as a resource survey request ID, 404 is returned.","operationId":"cancelResourceSurveyRequestByResourceIdUsingDELETE","produces":["*/*"],"parameters":[{"name":"resourceId","in":"path","description":"resourceId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Returns the ID of the canceled resource survey request for the specified resource ID.","schema":{"type":"integer","format":"int64"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests in the project containing the specified resource."},"404":{"description":"Either no resource exists with the specified ID or there are no resource survey requests for that resource."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/survey/resource/{resourceId}/report":{"get":{"tags":["resource-survey-api"],"summary":"Gets the survey report for the latest resource survey request associated with the specified resource","operationId":"getResourceReportUsingGET_1","produces":["application/json"],"parameters":[{"name":"resourceId","in":"path","description":"resourceId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Retrieved the survey report for the specified resource ID.","schema":{"$ref":"#/definitions/ResourceSurveyReport"}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access resource mitigation report."},"404":{"description":"No resource exists for the specified resource ID."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false},"delete":{"tags":["resource-survey-api"],"summary":"Clean the survey and mitigation reports for all resource survey requests associated with the specified resource","description":"This removes filenames and other possible sources of PHI from the survey and mitigation reports. The optional querystring parameters \"reason\" and \"comment\" are used when committing the workflow entries recording the report cleaning.","operationId":"cleanResourceReportsUsingDELETE","produces":["application/json"],"parameters":[{"name":"comment","in":"query","description":"comment","required":false,"type":"string"},{"name":"reason","in":"query","description":"reason","required":false,"type":"string"},{"name":"resourceId","in":"path","description":"resourceId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Cleaned all survey and mitigation reports for the specified resource ID."},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access resource mitigation report."},"404":{"description":"No resource exists for the specified resource ID."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/resources/survey/resource/{resourceId}/status":{"get":{"tags":["resource-survey-api"],"summary":"Gets the survey status for the specified resource","description":"Returns the status of the latest resource survey request for the specified resource. If the ID doesn't exist as a resource ID or there is no resource survey request associated with the specified resource, 404 is returned.","operationId":"getRequestStatusUsingGET_2","produces":["*/*"],"parameters":[{"name":"resourceId","in":"path","description":"resourceId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Returns the status of the latest survey for the specified resource.","schema":{"type":"string","enum":["CREATED","QUEUED_FOR_SURVEY","SURVEYING","DIVERGENT","CONFORMING","NONCOMPLIANT","QUEUED_FOR_MITIGATION","MITIGATING","RESOURCE_DELETED","CANCELED","ERROR"]}},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions to access or administer resource survey requests in the project containing the resource."},"404":{"description":"Either the specified ID is not a valid resource ID or the resource has no associated resource survey requests."},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/role/displays/createable":{"get":{"tags":["role-based-data-access-api"],"summary":"Gets XNAT Elements that can be created by a Form Data Manager","description":"Gets XNAT Elements that can be created by a Form Data Manager","operationId":"getCreatableElementsUsingGET","produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/role/projects":{"get":{"tags":["role-based-data-access-api"],"summary":"Gets XNAT Elements that can be created by a Form Data Manager","description":"Gets XNAT Elements that can be created by a Form Data Manager","operationId":"getSiteProjectsUsingGET","produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/role/projectsById":{"post":{"tags":["role-based-data-access-api"],"summary":"Get specific XNAT project data that can be used by a Form Data Manager","operationId":"getSelectedProjectsUsingPOST","consumes":["text/plain"],"produces":["application/json;charset=UTF-8"],"parameters":[{"in":"body","name":"listOfProjects","description":"listOfProjects","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}},"201":{"description":"Created"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/schemas":{"get":{"tags":["schema-api"],"summary":"Returns a list of all of the installed XNAT data-type schemas.","description":"The strings returned from this function tell you the name of the schema and can be used with other methods on this API to retrieve the full schema document. This tells you nothing about whether the data types defined in the schemas are active or configured.","operationId":"getAllDataTypeSchemasUsingGET","produces":["application/json"],"responses":{"200":{"description":"XNAT data-type schemas successfully retrieved.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/schemas/datatypes":{"get":{"tags":["schema-api"],"summary":"Gets a list of the available data types on the system.","description":"The available data types can be used as parameters for this call in the form /xapi/access/datatypes/{dataType}. This call is accessible to guest users when the site preference require login is set to false (i.e. open XNATs).","operationId":"getAllElementTypesUsingGET","produces":["application/json"],"responses":{"200":{"description":"A list of available data types.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the list of available data types."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/schemas/datatypes/elements":{"post":{"tags":["schema-api"],"summary":"Gets information about the requested data type.","description":"The available element displays from the call /xapi/access/datatypes can be used as the data type parameter for this call. This call is accessible to guest users when the site preference require login is set to false (i.e. open XNATs).","operationId":"getSpecifiedElementsFromFormPostUsingPOST","consumes":["application/x-www-form-urlencoded"],"produces":["application/json"],"parameters":[{"name":"dataType","in":"formData","description":"The data type to be retrieved.","required":false,"type":"string"},{"name":"dataTypes","in":"formData","description":"A list of data types to be retrieved.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"Information on the requested data type.","schema":{"$ref":"#/definitions/GenericWrapperElement"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the available data type."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/schemas/datatypes/elements/all":{"get":{"tags":["schema-api"],"summary":"Gets a map of all available data types on the system with the full element definition.","description":"This can get pretty large.","operationId":"getAllElementsUsingGET","produces":["application/json"],"responses":{"200":{"description":"A list of available data types.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the list of available data types."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/schemas/datatypes/elements/{dataType}":{"get":{"tags":["schema-api"],"summary":"Gets information about the requested data type.","description":"The available data types from the call /xapi/access/datatypes/elements/all can be used as the data type parameter for this call. This call is accessible to guest users when the site preference require login is set to false (i.e. open XNATs).","operationId":"getSpecifiedElementUsingGET","produces":["application/json"],"parameters":[{"name":"dataType","in":"path","description":"The data type to be retrieved.","required":false,"type":"string"}],"responses":{"200":{"description":"Information on the requested data type.","schema":{"$ref":"#/definitions/GenericWrapperElement"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the available data type."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/schemas/datatypes/names":{"post":{"tags":["schema-api"],"summary":"Gets information about the requested data types.","description":"The available data types from the call /xapi/access/datatypes can be used as the data type parameter for this call. This call is accessible to guest users when the site preference require login is set to false (i.e. open XNATs).","operationId":"getSpecifiedElementTypeNamesFromJsonPostUsingPOST","consumes":["application/json","application/json;charset=UTF-8"],"produces":["application/json"],"parameters":[{"in":"body","name":"attributes","description":"The data types to be retrieved.","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"The element names and types for the specified data types.","schema":{"type":"array","items":{"$ref":"#/definitions/GenericWrapperElement"}}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the specified data types."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/schemas/datatypes/names/all":{"get":{"tags":["schema-api"],"summary":"Gets a map of the available data types on the system along with the various data type element names and types. This map includes a timestamp indicating when the list of data types was generated using the key \"timestamp\".","description":"The available data types (i.e. the keys in the returned map) can be used as parameters for this call in the form /xapi/access/datatypes/names/{dataType}. This call is accessible to guest users when the site preference require login is set to false (i.e. open XNATs). The timestamp element in this list indicates when the list was generated. This allows clients to check whether the data type list has been updated since the last call to this method.","operationId":"getAllElementTypeNamesUsingGET","produces":["application/json"],"responses":{"200":{"description":"A list of available data types.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the list of available data types."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/schemas/datatypes/names/{dataType}":{"get":{"tags":["schema-api"],"summary":"Gets the element names and types for the specified data type.","description":"The available data types that can be used as parameters for this call can be retrieved by calling /xapi/access/datatypes/names/all. This call is accessible to guest users when the site preference require login is set to false (i.e. open XNATs).","operationId":"getSpecifiedElementTypeNamesUsingGET","produces":["application/json"],"parameters":[{"name":"dataType","in":"path","description":"The name of the data type to retrieve","required":false,"type":"string"}],"responses":{"200":{"description":"The element names and types for the specified data type.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the specified data type."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/schemas/datatypes/searchable":{"get":{"tags":["schema-api"],"summary":"Gets the image session datatypes which are searchable within the system.","operationId":"getListOfSearchableDatatypesUsingGET","produces":["application/json"],"responses":{"200":{"description":"The list of searchable image session datatypes which are available from the system.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the searchable datatypes."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/schemas/{namespace}/{schema}":{"get":{"tags":["schema-api"],"summary":"Returns the requested XNAT data-type schema.","description":"XNAT data-type schemas are most often stored on the classpath in the folder schemas/SCHEMA/SCHEMA.xsd, but sometimes the folder name differs from the schema name. This function returns the schema named SCHEMA.xsd in the folder named NAMESPACE. This tells you nothing about whether the data types defined in the schemas are active or configured.","operationId":"getRequestedDataTypeSchemaUsingGET","produces":["application/xml"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"type":"string"},{"name":"schema","in":"path","description":"schema","required":true,"type":"string"}],"responses":{"200":{"description":"XNAT data-type schemas successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource wasn't found."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/schemas/{schema}":{"get":{"tags":["schema-api"],"summary":"Returns the requested XNAT data-type schema.","description":"XNAT data-type schemas are most often stored on the classpath in the folder schemas/SCHEMA/SCHEMA.xsd. This function returns the schema named SCHEMA.xsd in the folder named SCHEMA. You can use the function that allows you to specify the namespace as well if the folder name differs from the schema name. This tells you nothing about whether the data types defined in the schemas are active or configured.","operationId":"getRequestedDataTypeSchemaUsingGET_1","produces":["application/xml"],"parameters":[{"name":"schema","in":"path","description":"schema","required":true,"type":"string"}],"responses":{"200":{"description":"XNAT data-type schemas successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource wasn't found."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/siteConfig":{"get":{"tags":["site-config-api"],"summary":"Returns the full map of site configuration properties.","description":"Complex objects may be returned as encapsulated JSON strings.","operationId":"getSiteConfigPropertiesUsingGET","produces":["application/json"],"responses":{"200":{"description":"Site configuration properties successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set site configuration properties."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["site-config-api"],"summary":"Sets a map of site configuration properties.","description":"Sets the site configuration properties specified in the map.","operationId":"setSiteConfigPropertiesUsingPOST","consumes":["application/json","application/x-www-form-urlencoded"],"produces":["*/*"],"parameters":[{"in":"body","name":"properties","description":"The map of site configuration properties to be set.","required":true,"schema":{"type":"object"}}],"responses":{"200":{"description":"Site configuration properties successfully set."},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set site configuration properties."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/siteConfig/buildInfo":{"get":{"tags":["site-config-api"],"summary":"Returns a map of application build properties.","description":"This includes the implementation version, Git commit hash, and build number and number.","operationId":"getBuildInfoUsingGET","produces":["application/json"],"responses":{"200":{"description":"Application build properties successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/siteConfig/buildInfo/attributes":{"get":{"tags":["site-config-api"],"summary":"Returns a map of extended build attributes.","description":"The values are dependent on what attributes are set for the build. It is not unexpected that there are no extended build attributes.","operationId":"getBuildAttributeInfoUsingGET","produces":["application/json"],"responses":{"200":{"description":"Extended build attributes successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/siteConfig/buildInfo/{property}":{"get":{"tags":["site-config-api"],"summary":"Returns a map of extended build attributes.","description":"The values are dependent on what attributes are set for the build. It is not unexpected that there are no extended build attributes.","operationId":"getBuildPropertyUsingGET","produces":["application/json"],"parameters":[{"name":"property","in":"path","description":"Indicates the specific property to be returned","required":false,"type":"string"}],"responses":{"200":{"description":"Extended build attributes successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/siteConfig/orphaned-projects/disable":{"post":{"tags":["site-config-api"],"summary":"Disable orphaned series import filters for deleted projects.","description":"Disable orphaned series import filters for deleted projects.","operationId":"disableOrphanedSifUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"orphanedProjectIds","description":"The deleted project IDs (comma-separated).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Orphaned series import filters successfully disabled"},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to modify site configuration properties."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/siteConfig/uptime":{"get":{"tags":["site-config-api"],"summary":"Returns the system uptime.","description":"This returns the uptime as a map of time units: days, hours, minutes, and seconds.","operationId":"getSystemUptimeUsingGET","produces":["application/json"],"responses":{"200":{"description":"System uptime successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/siteConfig/uptime/display":{"get":{"tags":["site-config-api"],"summary":"Returns the system uptime.","description":"This returns the uptime as a formatted string.","operationId":"getFormattedSystemUptimeUsingGET","produces":["application/json"],"responses":{"200":{"description":"System uptime successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/siteConfig/values/{preferences}":{"get":{"tags":["site-config-api"],"summary":"Returns a map of the selected site configuration properties.","description":"Complex objects may be returned as encapsulated JSON strings.","operationId":"getSpecifiedSiteConfigPropertiesUsingGET","produces":["application/json"],"parameters":[{"name":"preferences","in":"path","description":"preferences","required":true,"type":"string"}],"responses":{"200":{"description":"Site configuration properties successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set site configuration properties."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/siteConfig/{property}":{"get":{"tags":["site-config-api"],"summary":"Returns the value of the selected site configuration property.","description":"Complex objects may be returned as encapsulated JSON strings.","operationId":"getSpecifiedSiteConfigPropertyUsingGET","produces":["application/json"],"parameters":[{"name":"property","in":"path","description":"The site configuration property to retrieve.","required":true,"type":"string"}],"responses":{"200":{"description":"Site configuration property successfully retrieved.","schema":{"type":"object"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to access site configuration properties."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["site-config-api"],"summary":"Sets a single site configuration property.","description":"Sets the site configuration property specified in the URL to the value set in the body.","operationId":"setSiteConfigPropertyUsingPOST","consumes":["application/json","text/plain"],"produces":["application/json"],"parameters":[{"name":"property","in":"path","description":"The property to be set.","required":true,"type":"string"},{"in":"body","name":"value","description":"The value to be set for the property.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Site configuration properties successfully set."},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to set site configuration properties."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/spawner/element":{"post":{"tags":["spawner-api"],"summary":"Create a new spawner element in the default namespace.","description":"Creates a new spawner element in the default namespace from the submitted YAML. This method returns the parsed and validated YAML content of the spawner element on success.","operationId":"createDefaultElementUsingPOST","consumes":["text/x-yaml","text/plain"],"produces":["text/x-yaml"],"parameters":[{"in":"body","name":"yaml","description":"yaml","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The new spawner element was successfully created.","schema":{"type":"string"}},"201":{"description":"Created"},"400":{"description":"Bad request, likely an invalid, missing, or duplicated element ID."},"401":{"description":"Unauthorized"},"403":{"description":"Access denied"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/spawner/element/{elementId}":{"get":{"tags":["spawner-api"],"summary":"Get the specified spawner element from the default namespace.","description":"Retrieves the spawner element with the indicated ID from the default namespace.","operationId":"getDefaultElementUsingGET","produces":["application/json"],"parameters":[{"name":"elementId","in":"path","description":"elementId","required":true,"type":"string"}],"responses":{"200":{"description":"The spawner element with the specified ID from the default namespace.","schema":{"$ref":"#/definitions/SpawnerElement"}},"204":{"description":"Element ID doesn't exist or has no content.","schema":{"$ref":"#/definitions/SpawnerElement"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["spawner-api"],"summary":"Updates the specified spawner element.","description":"Updates the spawner element in the default namespace with the submitted data. This method returns the parsed and validated YAML content of the spawner element on success.","operationId":"updateDefaultElementUsingPUT","consumes":["application/json"],"produces":["text/x-yaml"],"parameters":[{"name":"elementId","in":"path","description":"elementId","required":true,"type":"string"},{"in":"body","name":"yaml","description":"yaml","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The specified element was successfully updated.","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Access denied"},"404":{"description":"Namespace or element ID not found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["spawner-api"],"summary":"Deletes the specified spawner element.","description":"Deletes the spawner element in the default namespace.","operationId":"deleteDefaultElementUsingDELETE","produces":["text/x-yaml"],"parameters":[{"name":"elementId","in":"path","description":"elementId","required":true,"type":"string"}],"responses":{"200":{"description":"The specified element was successfully deleted."},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Access denied"},"404":{"description":"Namespace or element ID not found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/spawner/element/{namespace}":{"post":{"tags":["spawner-api"],"summary":"Create a new spawner element in the specified namespace.","description":"Creates a new spawner element in the specified namespace from the submitted YAML. This method returns the parsed and validated YAML content of the spawner element on success.","operationId":"createNamespacedElementUsingPOST","consumes":["text/x-yaml","text/plain"],"produces":["text/x-yaml"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"type":"string"},{"in":"body","name":"yaml","description":"yaml","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The new spawner element was successfully created.","schema":{"type":"string"}},"201":{"description":"Created"},"400":{"description":"Bad request, likely an invalid, missing, or duplicated element ID."},"401":{"description":"Unauthorized"},"403":{"description":"Access denied"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/spawner/element/{namespace}/{elementId}":{"get":{"tags":["spawner-api"],"summary":"Get the specified spawner element from the specified namespace.","description":"Retrieves the spawner element with the indicated ID from the specified namespace.","operationId":"getNamespacedElementUsingGET","produces":["application/json"],"parameters":[{"name":"elementId","in":"path","description":"elementId","required":true,"type":"string"},{"name":"namespace","in":"path","description":"namespace","required":true,"type":"string"}],"responses":{"200":{"description":"The spawner element with the specified ID from the default namespace.","schema":{"$ref":"#/definitions/SpawnerElement"}},"204":{"description":"Namespace or element ID doesn't exist or has no content.","schema":{"$ref":"#/definitions/SpawnerElement"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["spawner-api"],"summary":"Updates the specified spawner element.","description":"Updates the spawner element in the specified namespace with the submitted data. This method returns the parsed and validated YAML content of the spawner element on success.","operationId":"updateNamespacedElementUsingPUT","consumes":["application/json"],"produces":["text/x-yaml"],"parameters":[{"name":"elementId","in":"path","description":"elementId","required":true,"type":"string"},{"name":"namespace","in":"path","description":"namespace","required":true,"type":"string"},{"in":"body","name":"yaml","description":"yaml","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The specified element was successfully updated.","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Access denied"},"404":{"description":"Namespace or element ID not found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["spawner-api"],"summary":"Deletes the specified spawner element.","description":"Deletes the spawner element in the specified namespace.","operationId":"deleteNamespacedElementUsingDELETE","produces":["text/x-yaml"],"parameters":[{"name":"elementId","in":"path","description":"elementId","required":true,"type":"string"},{"name":"namespace","in":"path","description":"namespace","required":true,"type":"string"}],"responses":{"200":{"description":"The specified element was successfully deleted."},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Access denied"},"404":{"description":"Namespace or element ID not found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/spawner/elements":{"get":{"tags":["spawner-api"],"summary":"Get list of spawner elements in the system's default namespace.","description":"The default namespace spawner element function returns a list of all of the spawner elements in the default namespace of the XNAT system.","operationId":"getDefaultElementsUsingGET","produces":["application/json"],"responses":{"200":{"description":"A list of spawner elements from the default namespace.","schema":{"type":"array","items":{"$ref":"#/definitions/SpawnerElement"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/spawner/elements/{namespace}":{"get":{"tags":["spawner-api"],"summary":"Get list of spawner elements in the specified namespace.","description":"The namespaced spawner element function returns a list of all of the spawner elements in the specified namespace of the XNAT system.","operationId":"getNamespacedElementsUsingGET","produces":["application/json"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"type":"string"}],"responses":{"200":{"description":"A list of spawner elements from the specified namespace.","schema":{"type":"array","items":{"$ref":"#/definitions/SpawnerElement"}}},"204":{"description":"Namespace not found or no elements exist.","schema":{"type":"array","items":{"$ref":"#/definitions/SpawnerElement"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"post":{"tags":["spawner-api"],"summary":"Purges the existing spawner elements in the specified namespace and refreshes the elements from the corresponding element definition file.","description":"The refresh spawner namespace updates all of the spawner elements in the specified element definition file of the XNAT system. Any elements that are not specified in the element definition file will be purged from the system.","operationId":"purgeAndRefreshNamespacedElementsUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"type":"string"}],"responses":{"200":{"description":"The spawner elements in the specified namespace were successfully purged and refreshed."},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Namespace not found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["spawner-api"],"summary":"Refreshes the spawner elements in the specified namespace from the corresponding element definition file.","description":"The refresh spawner namespace updates all of the spawner elements in the specified element definition file of the XNAT system. This will not delete or update any elements that are not specified in the element definition file","operationId":"refreshNamespacedElementsUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"type":"string"}],"responses":{"200":{"description":"The spawner elements in the specified namespace were successfully refreshed."},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Namespace not found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["spawner-api"],"summary":"Deletes all spawner elements in the specified namespace.","description":"The delete spawner namespace deletes all of the spawner elements in the specified namespace of the XNAT system.","operationId":"deleteNamespacedElementsUsingDELETE","produces":["application/json"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"type":"string"}],"responses":{"200":{"description":"The spawner elements in the specified namespace were successfully deleted."},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Namespace not found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/spawner/ids":{"get":{"tags":["spawner-api"],"summary":"Get list of element IDs in the system's default namespace.","description":"The spawner element IDs function returns a list of all the IDs of spawner elements in the default namespace of the XNAT system.","operationId":"getDefaultElementIdsUsingGET","produces":["application/json"],"responses":{"200":{"description":"A list of spawner element IDs in the default namespace.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/spawner/ids/{namespace}":{"get":{"tags":["spawner-api"],"summary":"Get list of element IDs in the specified namespace.","description":"The spawner element IDs function returns a list of all the IDs of spawner elements in the specified namespace of the XNAT system.","operationId":"getNamespacedElementIdsUsingGET","produces":["application/json"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"type":"string"}],"responses":{"200":{"description":"A list of spawner element IDs for the specified namespace.","schema":{"type":"array","items":{"type":"string"}}},"204":{"description":"Namespace not found or no elements exist.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/spawner/initialize":{"post":{"tags":["spawner-api"],"summary":"Re-initializes the system's spawner elements.","operationId":"initializeUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"forcePurge","description":"Whether the service should be purged regardless of the purgeAndRefreshOnStartup preference setting. If not specified, this defaults to true.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Spawner elements successfully re-initialized."},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected or unknown error occurred"}},"deprecated":false}},"/spawner/namespaces":{"get":{"tags":["spawner-api"],"summary":"Get list of available element namespaces in the system.","description":"The spawner element namespaces provide organizational separation of spawner elements. This call returns a list of the namespaces in the XNAT system.","operationId":"getNamespacesUsingGET","produces":["application/json"],"responses":{"200":{"description":"A list of spawner element namespaces.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/spawner/namespaces/restricted":{"get":{"tags":["spawner-api"],"summary":"Get list of available element namespaces and their restrictions in the system for the requesting user.","description":"The spawner element namespaces provide organizational separation of spawner elements. This call returns a list of the namespaces in the XNAT system.","operationId":"getNamespacesWithRestrictionsUsingGET","produces":["application/json"],"responses":{"200":{"description":"A map of spawner element namespaces and their restrictions.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/spawner/resolve/{elementId}":{"get":{"tags":["spawner-api"],"summary":"Resolves the specified spawner element from the default namespace.","description":"This method retrieves the spawner element with the indicated ID from the default namespace, then resolves all of the referenced child elements as well, and renders a fully resolved YAML document that describes a complete interface.","operationId":"resolveDefaultElementUsingGET","produces":["application/json"],"parameters":[{"name":"elementId","in":"path","description":"elementId","required":true,"type":"string"},{"name":"restrict","in":"query","description":"restrict","required":false,"type":"boolean"}],"responses":{"200":{"description":"The specified element was successfully located and resolved.","schema":{"type":"string"}},"204":{"description":"Element ID doesn't exist or has no content.","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/spawner/resolve/{namespace}/{elementId}":{"get":{"tags":["spawner-api"],"summary":"Resolves the specified spawner element from the specified namespace.","description":"This method retrieves the spawner element with the indicated ID from the specified namespace, then resolves all of the referenced child elements as well, and renders a fully resolved YAML document that describes a complete interface.","operationId":"resolveNamespacedElementUsingGET","produces":["application/json"],"parameters":[{"name":"elementId","in":"path","description":"elementId","required":true,"type":"string"},{"name":"namespace","in":"path","description":"namespace","required":true,"type":"string"},{"name":"restrict","in":"query","description":"restrict","required":false,"type":"boolean"}],"responses":{"200":{"description":"The specified element was successfully located and resolved.","schema":{"type":"string"}},"204":{"description":"Namespace or element ID doesn't exist or has no content.","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Namespace or element ID is restricted to role."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/spawner/validate/batch":{"post":{"tags":["spawner-api"],"summary":"Validates the value in the request body with the indicated validation method.","description":"Applies the given validation method to the value in the request body.","operationId":"validateBatchUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"elements","description":"This is a map of element IDs, with each element ID corresponding to a map containing a value property, validation property, and optional set property. Both set and validation can specified with the validation property by using the form \"validation\": \"set:validation\".","required":false,"schema":{"type":"object","additionalProperties":{"$ref":"#/definitions/Map«string,string»"}}}],"responses":{"200":{"description":"Value was successfully validated.","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The specified validation method was not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/spawner/validate/list":{"get":{"tags":["spawner-api"],"summary":"Returns all available validation methods.","description":"This call returns a map keyed by the validation set and ID.","operationId":"validateListUsingGET","produces":["application/json"],"responses":{"200":{"description":"Value was successfully validated.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The specified validation method was not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/spawner/validate/list/{set}":{"get":{"tags":["spawner-api"],"summary":"Returns all available validation methods.","description":"This call returns a map keyed by the validation set and ID.","operationId":"validateListSetUsingGET","produces":["application/json"],"parameters":[{"name":"set","in":"path","description":"The set of validations to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"Value was successfully validated.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The specified validation method was not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/spawner/validate/{set}/{validation}":{"post":{"tags":["spawner-api"],"summary":"Validates the value in the request body with the indicated validation method.","description":"Applies the given validation method to the value in the request body.","operationId":"validateSetValidationUsingPOST","consumes":["text/plain"],"produces":["application/json"],"parameters":[{"name":"set","in":"path","description":"The validation set to reference.","required":true,"type":"string"},{"name":"validation","in":"path","description":"The validation method to be applied to the input value.","required":true,"type":"string"},{"in":"body","name":"value","description":"value","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Value was successfully validated.","schema":{"$ref":"#/definitions/Validated"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The specified validation method was not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/spawner/validate/{validation}":{"post":{"tags":["spawner-api"],"summary":"Validates the value in the request body with the indicated validation method.","description":"Applies the given validation method to the value in the request body.","operationId":"validateValidationUsingPOST","consumes":["text/plain"],"produces":["application/json"],"parameters":[{"name":"validation","in":"path","description":"The validation method to be applied to the input value.","required":true,"type":"string"},{"in":"body","name":"value","description":"value","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Value was successfully validated.","schema":{"$ref":"#/definitions/Validated"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The specified validation method was not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/spawner/xml/{namespace}":{"get":{"tags":["spawner-api"],"summary":"Resolves the 'root' element in the specified spawner namespace as XML.","description":"This method retrieves elements from the specified spawner namespace and renders an XML representation of a fully resolved YAML document that describes a complete interface.","operationId":"resolveNamespaceXmlUsingGET","produces":["text/xml"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"type":"string"}],"responses":{"200":{"description":"The specified namespace was successfully located and resolved.","schema":{"type":"string"}},"204":{"description":"Namespace doesn't exist or has no content.","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/spawner/xml/{namespace}/{elementId}":{"get":{"tags":["spawner-api"],"summary":"Resolves the specified spawner element from the specified namespace as XML.","description":"This method retrieves the spawner element with the indicated ID from the specified namespace, then resolves all of the referenced child elements as well, and renders an XML representation of a fully resolved YAML document that describes a complete interface.","operationId":"resolveNamespacedElementXmlUsingGET","produces":["text/xml"],"parameters":[{"name":"elementId","in":"path","description":"elementId","required":true,"type":"string"},{"name":"namespace","in":"path","description":"namespace","required":true,"type":"string"}],"responses":{"200":{"description":"The specified element was successfully located and resolved.","schema":{"type":"string"}},"204":{"description":"Namespace or element ID doesn't exist or has no content.","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/themes":{"get":{"tags":["theme-api"],"summary":"Get list of available themes.","description":"Use this to get a list of all available themes on the XNAT system.","operationId":"getAllThemesUsingGET","produces":["application/json"],"responses":{"200":{"description":"Reports the currently selected global theme (if there is one), whether or not it's enabled, and a list of available themes on the system in a JSON string.","schema":{"type":"array","items":{"$ref":"#/definitions/TypeOption"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false},"post":{"tags":["theme-api"],"summary":"Accepts a multipart form with a zip file upload and extracts its contents in the theme system folder. If successful, the first (root) directory name (or theme name) unzipped is returned in the response. This will overwrite any other directories already existing with the same name without warning.","description":"The structure of the zipped package must have only directories at it's root.","operationId":"uploadThemeUsingPOST","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"name":"themePackage","in":"formData","description":"Multipart file object being uploaded","required":true,"type":"file"}],"responses":{"200":{"description":"Theme package successfully uploaded and extracted.","schema":{"type":"string"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to upload a theme package."},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/themes/current":{"get":{"tags":["theme-api"],"summary":"Get the currently selected global theme or a role based theme if specified.","description":"Use this to get the theme selected by the system administrator on the Theme Management page.","operationId":"getCurrentThemeUsingGET","produces":["application/json"],"responses":{"200":{"description":"Reports the currently selected global theme (if there is one) and whether or not it's enabled.","schema":{"$ref":"#/definitions/ThemeConfig"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/themes/role/{role}":{"get":{"tags":["theme-api"],"summary":"Get the currently selected global theme or a role based theme if specified.","description":"Use this to get the theme selected by the system administrator on the Theme Management page.","operationId":"getThemeByRoleUsingGET","produces":["application/json"],"parameters":[{"name":"role","in":"path","description":"\"global\" or role name of currently set theme","required":true,"type":"string"}],"responses":{"200":{"description":"Reports the currently selected global theme (if there is one) and whether or not it's enabled.","schema":{"$ref":"#/definitions/ThemeConfig"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/themes/theme/{theme}":{"put":{"tags":["theme-api"],"summary":"Sets the current global theme to the one specified.","description":"Returns the updated serialized theme object.","operationId":"setGlobalThemeUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"enabled","in":"query","description":"enabled","required":false,"type":"boolean","default":true},{"name":"theme","in":"path","description":"The name of the theme to select.","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully updated the current global theme.","schema":{"$ref":"#/definitions/ThemeConfig"}},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to create or update this user."},"404":{"description":"Theme not found."},"500":{"description":"Unexpected error"}},"deprecated":false},"delete":{"tags":["theme-api"],"summary":"Deletes the theme with the specified name.","description":"Returns success on deletion. ","operationId":"deleteThemeUsingDELETE","produces":["application/json"],"parameters":[{"name":"theme","in":"path","description":"Name of the theme to delete","required":true,"type":"string"}],"responses":{"200":{"description":"Theme was successfully deleted.","schema":{"type":"string"}},"204":{"description":"No Content"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to delete a theme."},"404":{"description":"Theme not found."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/totalCounts/reset":{"get":{"tags":["total-counts-api"],"summary":"Gets an updated count of the data elements on the system.","operationId":"getUpdatedTotalCountsUsingGET","produces":["application/json"],"responses":{"200":{"description":"The current counts for the system.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users":{"get":{"tags":["users-api"],"summary":"Get list of users.","description":"The primary users function returns a list of all users of the XNAT system. This includes just the username and nothing else. You can retrieve a particular user by adding the username to the REST API URL or a list of users with abbreviated user profiles by calling /xapi/users/profiles.","operationId":"usersGetUsingGET","produces":["application/json"],"responses":{"200":{"description":"A list of usernames.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the list of usernames."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"post":{"tags":["users-api"],"summary":"Creates a new user from the request body.","description":"Returns the newly created user object.","operationId":"createUserUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"model","description":"model","required":true,"schema":{"$ref":"#/definitions/User"}}],"responses":{"201":{"description":"User successfully created.","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The submitted data was invalid."},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to update this user."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/active":{"get":{"tags":["users-api"],"summary":"Get list of active users.","description":"Returns a map of usernames for users that have at least one currently active session, i.e. logged in or associated with a valid application session. The number of active sessions and a list of the session IDs is associated with each user.","operationId":"getActiveUsersUsingGET","produces":["application/json"],"responses":{"200":{"description":"A list of active users.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the list of usernames."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/active/{username}":{"get":{"tags":["users-api"],"summary":"Get information about active sessions for the indicated user.","description":"Returns a map containing a list of session IDs and usernames for users that have at least one currently active session, i.e. logged in or associated with a valid application session. This also includes the number of active sessions for each user.","operationId":"getUserActiveSessionsUsingGET","produces":["application/json"],"parameters":[{"name":"username","in":"path","description":"ID of the user to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"A list of active users.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access this user's sessions."},"404":{"description":"The indicated user has no active sessions or is not a valid user."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["users-api"],"summary":"Invalidates all active sessions associated with the specified username.","description":"Returns a list of session IDs that were invalidated.","operationId":"invalidateUserUsingDELETE","produces":["application/json"],"parameters":[{"name":"creationTime","in":"query","required":false,"type":"integer","format":"int64"},{"name":"id","in":"query","required":false,"type":"string"},{"name":"lastAccessedTime","in":"query","required":false,"type":"integer","format":"int64"},{"name":"maxInactiveInterval","in":"query","required":false,"type":"integer","format":"int32"},{"name":"new","in":"query","required":false,"type":"boolean"},{"name":"servletContext.classLoader","in":"query","required":false,"type":"ref"},{"name":"servletContext.contextPath","in":"query","required":false,"type":"string"},{"name":"servletContext.defaultSessionTrackingModes","in":"query","required":false,"type":"array","items":{"type":"string","enum":["COOKIE","URL","SSL"]},"collectionFormat":"multi","enum":["COOKIE","URL","SSL"]},{"name":"servletContext.effectiveMajorVersion","in":"query","required":false,"type":"integer","format":"int32"},{"name":"servletContext.effectiveMinorVersion","in":"query","required":false,"type":"integer","format":"int32"},{"name":"servletContext.effectiveSessionTrackingModes","in":"query","required":false,"type":"array","items":{"type":"string","enum":["COOKIE","URL","SSL"]},"collectionFormat":"multi","enum":["COOKIE","URL","SSL"]},{"name":"servletContext.jspConfigDescriptor.jspPropertyGroups[0].buffer","in":"query","required":false,"type":"string"},{"name":"servletContext.jspConfigDescriptor.jspPropertyGroups[0].defaultContentType","in":"query","required":false,"type":"string"},{"name":"servletContext.jspConfigDescriptor.jspPropertyGroups[0].deferredSyntaxAllowedAsLiteral","in":"query","required":false,"type":"string"},{"name":"servletContext.jspConfigDescriptor.jspPropertyGroups[0].elIgnored","in":"query","required":false,"type":"string"},{"name":"servletContext.jspConfigDescriptor.jspPropertyGroups[0].errorOnUndeclaredNamespace","in":"query","required":false,"type":"string"},{"name":"servletContext.jspConfigDescriptor.jspPropertyGroups[0].includeCodas","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"servletContext.jspConfigDescriptor.jspPropertyGroups[0].includePreludes","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"servletContext.jspConfigDescriptor.jspPropertyGroups[0].isXml","in":"query","required":false,"type":"string"},{"name":"servletContext.jspConfigDescriptor.jspPropertyGroups[0].pageEncoding","in":"query","required":false,"type":"string"},{"name":"servletContext.jspConfigDescriptor.jspPropertyGroups[0].scriptingInvalid","in":"query","required":false,"type":"string"},{"name":"servletContext.jspConfigDescriptor.jspPropertyGroups[0].trimDirectiveWhitespaces","in":"query","required":false,"type":"string"},{"name":"servletContext.jspConfigDescriptor.jspPropertyGroups[0].urlPatterns","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"servletContext.jspConfigDescriptor.taglibs[0].taglibLocation","in":"query","required":false,"type":"string"},{"name":"servletContext.jspConfigDescriptor.taglibs[0].taglibURI","in":"query","required":false,"type":"string"},{"name":"servletContext.majorVersion","in":"query","required":false,"type":"integer","format":"int32"},{"name":"servletContext.minorVersion","in":"query","required":false,"type":"integer","format":"int32"},{"name":"servletContext.requestCharacterEncoding","in":"query","required":false,"type":"string"},{"name":"servletContext.responseCharacterEncoding","in":"query","required":false,"type":"string"},{"name":"servletContext.serverInfo","in":"query","required":false,"type":"string"},{"name":"servletContext.servletContextName","in":"query","required":false,"type":"string"},{"name":"servletContext.sessionCookieConfig.comment","in":"query","required":false,"type":"string"},{"name":"servletContext.sessionCookieConfig.domain","in":"query","required":false,"type":"string"},{"name":"servletContext.sessionCookieConfig.httpOnly","in":"query","required":false,"type":"boolean"},{"name":"servletContext.sessionCookieConfig.maxAge","in":"query","required":false,"type":"integer","format":"int32"},{"name":"servletContext.sessionCookieConfig.name","in":"query","required":false,"type":"string"},{"name":"servletContext.sessionCookieConfig.path","in":"query","required":false,"type":"string"},{"name":"servletContext.sessionCookieConfig.secure","in":"query","required":false,"type":"boolean"},{"name":"servletContext.sessionTimeout","in":"query","required":false,"type":"integer","format":"int32"},{"name":"servletContext.virtualServerName","in":"query","required":false,"type":"string"},{"name":"username","in":"path","description":"The username of the user to invalidate.","required":true,"type":"string"},{"name":"valueNames","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"User successfully invalidated.","schema":{"type":"array","items":{"type":"string"}}},"204":{"description":"No Content"},"304":{"description":"Indicated user has no active sessions, so no action was taken."},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to invalidate this user's sessions."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/authDetails/{username}":{"get":{"tags":["users-api"],"summary":"Get user auth details.","description":"The user authDetails function returns info about authentication methods that can be used for a given XNAT account.","operationId":"usersAuthDetailsGetUsingGET","produces":["application/json"],"parameters":[{"name":"username","in":"path","description":"ID of the user to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"User auth info.","schema":{"type":"array","items":{"$ref":"#/definitions/UserAuth"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the user profile."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/authProviders":{"get":{"tags":["users-api"],"summary":"Get configured auth providers.","description":"Returns info about authentication methods that have been configured","operationId":"getConfiguredAuthProvidersUsingGET","produces":["application/json"],"responses":{"200":{"description":"Auth provider info.","schema":{"type":"array","items":{"$ref":"#/definitions/XnatAuthenticationProviderApiPojo"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/changeRequest/{type}":{"delete":{"tags":["users-api"],"summary":"Cancels a change request.","operationId":"cancelChangeRequestUsingDELETE","produces":["application/json"],"parameters":[{"name":"type","in":"path","description":"Type of change request","required":true,"type":"string"}],"responses":{"200":{"description":"Change request canceled."},"204":{"description":"No Content"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/current":{"get":{"tags":["users-api"],"summary":"Get list of users who are enabled or who have interacted with the site somewhat recently.","description":"The users' profiles function returns a list of all users of the XNAT system with brief information about each.","operationId":"currentUsersProfilesGetUsingGET","produces":["application/json"],"responses":{"200":{"description":"A list of user profiles.","schema":{"type":"array","items":{"$ref":"#/definitions/User"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the list of usernames."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/profile":{"get":{"tags":["users-api"],"summary":"Get user profile.","description":"The user profile function returns the current user with brief information.","operationId":"usersProfileGetUsingGET_1","produces":["application/json"],"responses":{"200":{"description":"A user profile.","schema":{"$ref":"#/definitions/User"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the user profile."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/profile/{username}":{"get":{"tags":["users-api"],"summary":"Get user profile.","description":"The user profile function returns a user of the XNAT system with brief information.","operationId":"usersProfileGetUsingGET","produces":["application/json"],"parameters":[{"name":"username","in":"path","description":"ID of the user to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"A user profile.","schema":{"$ref":"#/definitions/User"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the user profile."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/profiles":{"get":{"tags":["users-api"],"summary":"Get list of user profiles.","description":"The users' profiles function returns a list of all users of the XNAT system with brief information about each.","operationId":"usersProfilesGetUsingGET","produces":["application/json"],"responses":{"200":{"description":"A list of user profiles.","schema":{"type":"array","items":{"$ref":"#/definitions/User"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"You do not have sufficient permissions to access the list of users."},"404":{"description":"Not Found"},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/projects":{"get":{"tags":["users-api"],"summary":"Returns list of projects that user has edit access.","description":"Returns list of projects that user has edit access.","operationId":"getProjectsByUserUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/users/rolemap":{"get":{"tags":["users-api"],"summary":"Returns all of the roles on the system, with a list of users assigned to each role.","description":"Users may appear in more than one role.","operationId":"getRolesAndUsersUsingGET","produces":["application/json"],"responses":{"200":{"description":"User roles successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to view this user."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/roles":{"get":{"tags":["users-api"],"summary":"Returns all of the roles on the system, with a list of users assigned to each role.","description":"Users may appear in more than one role.","operationId":"getRolesUsingGET","produces":["application/json"],"responses":{"200":{"description":"User roles successfully retrieved.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to view this user."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/roles/{role}":{"get":{"tags":["users-api"],"summary":"Returns the roles for the user with the specified user ID.","description":"Returns a collection of the user's roles.","operationId":"getUsersWithRoleUsingGET","produces":["application/json"],"parameters":[{"name":"role","in":"path","description":"The ID of the user to retrieve the roles for.","required":true,"type":"string"}],"responses":{"200":{"description":"User roles successfully retrieved.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to view this user."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/update":{"put":{"tags":["users-api"],"summary":"Update ones own user account.","operationId":"updateUsingPUT_4","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"model","description":"model","required":true,"schema":{"$ref":"#/definitions/User"}}],"responses":{"200":{"description":"User successfully updated.","schema":{"$ref":"#/definitions/User"}},"201":{"description":"Created"},"304":{"description":"The user object was not modified because no attributes were changed."},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to update this user."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/username":{"get":{"tags":["users-api"],"summary":"Returns username for signed-in user","operationId":"getUsernameUsingGET","produces":["text/plain"],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/users/{username}":{"get":{"tags":["users-api"],"summary":"Gets the user with the specified user ID.","description":"Returns the serialized user object with the specified user ID.","operationId":"getUserUsingGET","produces":["application/json"],"parameters":[{"name":"username","in":"path","description":"Username of the user to fetch.","required":true,"type":"string"}],"responses":{"200":{"description":"User successfully retrieved.","schema":{"$ref":"#/definitions/User"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to view this user."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["users-api"],"summary":"Updates the user object with the specified username.","description":"Returns the updated serialized user object with the specified username.","operationId":"updateUserUsingPUT","consumes":["application/json","multipart/form-data"],"produces":["application/json"],"parameters":[{"in":"body","name":"model","description":"model","required":true,"schema":{"$ref":"#/definitions/User"}},{"name":"username","in":"path","description":"The username of the user to create or update.","required":true,"type":"string"}],"responses":{"200":{"description":"User successfully updated.","schema":{"$ref":"#/definitions/User"}},"201":{"description":"Created"},"304":{"description":"The user object was not modified because no attributes were changed."},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to update this user."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/{username}/enabled":{"get":{"tags":["users-api"],"summary":"Returns whether the user with the specified user ID is enabled.","description":"Returns true or false based on whether the specified user is enabled or not.","operationId":"usersIdEnabledGetUsingGET","produces":["application/json"],"parameters":[{"name":"username","in":"path","description":"The ID of the user to retrieve the enabled status for.","required":true,"type":"string"}],"responses":{"200":{"description":"User enabled status successfully retrieved.","schema":{"type":"boolean"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get whether this user is enabled."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/{username}/enabled/{flag}":{"put":{"tags":["users-api"],"summary":"Sets the user's enabled state.","description":"Sets the enabled state of the user with the specified user ID to the value of the flag parameter.","operationId":"usersIdEnabledFlagPutUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"flag","in":"path","description":"The value to set for the enabled status.","required":true,"type":"boolean"},{"name":"username","in":"path","description":"ID of the user to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"User enabled status successfully set."},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to enable or disable this user."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/{username}/groups":{"get":{"tags":["users-api"],"summary":"Returns the groups for the user with the specified user ID.","description":"Returns a collection of the user's groups.","operationId":"usersIdGroupsGetUsingGET","produces":["application/json"],"parameters":[{"name":"username","in":"path","description":"The ID of the user to retrieve the groups for.","required":true,"type":"string"}],"responses":{"200":{"description":"User groups successfully retrieved.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get the groups for this user."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["users-api"],"summary":"Adds the user to one or more groups.","description":"Assigns the user to one or more new groups.","operationId":"usersIdAddGroupsUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"groups","description":"The groups to which the user should be added.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"username","in":"path","description":"ID of the user to add to the specified groups","required":true,"type":"string"}],"responses":{"200":{"description":"User successfully added for all specified groups.","schema":{"type":"array","items":{"type":"string"}}},"201":{"description":"Created"},"202":{"description":"User was successfully added to some of the specified groups, but some may have failed. Check the return value for groups that the service was unable to add.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to add this user to groups."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["users-api"],"summary":"Removes the user from one or more groups.","description":"Removes the user from one or more groups.","operationId":"usersIdRemoveGroupsUsingDELETE","produces":["application/json"],"parameters":[{"in":"body","name":"groups","description":"The groups from which the user should be removed.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"username","in":"path","description":"ID of the user to remove role from","required":true,"type":"string"}],"responses":{"200":{"description":"User successfully removed from all specified groups.","schema":{"type":"array","items":{"type":"string"}}},"202":{"description":"User was successfully removed from some of the specified groups, but some may have failed. Check the return value for groups that the service was unable to remove.","schema":{"type":"array","items":{"type":"string"}}},"204":{"description":"No Content"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to remove this user from groups."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/{username}/groups/{group}":{"put":{"tags":["users-api"],"summary":"Adds a user to a group.","description":"Assigns user to a group.","operationId":"usersIdAddGroupUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"group","in":"path","description":"The user's new group.","required":true,"type":"string"},{"name":"username","in":"path","description":"ID of the user to add to a group","required":true,"type":"string"}],"responses":{"200":{"description":"User successfully added to group."},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to assign this user to groups."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["users-api"],"summary":"Removes a user from a group.","description":"Removes a user from a group.","operationId":"usersIdRemoveGroupUsingDELETE","produces":["application/json"],"parameters":[{"name":"group","in":"path","description":"The group to remove the user from.","required":true,"type":"string"},{"name":"username","in":"path","description":"ID of the user to remove from group","required":true,"type":"string"}],"responses":{"200":{"description":"User's group successfully removed."},"204":{"description":"No Content"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to remove this user from groups."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/{username}/projects":{"get":{"tags":["users-api"],"summary":"Returns the projects to which the user belongs along with the user's role in the project.","operationId":"getUserProjectsUsingGET","produces":["application/json"],"parameters":[{"name":"username","in":"path","description":"The ID of the user to retrieve the projects for.","required":true,"type":"string"}],"responses":{"200":{"description":"User projects successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to get the projects for this user."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/{username}/roles":{"get":{"tags":["users-api"],"summary":"Returns the roles for the user with the specified user ID.","description":"Returns a collection of the user's roles.","operationId":"usersIdRolesGetUsingGET","produces":["application/json"],"parameters":[{"name":"username","in":"path","description":"The ID of the user to retrieve the roles for.","required":true,"type":"string"}],"responses":{"200":{"description":"User roles successfully retrieved.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to view this user."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"put":{"tags":["users-api"],"summary":"Adds one or more roles to a user.","description":"Assigns one or more new roles to a user.","operationId":"usersIdAddRolesUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"roles","description":"The user's new roles.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"username","in":"path","description":"ID of the user to add a role to","required":true,"type":"string"}],"responses":{"200":{"description":"All specified user roles successfully added.","schema":{"type":"array","items":{"type":"string"}}},"201":{"description":"Created"},"202":{"description":"Some user roles successfully added, but some may have failed. Check the return value for roles that the service was unable to add.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to add roles to this user."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["users-api"],"summary":"Removes one or more roles from a user.","description":"Removes one or more new roles from a user.","operationId":"usersIdRemoveRolesUsingDELETE","produces":["application/json"],"parameters":[{"in":"body","name":"roles","description":"The roles to be removed.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"username","in":"path","description":"ID of the user to remove role from","required":true,"type":"string"}],"responses":{"200":{"description":"All specified user roles successfully removed.","schema":{"type":"array","items":{"type":"string"}}},"202":{"description":"Some user roles successfully removed, but some may have failed. Check the return value for roles that the service was unable to remove.","schema":{"type":"array","items":{"type":"string"}}},"204":{"description":"No Content"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to remove roles from this user."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/{username}/roles/{role}":{"put":{"tags":["users-api"],"summary":"Adds a role to a user.","description":"Assigns a new role to a user.","operationId":"usersIdAddRoleUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"role","in":"path","description":"The user's new role.","required":true,"type":"string"},{"name":"username","in":"path","description":"ID of the user to add a role to","required":true,"type":"string"}],"responses":{"200":{"description":"User role successfully added."},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to add a role to this user."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false},"delete":{"tags":["users-api"],"summary":"Remove a user's role.","description":"Removes a user's role.","operationId":"usersIdRemoveRoleUsingDELETE","produces":["application/json"],"parameters":[{"name":"role","in":"path","description":"The user role to delete.","required":true,"type":"string"},{"name":"username","in":"path","description":"ID of the user to delete a role from","required":true,"type":"string"}],"responses":{"200":{"description":"User role successfully removed."},"204":{"description":"No Content"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to remove a role from this user."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/{username}/verified":{"get":{"tags":["users-api"],"summary":"Returns whether the user with the specified user ID is verified.","description":"Returns true or false based on whether the specified user is verified or not.","operationId":"usersIdVerifiedGetUsingGET","produces":["application/json"],"parameters":[{"name":"username","in":"path","description":"The ID of the user to retrieve the verified status for.","required":true,"type":"string"}],"responses":{"200":{"description":"User verified status successfully retrieved.","schema":{"type":"boolean"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to view this user."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/users/{username}/verified/{flag}":{"put":{"tags":["users-api"],"summary":"Sets the user's verified state.","description":"Sets the verified state of the user with the specified user ID to the value of the flag parameter.","operationId":"usersIdVerifiedFlagPutUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"flag","in":"path","description":"The value to set for the verified status.","required":true,"type":"boolean"},{"name":"username","in":"path","description":"ID of the user to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"User verified status successfully set."},"201":{"description":"Created"},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Not authorized to verify or un-verify this user."},"404":{"description":"User not found."},"500":{"description":"An unexpected error occurred."}},"deprecated":false}},"/xft/elements":{"get":{"tags":["xft-element-api"],"summary":"Get all meta element names","description":"Returns a list of all XFT element names from XFTMetaManager. By default excludes history and metadata elements.","operationId":"getMetaElementNamesUsingGET","produces":["application/json"],"parameters":[{"name":"showHistory","in":"query","description":"Include history elements (ending in _history)","required":false,"type":"boolean","default":false,"allowEmptyValue":false,"x-example":false},{"name":"showMeta","in":"query","description":"Include metadata elements (ending in _meta_data)","required":false,"type":"boolean","default":false,"allowEmptyValue":false,"x-example":false}],"responses":{"200":{"description":"Successfully retrieved element names","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal server error"}},"deprecated":false}},"/xft/references":{"get":{"tags":["xft-element-api"],"summary":"Get all XFT references","description":"Returns a list of all XFT references from XFTReferenceManager, including many-to-many and superior references.","operationId":"getAllXFTReferencesUsingGET","produces":["application/json"],"responses":{"200":{"description":"Successfully retrieved references","schema":{"type":"array","items":{"$ref":"#/definitions/Map«string,object»"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal server error"}},"deprecated":false}},"/xft/schemas":{"get":{"tags":["xft-element-api"],"summary":"Get all XFT schemas","description":"Returns a list of all XFT schemas loaded in memory. Excludes protected namespaces.","operationId":"getSchemasUsingGET","produces":["application/json"],"responses":{"200":{"description":"Successfully retrieved schemas","schema":{"type":"array","items":{"$ref":"#/definitions/Map«string,object»"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal server error"}},"deprecated":false}},"/xft/schemas/{prefix}/elements":{"get":{"tags":["xft-element-api"],"summary":"Get elements from a schema","description":"Returns all XFT elements for all schemas with the specified target namespace prefix. Multiple schemas can share the same prefix. Protected namespaces are not accessible. By default excludes history and metadata elements.","operationId":"getSchemaElementsUsingGET","produces":["application/json"],"parameters":[{"name":"prefix","in":"path","description":"Target namespace prefix of the schema","required":true,"type":"string"},{"name":"showHistory","in":"query","description":"Include history elements (ending in _history)","required":false,"type":"boolean","default":false,"allowEmptyValue":false,"x-example":false},{"name":"showMeta","in":"query","description":"Include metadata elements (ending in _meta_data)","required":false,"type":"boolean","default":false,"allowEmptyValue":false,"x-example":false}],"responses":{"200":{"description":"Successfully retrieved elements","schema":{"type":"array","items":{"$ref":"#/definitions/Map«string,object»"}}},"401":{"description":"Unauthorized"},"403":{"description":"Access to protected namespace is forbidden"},"404":{"description":"Schema not found"},"500":{"description":"Internal server error"}},"deprecated":false}},"/xft/schemas/{prefix}/elements/{elementName}":{"get":{"tags":["xft-element-api"],"summary":"Get a specific XFT element","description":"Returns detailed information about a specific XFT element including basic metadata. Searches across all schemas with the specified prefix. Protected namespaces are not accessible.","operationId":"getElementUsingGET","produces":["application/json"],"parameters":[{"name":"elementName","in":"path","description":"Name of the element","required":true,"type":"string"},{"name":"prefix","in":"path","description":"Target namespace prefix of the schema","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully retrieved element","schema":{"type":"object","additionalProperties":{"type":"object"}}},"401":{"description":"Unauthorized"},"403":{"description":"Access to protected namespace is forbidden"},"404":{"description":"Element not found"},"500":{"description":"Internal server error"}},"deprecated":false}},"/xft/schemas/{prefix}/elements/{elementName}/fields":{"get":{"tags":["xft-element-api"],"summary":"Get fields from an element","description":"Returns all fields (both data fields and reference fields) for a specific XFT element. Searches across all schemas with the specified prefix. Protected namespaces are not accessible.","operationId":"getElementFieldsUsingGET","produces":["application/json"],"parameters":[{"name":"elementName","in":"path","description":"Name of the element","required":true,"type":"string"},{"name":"prefix","in":"path","description":"Target namespace prefix of the schema","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully retrieved fields","schema":{"type":"array","items":{"$ref":"#/definitions/Map«string,object»"}}},"401":{"description":"Unauthorized"},"403":{"description":"Access to protected namespace is forbidden"},"404":{"description":"Element not found"},"500":{"description":"Internal server error"}},"deprecated":false}},"/xnatTask/checkNodeConfigurationStatus":{"get":{"tags":["xnat-task-api"],"summary":"Get node configuration status.","description":"Returns node configuration status for this installation.","operationId":"getNodeConfigurationStatusUsingGET","produces":["application/json"],"responses":{"200":{"description":"An array of properties","schema":{"type":"object","additionalProperties":{"type":"object"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/xnatTask/taskList":{"get":{"tags":["xnat-task-api"],"summary":"Get list of XnatTask classes.","description":"Returns a list of XnatTask properties","operationId":"getTaskListUsingGET","produces":["application/json"],"responses":{"200":{"description":"An array of properties","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Unexpected error"}},"deprecated":false}},"/{namespace}/{schema}":{"get":{"tags":["schema-only-api"],"summary":"Returns the requested XNAT data-type schema.","description":"XNAT data-type schemas are most often stored on the classpath in the folder schemas/SCHEMA/SCHEMA.xsd, but sometimes the folder name differs from the schema name. This function returns the schema named SCHEMA.xsd in the folder named NAMESPACE. This tells you nothing about whether the data types defined in the schemas are active or configured.","operationId":"getRequestedDataTypeSchemaUsingGET_2","produces":["application/xml"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"type":"string"},{"name":"schema","in":"path","description":"schema","required":true,"type":"string"}],"responses":{"200":{"description":"XNAT data-type schemas successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource wasn't found."},"500":{"description":"Unexpected error"}},"deprecated":false}},"/{schema}":{"get":{"tags":["schema-only-api"],"summary":"Returns the requested XNAT data-type schema.","description":"XNAT data-type schemas are most often stored on the classpath in the folder schemas/SCHEMA/SCHEMA.xsd. This function returns the schema named SCHEMA.xsd in the folder named SCHEMA. You can use the function that allows you to specify the namespace as well if the folder name differs from the schema name. This tells you nothing about whether the data types defined in the schemas are active or configured.","operationId":"getRequestedDataTypeSchemaUsingGET_3","produces":["application/xml"],"parameters":[{"name":"schema","in":"path","description":"schema","required":true,"type":"string"}],"responses":{"200":{"description":"XNAT data-type schemas successfully retrieved.","schema":{"type":"string"}},"401":{"description":"Must be authenticated to access the XNAT REST API."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource wasn't found."},"500":{"description":"Unexpected error"}},"deprecated":false}}},"definitions":{"Action":{"type":"object","properties":{"action-key":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"$ref":"#/definitions/ActionAttributeConfiguration"}},"description":{"type":"string"},"display-name":{"type":"string"}},"title":"Action"},"ActionAttributeConfiguration":{"type":"object","properties":{"default-value":{"type":"string"},"description":{"type":"string"},"required":{"type":"boolean"},"restrict-to-list":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/AttributeContextValue"}}},"type":{"type":"string"},"user-settable":{"type":"boolean"}},"title":"ActionAttributeConfiguration"},"Administration":{"type":"object","properties":{"duration":{"type":"string"},"endTime":{"type":"string"},"flowRate":{"type":"string"},"startTime":{"type":"string"},"totalDose":{"type":"string"},"volume":{"type":"string"}},"title":"Administration"},"AppenderHierarchy":{"type":"object","properties":{"loggers":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"path":{"type":"string"}},"title":"AppenderHierarchy"},"ArchiveProcessorInstance":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"disabled":{"type":"string","format":"date-time"},"enabled":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"label":{"type":"string"},"location":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"priority":{"type":"integer","format":"int32"},"processorClass":{"type":"string"},"projectIdsList":{"type":"array","items":{"type":"string"}},"scope":{"type":"string"},"scpBlacklist":{"type":"array","items":{"type":"string"}},"scpWhitelist":{"type":"array","items":{"type":"string"}},"timestamp":{"type":"string","format":"date-time"}},"title":"ArchiveProcessorInstance"},"ArchiveProcessorInstanceSummary":{"type":"object","properties":{"label":{"type":"string"},"location":{"type":"string"},"priority":{"type":"integer","format":"int32"},"processorClass":{"type":"string"}},"title":"ArchiveProcessorInstanceSummary"},"AttributeContextValue":{"type":"object","properties":{"label":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"title":"AttributeContextValue"},"CacheEntryEventFilter«object,object»":{"type":"object","title":"CacheEntryEventFilter«object,object»"},"CacheEntryListenerConfiguration«object,object»":{"type":"object","properties":{"cacheEntryEventFilterFactory":{"$ref":"#/definitions/Factory«CacheEntryEventFilter«object,object»»"},"cacheEntryListenerFactory":{"$ref":"#/definitions/Factory«CacheEntryListener«object,object»»"},"oldValueRequired":{"type":"boolean"},"synchronous":{"type":"boolean"}},"title":"CacheEntryListenerConfiguration«object,object»"},"CacheEntryListener«object,object»":{"type":"object","title":"CacheEntryListener«object,object»"},"CacheLoader«object,object»":{"type":"object","title":"CacheLoader«object,object»"},"CacheWriter«object,object»":{"type":"object","title":"CacheWriter«object,object»"},"CatCatalogBean":{"type":"object","properties":{"allFields":{"type":"array","items":{"type":"object"}},"catCatalogId":{"type":"integer","format":"int32"},"description":{"type":"string"},"entries_entry":{"type":"array","items":{"$ref":"#/definitions/CatEntryI"}},"fullSchemaElementName":{"type":"string"},"headerString":{"type":"string"},"id":{"type":"string"},"metafields_metafield":{"type":"array","items":{"$ref":"#/definitions/CatCatalogMetafieldI"}},"name":{"type":"string"},"schemaElementName":{"type":"string"},"sets_entryset":{"type":"array","items":{"$ref":"#/definitions/CatCatalogI"}},"tags_tag":{"type":"array","items":{"$ref":"#/definitions/CatCatalogTagI"}},"xsitype":{"type":"string"}},"title":"CatCatalogBean"},"CatCatalogI":{"type":"object","properties":{"catCatalogId":{"type":"integer","format":"int32"},"description":{"type":"string"},"entries_entry":{"type":"array","items":{"$ref":"#/definitions/CatEntryI"}},"id":{"type":"string"},"metafields_metafield":{"type":"array","items":{"$ref":"#/definitions/CatCatalogMetafieldI"}},"name":{"type":"string"},"sets_entryset":{"type":"array","items":{"$ref":"#/definitions/CatCatalogI"}},"tags_tag":{"type":"array","items":{"$ref":"#/definitions/CatCatalogTagI"}},"xsitype":{"type":"string"}},"title":"CatCatalogI"},"CatCatalogMetafieldI":{"type":"object","properties":{"catCatalogMetafieldId":{"type":"integer","format":"int32"},"metafield":{"type":"string"},"name":{"type":"string"},"xsitype":{"type":"string"}},"title":"CatCatalogMetafieldI"},"CatCatalogTagI":{"type":"object","properties":{"catCatalogTagId":{"type":"integer","format":"int32"},"tag":{"type":"string"},"xsitype":{"type":"string"}},"title":"CatCatalogTagI"},"CatEntryI":{"type":"object","properties":{"cachepath":{"type":"string"},"catEntryId":{"type":"integer","format":"int32"},"content":{"type":"string"},"createdby":{"type":"string"},"createdeventid":{"type":"integer","format":"int32"},"createdtime":{"type":"object"},"description":{"type":"string"},"digest":{"type":"string"},"format":{"type":"string"},"id":{"type":"string"},"metafields_metafield":{"type":"array","items":{"$ref":"#/definitions/CatEntryMetafieldI"}},"modifiedby":{"type":"string"},"modifiedeventid":{"type":"integer","format":"int32"},"modifiedtime":{"type":"object"},"name":{"type":"string"},"tags_tag":{"type":"array","items":{"$ref":"#/definitions/CatEntryTagI"}},"uri":{"type":"string"},"xsitype":{"type":"string"}},"title":"CatEntryI"},"CatEntryMetafieldI":{"type":"object","properties":{"catEntryMetafieldId":{"type":"integer","format":"int32"},"metafield":{"type":"string"},"name":{"type":"string"},"xsitype":{"type":"string"}},"title":"CatEntryMetafieldI"},"CatEntryTagI":{"type":"object","properties":{"catEntryTagId":{"type":"integer","format":"int32"},"tag":{"type":"string"},"xsitype":{"type":"string"}},"title":"CatEntryTagI"},"CollatedLegacyCustomVariable":{"type":"object","properties":{"dataType":{"type":"string"},"description":{"type":"string"},"fieldDefinitionGroupId":{"type":"integer","format":"int32"},"id":{"type":"string"},"projectIds":{"type":"array","items":{"type":"string"}},"project_specific":{"type":"integer","format":"int32"},"shareable":{"type":"integer","format":"int32"}},"title":"CollatedLegacyCustomVariable"},"CompleteConfiguration":{"type":"object","properties":{"cacheEntryListenerConfigurations":{"$ref":"#/definitions/Iterable«CacheEntryListenerConfiguration«object,object»»"},"cacheLoaderFactory":{"$ref":"#/definitions/Factory«CacheLoader«object,object»»"},"cacheWriterFactory":{"$ref":"#/definitions/Factory«CacheWriter«object,object»»"},"expiryPolicyFactory":{"$ref":"#/definitions/Factory«ExpiryPolicy»"},"managementEnabled":{"type":"boolean"},"readThrough":{"type":"boolean"},"statisticsEnabled":{"type":"boolean"},"storeByValue":{"type":"boolean"},"writeThrough":{"type":"boolean"}},"title":"CompleteConfiguration"},"CompleteConfiguration«object,object»":{"type":"object","properties":{"cacheEntryListenerConfigurations":{"$ref":"#/definitions/Iterable«CacheEntryListenerConfiguration«object,object»»"},"cacheLoaderFactory":{"$ref":"#/definitions/Factory«CacheLoader«object,object»»"},"cacheWriterFactory":{"$ref":"#/definitions/Factory«CacheWriter«object,object»»"},"expiryPolicyFactory":{"$ref":"#/definitions/Factory«ExpiryPolicy»"},"managementEnabled":{"type":"boolean"},"readThrough":{"type":"boolean"},"statisticsEnabled":{"type":"boolean"},"storeByValue":{"type":"boolean"},"writeThrough":{"type":"boolean"}},"title":"CompleteConfiguration«object,object»"},"ComputeEnvironment":{"type":"object","properties":{"name":{"type":"string"},"image":{"type":"string"},"command":{"type":"string"},"environmentVariables":{"type":"array","items":{"$ref":"#/definitions/EnvironmentVariable"}},"mounts":{"type":"array","items":{"$ref":"#/definitions/Mount"}}},"title":"ComputeEnvironment"},"ComputeEnvironmentConfig":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"configTypes":{"type":"array","items":{"type":"string","enum":["JUPYTERHUB","CONTAINER_SERVICE","GENERAL"]}},"computeEnvironment":{"$ref":"#/definitions/ComputeEnvironment"},"scopes":{"type":"object","additionalProperties":{"$ref":"#/definitions/ComputeEnvironmentScope"}},"hardwareOptions":{"$ref":"#/definitions/ComputeEnvironmentHardwareOptions"}},"title":"ComputeEnvironmentConfig"},"ComputeEnvironmentHardwareOptions":{"type":"object","properties":{"allowAllHardware":{"type":"boolean"},"hardwareConfigs":{"type":"array","items":{"$ref":"#/definitions/HardwareConfig"}}},"title":"ComputeEnvironmentHardwareOptions"},"ComputeEnvironmentScope":{"type":"object","properties":{"enabled":{"type":"boolean"},"ids":{"type":"array","items":{"type":"string"}},"scope":{"type":"string","enum":["Site","Project","Subject","Experiment","User","DataType"]}},"title":"ComputeEnvironmentScope"},"Constraint":{"type":"object","properties":{"key":{"type":"string"},"operator":{"type":"string","enum":["IN","NOT_IN"]},"values":{"type":"array","items":{"type":"string"}}},"title":"Constraint"},"ConstraintConfig":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"constraint":{"$ref":"#/definitions/Constraint"},"scopes":{"type":"object","additionalProperties":{"$ref":"#/definitions/ConstraintScope"}}},"title":"ConstraintConfig"},"ConstraintScope":{"type":"object","properties":{"enabled":{"type":"boolean"},"ids":{"type":"array","items":{"type":"string"}},"scope":{"type":"string","enum":["Site","Project","Subject","Experiment","User","DataType"]}},"title":"ConstraintScope"},"ContrastBolus":{"type":"object","properties":{"administrations":{"type":"array","items":{"$ref":"#/definitions/Administration"}},"agent":{"type":"string"},"agentNumber":{"type":"string"},"concentration":{"type":"string"},"ingredientOpaque":{"type":"string"},"ingredients":{"type":"array","items":{"$ref":"#/definitions/Ingredient"}},"percentageByVolume":{"type":"string"},"pk":{"type":"integer","format":"int32"},"route":{"type":"string"},"scanId":{"type":"integer","format":"int32"},"t1Relaxivity":{"type":"string"},"t2Relaxivity":{"type":"string"}},"title":"ContrastBolus"},"DicomInboxImportRequest":{"type":"object","properties":{"cleanupAfterImport":{"type":"boolean"},"created":{"type":"string","format":"date-time"},"disabled":{"type":"string","format":"date-time"},"enabled":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"objectParametersMap":{"type":"object"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"resolution":{"type":"string"},"sessionPath":{"type":"string"},"status":{"type":"string","enum":["Queued","Trawling","Importing","Accepted","Processed","Failed","Completed"]},"timestamp":{"type":"string","format":"date-time"},"username":{"type":"string"}},"title":"DicomInboxImportRequest"},"DicomMapping":{"type":"object","properties":{"dicomTag":{"type":"string"},"fieldName":{"type":"string"},"fieldType":{"type":"string","enum":["string","integer","float","boolean","date","time"]},"id":{"type":"integer","format":"int64"},"schemaElement":{"type":"string"},"scope":{"type":"string","enum":["Site","Project","Subject","Experiment","User","DataType"]},"scopeObjectId":{"type":"string"}},"title":"DicomMapping"},"DicomSCPInstance":{"type":"object","properties":{"aeTitle":{"type":"string"},"anonymizationEnabled":{"type":"boolean"},"created":{"type":"string","format":"date-time"},"customProcessing":{"type":"boolean"},"directArchive":{"type":"boolean"},"directArchiveOverwrite":{"type":"boolean"},"disabled":{"type":"string","format":"date-time"},"enabled":{"type":"boolean"},"fileNamer":{"type":"string"},"id":{"type":"integer","format":"int64"},"identifier":{"type":"string"},"label":{"type":"string"},"port":{"type":"integer","format":"int32"},"projectRoutingExpression":{"type":"string"},"routingExpressionsEnabled":{"type":"boolean"},"sessionRoutingExpression":{"type":"string"},"subjectRoutingExpression":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"whitelist":{"type":"array","items":{"type":"string"}},"whitelistEnabled":{"type":"boolean"}},"title":"DicomSCPInstance"},"DirectArchiveSessionPaginatedRequest":{"type":"object","properties":{"defaultSortColumn":{"type":"string"},"filters":{"type":"object","additionalProperties":{"$ref":"#/definitions/Filter"}},"id":{"type":"string"},"offset":{"type":"integer","format":"int32"},"order":{"$ref":"#/definitions/Pair«string,string»"},"page":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"sortBys":{"type":"array","items":{"$ref":"#/definitions/Pair«string,string»"}},"sort_col":{"type":"string"},"sort_dir":{"type":"string","enum":["desc","asc"]}},"title":"DirectArchiveSessionPaginatedRequest"},"DisplayFieldDB":{"type":"object","properties":{"content":{"type":"object","additionalProperties":{"type":"string"}},"created":{"type":"string","format":"date-time"},"dataType":{"type":"string"},"description":{"type":"string"},"disabled":{"type":"string","format":"date-time"},"elements":{"type":"array","items":{"$ref":"#/definitions/DisplayFieldElementDB"}},"enabled":{"type":"boolean"},"fieldId":{"type":"string"},"header":{"type":"string"},"htmlCellAlign":{"type":"string"},"htmlCellHeight":{"type":"integer","format":"int32"},"htmlCellServerLink":{"type":"string"},"htmlCellValign":{"type":"string"},"htmlCellWidth":{"type":"integer","format":"int32"},"htmlContent":{"type":"boolean"},"htmlImage":{"type":"boolean"},"htmlImageHeight":{"type":"integer","format":"int32"},"htmlImageWidth":{"type":"integer","format":"int32"},"htmlLinkProperties":{"type":"array","items":{"$ref":"#/definitions/DisplayFieldHtmlLinkPropertyDB"}},"htmlLinkSecureLinkTo":{"type":"string"},"htmlLinkSecureProps":{"type":"object","additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int64"},"image":{"type":"boolean"},"mappingColumns":{"type":"array","items":{"$ref":"#/definitions/SubQueryMappingColumnDB"}},"possibleValues":{"type":"array","items":{"type":"string"}},"searchable":{"type":"boolean"},"sortBy":{"type":"string"},"sortIndex":{"type":"integer","format":"int32"},"sortOrder":{"type":"string"},"subQuery":{"type":"string"},"subQueryValue":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"visible":{"type":"boolean"}},"title":"DisplayFieldDB"},"DisplayFieldElementDB":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"disabled":{"type":"string","format":"date-time"},"enabled":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"schemaElementName":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"viewColumn":{"type":"string"},"viewName":{"type":"string"},"xdatType":{"type":"string"}},"title":"DisplayFieldElementDB"},"DisplayFieldHtmlLinkPropertyDB":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"disabled":{"type":"string","format":"date-time"},"enabled":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"insertedValues":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"value":{"type":"string"}},"title":"DisplayFieldHtmlLinkPropertyDB"},"DisplayFieldRefDB":{"type":"object","properties":{"elementName":{"type":"string"},"fieldId":{"type":"string"},"header":{"type":"string"},"id":{"type":"integer","format":"int64"},"sortOrder":{"type":"integer","format":"int32"},"type":{"type":"string"},"value":{"type":"string"},"visible":{"type":"boolean"}},"title":"DisplayFieldRefDB"},"DisplayVersionDB":{"type":"object","properties":{"allowDiffs":{"type":"boolean"},"briefDescription":{"type":"string"},"created":{"type":"string","format":"date-time"},"darkColor":{"type":"string"},"defaultOrderBy":{"type":"string"},"defaultSortOrder":{"type":"string"},"disabled":{"type":"string","format":"date-time"},"enabled":{"type":"boolean"},"fields":{"type":"array","items":{"$ref":"#/definitions/DisplayFieldRefDB"}},"htmlCellAlign":{"type":"string"},"htmlCellHeight":{"type":"integer","format":"int32"},"htmlCellServerLink":{"type":"string"},"htmlCellValign":{"type":"string"},"htmlCellWidth":{"type":"integer","format":"int32"},"id":{"type":"integer","format":"int64"},"lightColor":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"versionName":{"type":"string"}},"title":"DisplayVersionDB"},"Duration":{"type":"object","properties":{"durationAmount":{"type":"integer","format":"int64"},"eternal":{"type":"boolean"},"timeUnit":{"type":"string","enum":["NANOSECONDS","MICROSECONDS","MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS"]},"zero":{"type":"boolean"}},"title":"Duration"},"ElementDisplayArc":{"type":"object","properties":{"commonFields":{"type":"object","additionalProperties":{"type":"string"}},"created":{"type":"string","format":"date-time"},"disabled":{"type":"string","format":"date-time"},"enabled":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"timestamp":{"type":"string","format":"date-time"}},"title":"ElementDisplayArc"},"ElementDisplayDB":{"type":"object","properties":{"arcs":{"type":"array","items":{"$ref":"#/definitions/ElementDisplayArc"}},"briefDescription":{"type":"string"},"created":{"type":"string","format":"date-time"},"darkColor":{"type":"string"},"disabled":{"type":"string","format":"date-time"},"displayField":{"type":"string"},"displayFields":{"type":"array","items":{"$ref":"#/definitions/DisplayFieldDB"}},"displayLabel":{"type":"string"},"displayVersions":{"type":"array","items":{"$ref":"#/definitions/DisplayVersionDB"}},"elementName":{"type":"string"},"enabled":{"type":"boolean"},"fullDescription":{"type":"string"},"id":{"type":"integer","format":"int64"},"lightColor":{"type":"string"},"sortOrder":{"type":"integer","format":"int32"},"timestamp":{"type":"string","format":"date-time"},"valueField":{"type":"string"},"viewLinks":{"type":"array","items":{"$ref":"#/definitions/ElementDisplayViewLinkDB"}}},"title":"ElementDisplayDB"},"ElementDisplayModel":{"type":"object","properties":{"actions":{"type":"object","additionalProperties":{"type":"string"}},"elementName":{"type":"string"},"experiment":{"type":"boolean"},"imageAssessor":{"type":"boolean"},"imageScan":{"type":"boolean"},"imageSession":{"type":"boolean"},"plural":{"type":"string"},"properName":{"type":"string"},"singular":{"type":"string"},"subjectAssessor":{"type":"boolean"},"supportsBrief":{"type":"boolean"},"supportsDetailed":{"type":"boolean"},"xsDescription":{"type":"string"}},"title":"ElementDisplayModel","description":"Contains the properties that define an element display model on the system."},"ElementDisplayViewLinkDB":{"type":"object","properties":{"alias":{"type":"string"},"columns":{"type":"array","items":{"$ref":"#/definitions/ElementDisplayViewLinkMappingColumnDB"}},"created":{"type":"string","format":"date-time"},"disabled":{"type":"string","format":"date-time"},"enabled":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"timestamp":{"type":"string","format":"date-time"},"view":{"type":"string"}},"title":"ElementDisplayViewLinkDB"},"ElementDisplayViewLinkMappingColumnDB":{"type":"object","properties":{"fieldElementXMLPath":{"type":"string"},"id":{"type":"integer","format":"int64"},"mapsTo":{"type":"string"},"rootElement":{"type":"string"}},"title":"ElementDisplayViewLinkMappingColumnDB"},"EnvironmentVariable":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"EnvironmentVariable"},"EventClassInfo":{"type":"object","properties":{"class":{"type":"string","description":"Event class name (Should implement AutomationEventImplementerI"},"description":{"type":"string","description":"Description"},"displayName":{"type":"string","description":"Display Name"},"eventIds":{"type":"array","description":"List of event IDs.","items":{"type":"string"}},"filterableFields":{"type":"object","description":"Map of Filterable fields.","additionalProperties":{"$ref":"#/definitions/EventHandlerFilterInfo"}},"includeEventIdsFromDatabase":{"type":"boolean"}},"title":"EventClassInfo","description":"Event class names and filterable fields."},"EventFilter":{"type":"object","properties":{"event-type":{"type":"string"},"filter-nodes":{"type":"object","additionalProperties":{"$ref":"#/definitions/JsonPathFilterNode"}},"name":{"type":"string"},"payload-filter":{"type":"string"},"project-ids":{"type":"array","items":{"type":"string"}},"reactorCriteriaHash":{"type":"integer","format":"int32"},"schedule":{"type":"string"},"schedule-description":{"type":"string"},"status":{"type":"string"}},"title":"EventFilter"},"EventFilterCreator":{"type":"object","properties":{"name":{"type":"string"},"event-type":{"type":"string"},"project-ids":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"schedule":{"type":"string"},"schedule-description":{"type":"string"},"payload-filter":{"type":"string"},"filter-nodes":{"type":"object","additionalProperties":{"$ref":"#/definitions/JsonPathFilterNode"}}},"title":"EventFilterCreator"},"EventFilterUpdate":{"type":"object","properties":{"name":{"type":"string"},"event-type":{"type":"string"},"project-ids":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"schedule":{"type":"string"},"schedule-description":{"type":"string"},"payload-filter":{"type":"string"},"filter-nodes":{"type":"object","additionalProperties":{"$ref":"#/definitions/JsonPathFilterNode"}}},"title":"EventFilterUpdate"},"EventFilters":{"type":"object","properties":{"filterVals":{"type":"array","items":{"type":"string"}},"filterVar":{"type":"string"},"id":{"type":"integer","format":"int64"}},"title":"EventFilters"},"EventHandlerFilterInfo":{"type":"object","properties":{"defaultValue":{"type":"string","description":"Default selected value for event filter values"},"filterRequired":{"type":"boolean","description":"Filter Required?"},"filterValues":{"type":"array","description":"Filter Values","items":{"type":"string"}},"includeValuesFromDatabase":{"type":"boolean","description":"Include Values From Database?"}},"title":"EventHandlerFilterInfo","description":"Event class names and filterable fields."},"EventPropertyNode":{"type":"object","properties":{"name":{"type":"string"},"replacement-key":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"title":"EventPropertyNode"},"EventServicePrefs":{"type":"object","properties":{"enabled":{"type":"boolean"}},"title":"EventServicePrefs"},"EventTrackingDataPojo":{"type":"object","properties":{"finalMessage":{"type":"string"},"key":{"type":"string"},"payload":{"type":"string"},"succeeded":{"type":"boolean"}},"title":"EventTrackingDataPojo"},"ExpiryPolicy":{"type":"object","properties":{"expiryForAccess":{"$ref":"#/definitions/Duration"},"expiryForCreation":{"$ref":"#/definitions/Duration"},"expiryForUpdate":{"$ref":"#/definitions/Duration"}},"title":"ExpiryPolicy"},"Factory«CacheEntryEventFilter«object,object»»":{"type":"object","title":"Factory«CacheEntryEventFilter«object,object»»"},"Factory«CacheEntryListener«object,object»»":{"type":"object","title":"Factory«CacheEntryListener«object,object»»"},"Factory«CacheLoader«object,object»»":{"type":"object","title":"Factory«CacheLoader«object,object»»"},"Factory«CacheWriter«object,object»»":{"type":"object","title":"Factory«CacheWriter«object,object»»"},"Factory«ExpiryPolicy»":{"type":"object","title":"Factory«ExpiryPolicy»"},"File":{"type":"object","properties":{"absolute":{"type":"boolean"},"absoluteFile":{"$ref":"#/definitions/File"},"absolutePath":{"type":"string"},"canonicalFile":{"$ref":"#/definitions/File"},"canonicalPath":{"type":"string"},"directory":{"type":"boolean"},"file":{"type":"boolean"},"freeSpace":{"type":"integer","format":"int64"},"hidden":{"type":"boolean"},"name":{"type":"string"},"parent":{"type":"string"},"parentFile":{"$ref":"#/definitions/File"},"path":{"type":"string"},"totalSpace":{"type":"integer","format":"int64"},"usableSpace":{"type":"integer","format":"int64"}},"title":"File"},"FileStore":{"type":"object","properties":{"blockSize":{"type":"integer","format":"int64"},"readOnly":{"type":"boolean"},"totalSpace":{"type":"integer","format":"int64"},"unallocatedSpace":{"type":"integer","format":"int64"},"usableSpace":{"type":"integer","format":"int64"}},"title":"FileStore"},"FileSystem":{"type":"object","properties":{"fileStores":{"$ref":"#/definitions/Iterable«FileStore»"},"open":{"type":"boolean"},"readOnly":{"type":"boolean"},"rootDirectories":{"$ref":"#/definitions/Iterable«Path»"},"separator":{"type":"string"},"userPrincipalLookupService":{"$ref":"#/definitions/UserPrincipalLookupService"}},"title":"FileSystem"},"Filter":{"type":"object","discriminator":"backend","title":"Filter"},"FormAppliesToPoJo":{"type":"object","properties":{"entityId":{"type":"string"},"idCustomVariableFormAppliesTo":{"type":"string"},"status":{"type":"string"}},"title":"FormAppliesToPoJo"},"GenericResource":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"title":"GenericResource"},"GenericWrapperElement":{"type":"object","properties":{"abstract":{"type":"boolean"},"addIns":{"type":"array","items":{"$ref":"#/definitions/XFTFieldWrapper"}},"addin":{"type":"string"},"alias":{"type":"string"},"allFieldIDs":{"type":"object","additionalProperties":{"type":"object"}},"allFieldNames":{"type":"array","items":{"type":"array","items":{"type":"object"}}},"allFields":{"type":"array","items":{"type":"object"}},"allPossibleXMLFieldNames":{"type":"object","additionalProperties":{"type":"object"}},"allPrimaryKeys":{"type":"array","items":{"$ref":"#/definitions/GenericWrapperField"}},"anoChildElement":{"type":"boolean"},"autoActivate":{"type":"boolean"},"autoIncrement":{"type":"boolean"},"baseClass":{"type":"string"},"basePeer":{"type":"string"},"dbName":{"type":"string"},"defaultKey":{"$ref":"#/definitions/XFTFieldWrapper"},"dependencies":{"type":"array","items":{"type":"object"}},"directFields":{"type":"array","items":{"$ref":"#/definitions/GenericWrapperField"}},"directFieldsNoFilter":{"type":"array","items":{"$ref":"#/definitions/XFTFieldWrapper"}},"directXMLName":{"type":"string"},"displayIdentifiers":{"type":"array","items":{"type":"string"}},"extended":{"type":"boolean"},"extendedElement":{"$ref":"#/definitions/GenericWrapperElement"},"extendedElements":{"type":"array","items":{"type":"array","items":{"type":"object"}}},"extendedXSITypes":{"type":"array","items":{"type":"string"}},"extension":{"type":"boolean"},"extensionField":{"$ref":"#/definitions/GenericWrapperField"},"extensionFieldName":{"type":"string"},"extensionType":{"$ref":"#/definitions/XMLType"},"factory":{"$ref":"#/definitions/XFTFactoryI"},"filter":{"type":"string"},"filterField":{"type":"string"},"formattedName":{"type":"string"},"fullXMLName":{"type":"string"},"genericXFTElement":{"$ref":"#/definitions/GenericWrapperElement"},"hiddenSuperiorElements":{"type":"array","items":{"type":"object"}},"hiddenSuperiorReferences":{"type":"array","items":{"$ref":"#/definitions/XFTSuperiorReference"}},"idMethod":{"type":"string"},"javaname":{"type":"string"},"localXMLName":{"type":"string"},"manyToManyReferences":{"type":"array","items":{"$ref":"#/definitions/XFTManyToManyReference"}},"metaDataField":{"$ref":"#/definitions/GenericWrapperField"},"metaDataFieldName":{"type":"string"},"metaFields":{"$ref":"#/definitions/MetaFieldCollection"},"multiReferenceFields":{"type":"array","items":{"type":"object"}},"multiViewName":{"type":"string"},"name":{"type":"string"},"nonMultipleFields":{"type":"array","items":{"type":"object"}},"pkNames":{"type":"array","items":{"type":"string"}},"possibleExtenders":{"type":"array","items":{"$ref":"#/definitions/SchemaElementI"}},"preLoad":{"type":"boolean"},"properName":{"type":"string"},"quarantine":{"type":"boolean"},"referenceFieldsWAddIns":{"type":"array","items":{"type":"object"}},"referencedElements":{"type":"array","items":{"type":"object"}},"relationFields":{"type":"array","items":{"type":"object"}},"rules":{"type":"array","items":{"type":"object"}},"schema":{"$ref":"#/definitions/XFTSchema"},"schemaTargetNamespacePrefix":{"type":"string"},"schemaTargetNamespaceURI":{"type":"string"},"sequenceName":{"type":"string"},"singleViewName":{"type":"string"},"skipSQL":{"type":"boolean"},"sqlkeys":{"type":"array","items":{"type":"array","items":{"type":"object"}}},"sqlname":{"type":"string"},"statedPrimaryKeyFields":{"type":"array","items":{"type":"object"}},"subordinateReferences":{"type":"array","items":{"$ref":"#/definitions/XFTSuperiorReference"}},"superiorReferences":{"type":"array","items":{"$ref":"#/definitions/XFTSuperiorReference"}},"textFunctionName":{"type":"string"},"type":{"$ref":"#/definitions/XMLType"},"typeCode":{"type":"string"},"undefinedReferences":{"type":"array","items":{"$ref":"#/definitions/GenericWrapperField"}},"uniqueCompositeFields":{"type":"object","additionalProperties":{"type":"object"}},"uniqueFields":{"type":"array","items":{"type":"object"}},"uniqueIdentifierPrimaryKeyFields":{"type":"array","items":{"type":"object"}},"wrapped":{"$ref":"#/definitions/XFTElement"},"xmljavaNameValue":{"type":"string"},"xmlname":{"type":"string"},"xmlsqlNameValue":{"type":"string"},"xsitype":{"type":"string"}},"title":"GenericWrapperElement"},"GenericWrapperField":{"type":"object","properties":{"adjustedSize":{"type":"string"},"allFields":{"type":"array","items":{"type":"object"}},"allPossibleXMLFieldNames":{"type":"object","additionalProperties":{"type":"object"}},"attribute":{"type":"boolean"},"autoIncrement":{"type":"string"},"baseCol":{"type":"string"},"baseElement":{"type":"string"},"booleanField":{"type":"boolean"},"childXMLNode":{"type":"boolean"},"createdChild":{"type":"boolean"},"defaultValue":{"type":"string"},"directFields":{"type":"array","items":{"type":"object"}},"directFieldsNoFilter":{"type":"array","items":{"type":"object"}},"duplicateRelationships":{"type":"array","items":{"type":"object"}},"expose":{"type":"boolean"},"extension":{"type":"boolean"},"factory":{"$ref":"#/definitions/XFTFactoryI"},"filter":{"type":"boolean"},"foreignCol":{"type":"string"},"foreignKeyTable":{"type":"string"},"genericXFTField":{"$ref":"#/definitions/GenericWrapperField"},"hidden":{"type":"boolean"},"id":{"type":"string"},"inLineRepeaterElement":{"type":"boolean"},"javaname":{"type":"string"},"leafNode":{"type":"boolean"},"localRefNames":{"type":"array","items":{"type":"object"}},"multiple":{"type":"boolean"},"name":{"type":"string"},"onDelete":{"type":"string"},"onlyRoot":{"type":"boolean"},"parentElement":{"$ref":"#/definitions/SchemaElementI"},"possibleLoop":{"type":"boolean"},"possibleValues":{"type":"array","items":{"type":"object"}},"prefix":{"type":"string"},"preventLoop":{"type":"boolean"},"primaryKey":{"type":"string"},"reference":{"type":"boolean"},"referenceElement":{"$ref":"#/definitions/SchemaElementI"},"referenceElementName":{"$ref":"#/definitions/XMLType"},"relationName":{"type":"string"},"relationType":{"type":"string"},"relationUnique":{"type":"boolean"},"relationUniqueComposite":{"type":"string"},"required":{"type":"string"},"requiredWOPk":{"type":"string"},"rules":{"type":"array","items":{"type":"object"}},"size":{"type":"string"},"sqlField":{"$ref":"#/definitions/XFTSqlField"},"sqlname":{"type":"string"},"torqueField":{"$ref":"#/definitions/TorqueField"},"unique":{"type":"boolean"},"uniqueComposite":{"type":"string"},"wrapped":{"$ref":"#/definitions/XFTField"},"xftreference":{"$ref":"#/definitions/XFTReferenceI"},"xmldisplay":{"type":"string"},"xmljavaNameValue":{"type":"string"},"xmlname":{"type":"string"},"xmlonly":{"type":"boolean"},"xmlpathString":{"type":"string"},"xmlsqlNameValue":{"type":"string"},"xmltype":{"$ref":"#/definitions/XMLType"},"xpath":{"type":"string"}},"title":"GenericWrapperField"},"GrantedAuthority":{"type":"object","properties":{"authority":{"type":"string"}},"title":"GrantedAuthority"},"Hardware":{"type":"object","properties":{"name":{"type":"string"},"cpuLimit":{"type":"number","format":"double"},"cpuReservation":{"type":"number","format":"double"},"memoryLimit":{"type":"string"},"memoryReservation":{"type":"string"},"constraints":{"type":"array","items":{"$ref":"#/definitions/Constraint"}},"environmentVariables":{"type":"array","items":{"$ref":"#/definitions/EnvironmentVariable"}},"genericResources":{"type":"array","items":{"$ref":"#/definitions/GenericResource"}}},"title":"Hardware"},"HardwareConfig":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"hardware":{"$ref":"#/definitions/Hardware"},"scopes":{"type":"object","additionalProperties":{"$ref":"#/definitions/HardwareScope"}}},"title":"HardwareConfig"},"HardwareScope":{"type":"object","properties":{"enabled":{"type":"boolean"},"ids":{"type":"array","items":{"type":"string"}},"scope":{"type":"string","enum":["Site","Project","Subject","Experiment","User","DataType"]}},"title":"HardwareScope"},"HibernateFilter":{"title":"HibernateFilter","allOf":[{"$ref":"#/definitions/Filter"},{"type":"object","properties":{"andFilters":{"type":"array","items":{"$ref":"#/definitions/HibernateFilter"}},"hi":{"type":"object"},"lo":{"type":"object"},"not":{"type":"boolean"},"operator":{"type":"string","enum":["eq","ne","lt","gt","le","ge","like","ilike","in","between"]},"orFilters":{"type":"array","items":{"$ref":"#/definitions/HibernateFilter"}},"value":{"type":"object"},"values":{"type":"array","items":{"type":"object"}}},"title":"HibernateFilter"}]},"Ingredient":{"type":"object","properties":{"name":{"type":"string"}},"title":"Ingredient"},"InputStream":{"type":"object","title":"InputStream"},"Investigator":{"type":"object","properties":{"department":{"type":"string"},"email":{"type":"string"},"firstname":{"type":"string"},"id":{"type":"string"},"insertDate":{"type":"string","format":"date-time"},"insertUser":{"type":"string"},"institution":{"type":"string"},"investigatorProjects":{"type":"array","items":{"type":"string"}},"lastname":{"type":"string"},"phone":{"type":"string"},"primaryProjects":{"type":"array","items":{"type":"string"}},"title":{"type":"string"},"xnatInvestigatordataId":{"type":"integer","format":"int32"},"xsitype":{"type":"string"}},"title":"Investigator"},"Iterable«CacheEntryListenerConfiguration«object,object»»":{"type":"object","title":"Iterable«CacheEntryListenerConfiguration«object,object»»"},"Iterable«FileStore»":{"type":"object","title":"Iterable«FileStore»"},"Iterable«Path»":{"type":"object","title":"Iterable«Path»"},"Iterator":{"type":"object","title":"Iterator"},"JsonNode":{"type":"object","title":"JsonNode"},"JsonPathFilterNode":{"type":"object","properties":{"value":{"type":"string"},"match-case":{"type":"boolean"},"match-word":{"type":"boolean"},"match-null-value":{"type":"boolean"},"value-type":{"type":"string"},"sample-value":{"type":"string"}},"title":"JsonPathFilterNode"},"ListMultimap«string,string»":{"type":"object","properties":{"empty":{"type":"boolean"}},"title":"ListMultimap«string,string»"},"Map«File,string»":{"type":"object","title":"Map«File,string»","additionalProperties":{"type":"string"}},"Map«string,Map«File,string»»":{"type":"object","title":"Map«string,Map«File,string»»","additionalProperties":{"$ref":"#/definitions/Map"}},"Map«string,string»":{"type":"object","title":"Map«string,string»","additionalProperties":{"type":"string"}},"MetaFieldCollection":{"type":"object","properties":{"collection":{"type":"array","items":{"type":"object"}},"iterator":{"$ref":"#/definitions/Iterator"}},"title":"MetaFieldCollection"},"Mount":{"type":"object","properties":{"containerPath":{"type":"string"},"localPath":{"type":"string"},"readOnly":{"type":"boolean"},"volumeName":{"type":"string"}},"title":"Mount"},"NumericFilter":{"title":"NumericFilter","allOf":[{"$ref":"#/definitions/Filter"},{"type":"object","properties":{"eq":{"$ref":"#/definitions/Number"},"ge":{"$ref":"#/definitions/Number"},"gt":{"$ref":"#/definitions/Number"},"le":{"$ref":"#/definitions/Number"},"lt":{"$ref":"#/definitions/Number"},"neq":{"$ref":"#/definitions/Number"}},"title":"NumericFilter"}]},"Pair«string,string»":{"type":"object","properties":{"key":{"type":"string","enum":["desc","asc"]},"left":{"type":"string","enum":["desc","asc"]},"right":{"type":"string"},"value":{"type":"string"}},"title":"Pair«string,string»"},"Path":{"type":"object","properties":{"absolute":{"type":"boolean"},"fileName":{"$ref":"#/definitions/Path"},"fileSystem":{"$ref":"#/definitions/FileSystem"},"nameCount":{"type":"integer","format":"int32"},"parent":{"$ref":"#/definitions/Path"},"root":{"$ref":"#/definitions/Path"}},"title":"Path"},"ProjectEventFilterCreator":{"type":"object","properties":{"name":{"type":"string"},"event-type":{"type":"string"},"project-ids":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"payload-filter":{"type":"string"},"filter-nodes":{"type":"object","additionalProperties":{"$ref":"#/definitions/JsonPathFilterNode"}}},"title":"ProjectEventFilterCreator"},"ProjectSubscriptionCreator":{"type":"object","properties":{"name":{"type":"string"},"active":{"type":"boolean"},"custom-listener-id":{"type":"string"},"action-key":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"event-filter":{"$ref":"#/definitions/ProjectEventFilterCreator"}},"title":"ProjectSubscriptionCreator"},"Properties":{"type":"object","title":"Properties","additionalProperties":{"type":"object"}},"PseudoConfiguration":{"type":"object","properties":{"appliesToList":{"type":"array","items":{"$ref":"#/definitions/FormAppliesToPoJo"}},"contents":{"type":"string"},"dateCreated":{"type":"string","format":"date-time"},"doProjectsShareForm":{"type":"boolean"},"formDisplayOrder":{"type":"integer","format":"int32"},"formId":{"type":"string"},"formUUID":{"type":"string"},"hasData":{"type":"boolean"},"path":{"type":"string"},"scope":{"type":"string","enum":["Site","Project","Subject","Experiment","User","DataType"]},"username":{"type":"string"}},"title":"PseudoConfiguration"},"Resource":{"type":"object","properties":{"description":{"type":"string"},"file":{"$ref":"#/definitions/File"},"filename":{"type":"string"},"inputStream":{"$ref":"#/definitions/InputStream"},"open":{"type":"boolean"},"readable":{"type":"boolean"},"uri":{"$ref":"#/definitions/URI"},"url":{"$ref":"#/definitions/URL"}},"title":"Resource"},"ResourceMitigationReport":{"type":"object","properties":{"backupErrors":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}},"cachePath":{"type":"string"},"catalogWriteError":{"type":"string"},"deleteErrors":{"type":"object","additionalProperties":{"type":"string"}},"moveErrors":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}},"movedFiles":{"type":"object","additionalProperties":{"$ref":"#/definitions/File"}},"removedFiles":{"type":"object","additionalProperties":{"$ref":"#/definitions/File"}},"resourceSaveError":{"type":"string"},"resourceSurveyRequestId":{"type":"integer","format":"int64"},"retainedFiles":{"type":"array","items":{"$ref":"#/definitions/File"}},"totalFileErrors":{"type":"integer","format":"int32"},"totalMovedFiles":{"type":"integer","format":"int32"},"totalRemovedFiles":{"type":"integer","format":"int32"}},"title":"ResourceMitigationReport"},"ResourceSurveyReport":{"type":"object","properties":{"badFiles":{"type":"array","items":{"$ref":"#/definitions/File"}},"duplicates":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}}},"mismatchedFiles":{"type":"object","additionalProperties":{"type":"string"}},"nonActionableDuplicates":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}}},"resourceSurveyRequestId":{"type":"integer","format":"int64"},"surveyDate":{"type":"string","format":"date-time"},"totalBadFiles":{"type":"integer","format":"int32"},"totalDuplicates":{"type":"integer","format":"int32"},"totalEntries":{"type":"integer","format":"int32"},"totalFilesInDuplicates":{"type":"integer","format":"int32"},"totalFilesInNonActionableDuplicates":{"type":"integer","format":"int32"},"totalMismatchedFiles":{"type":"integer","format":"int32"},"totalNonActionableDuplicates":{"type":"integer","format":"int32"},"totalUids":{"type":"integer","format":"int32"},"uids":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"title":"ResourceSurveyReport"},"ResourceSurveyRequest":{"type":"object","properties":{"closingDate":{"type":"string","format":"date-time"},"created":{"type":"string","format":"date-time"},"disabled":{"type":"string","format":"date-time"},"enabled":{"type":"boolean"},"experimentId":{"type":"string"},"experimentLabel":{"type":"string"},"id":{"type":"integer","format":"int64"},"mitigationReport":{"$ref":"#/definitions/ResourceMitigationReport"},"mitigationRequester":{"type":"string"},"projectId":{"type":"string"},"requestTime":{"type":"string"},"requester":{"type":"string"},"resourceId":{"type":"integer","format":"int32"},"resourceLabel":{"type":"string"},"resourceUri":{"type":"string"},"rsnStatus":{"type":"string","enum":["CREATED","QUEUED_FOR_SURVEY","SURVEYING","DIVERGENT","CONFORMING","NONCOMPLIANT","QUEUED_FOR_MITIGATION","MITIGATING","RESOURCE_DELETED","CANCELED","ERROR"]},"scanDescription":{"type":"string"},"scanId":{"type":"integer","format":"int32"},"scanLabel":{"type":"string"},"subjectId":{"type":"string"},"subjectLabel":{"type":"string"},"surveyReport":{"$ref":"#/definitions/ResourceSurveyReport"},"timestamp":{"type":"string","format":"date-time"},"workflowId":{"type":"integer","format":"int32"},"xsiType":{"type":"string"}},"title":"ResourceSurveyRequest"},"SchemaElementI":{"type":"object","properties":{"allPrimaryKeys":{"type":"array","items":{"type":"object"}},"dbName":{"type":"string"},"formattedName":{"type":"string"},"fullXMLName":{"type":"string"},"genericXFTElement":{"$ref":"#/definitions/GenericWrapperElement"},"preLoad":{"type":"boolean"},"sqlname":{"type":"string"}},"title":"SchemaElementI"},"ScriptTrigger":{"type":"object","properties":{"association":{"type":"string"},"created":{"type":"string","format":"date-time"},"description":{"type":"string"},"disabled":{"type":"string","format":"date-time"},"enabled":{"type":"boolean"},"event":{"type":"string"},"eventFilters":{"type":"array","items":{"$ref":"#/definitions/EventFilters"}},"eventFiltersAsMap":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"id":{"type":"integer","format":"int64"},"scriptId":{"type":"string"},"srcEventClass":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"triggerId":{"type":"string"}},"title":"ScriptTrigger"},"SessionData":{"type":"object","title":"SessionData"},"SetMultimap«string,string»":{"type":"object","properties":{"empty":{"type":"boolean"}},"title":"SetMultimap«string,string»"},"SimpleEvent":{"type":"object","title":"SimpleEvent"},"SpawnerElement":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"description":{"type":"string"},"disabled":{"type":"string","format":"date-time"},"elementId":{"type":"string"},"enabled":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"label":{"type":"string"},"namespace":{"type":"string"},"restricted":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"yaml":{"type":"string"}},"title":"SpawnerElement"},"StreamingResponseBody":{"type":"object","title":"StreamingResponseBody"},"StringFilter":{"title":"StringFilter","allOf":[{"$ref":"#/definitions/Filter"},{"type":"object","properties":{"like":{"type":"string"},"not":{"type":"boolean"}},"title":"StringFilter"}]},"SubQueryMappingColumnDB":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"queryField":{"type":"string"},"schemaField":{"type":"string"}},"title":"SubQueryMappingColumnDB"},"Subscription":{"type":"object","properties":{"act-as-event-user":{"type":"boolean"},"action-key":{"type":"string"},"active":{"type":"boolean"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"created":{"type":"string","example":"yyyy-MM-dd HH:mm:ss z"},"event-filter":{"$ref":"#/definitions/EventFilter"},"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"subscription-owner":{"type":"string"},"valid":{"type":"boolean"},"validation-message":{"type":"string"}},"title":"Subscription"},"SubscriptionCreator":{"type":"object","properties":{"name":{"type":"string"},"active":{"type":"boolean"},"custom-listener-id":{"type":"string"},"action-key":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"event-filter":{"$ref":"#/definitions/EventFilterCreator"},"act-as-event-user":{"type":"boolean"}},"title":"SubscriptionCreator"},"SubscriptionDelivery":{"type":"object","properties":{"error":{"type":"boolean"},"event":{"$ref":"#/definitions/SimpleEvent"},"event-type":{"type":"string"},"id":{"type":"integer","format":"int64"},"inputs":{"type":"string"},"payload":{"type":"object"},"project":{"type":"string"},"status":{"type":"array","items":{"$ref":"#/definitions/TimedEventStatus"}},"status-message":{"type":"string"},"subscription":{"$ref":"#/definitions/Subscription"},"timestamp":{"type":"string","example":"yyyy-MM-dd HH:mm:ss z"},"trigger":{"$ref":"#/definitions/TriggeringEvent"},"user":{"type":"string"}},"title":"SubscriptionDelivery"},"SubscriptionDeliveryEntityPaginatedRequest":{"type":"object","properties":{"filters":{"type":"object","additionalProperties":{"$ref":"#/definitions/Filter"}},"id":{"type":"string"},"offset":{"type":"integer","format":"int32"},"order":{"$ref":"#/definitions/Pair«string,string»"},"page":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"sortBys":{"type":"array","items":{"$ref":"#/definitions/Pair«string,string»"}},"sort_col":{"type":"string"},"sort_dir":{"type":"string","enum":["desc","asc"]}},"title":"SubscriptionDeliveryEntityPaginatedRequest"},"SubscriptionDeliverySummary":{"type":"object","properties":{"error":{"type":"boolean"},"event-name":{"type":"string"},"id":{"type":"integer","format":"int64"},"project":{"type":"string"},"status":{"type":"string"},"subscription-id":{"type":"integer","format":"int64"},"subscription-name":{"type":"string"},"timestamp":{"type":"string","example":"yyyy-MM-dd HH:mm:ss z"},"trigger-label":{"type":"string"},"user":{"type":"string"}},"title":"SubscriptionDeliverySummary"},"SubscriptionDisplay":{"type":"object","properties":{"act-as-event-user":{"type":"boolean"},"action-key":{"type":"string"},"active":{"type":"boolean"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"created":{"type":"string","example":"yyyy-MM-dd HH:mm:ss z"},"editable":{"type":"boolean"},"event-filter":{"$ref":"#/definitions/EventFilter"},"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"subscription-owner":{"type":"string"},"valid":{"type":"boolean"},"validation-message":{"type":"string"}},"title":"SubscriptionDisplay"},"SubscriptionUpdate":{"type":"object","properties":{"name":{"type":"string"},"active":{"type":"boolean"},"custom-listener-id":{"type":"string"},"action-key":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"event-filter":{"$ref":"#/definitions/EventFilterUpdate"},"act-as-event-user":{"type":"boolean"}},"title":"SubscriptionUpdate"},"SurveyReportSummary":{"type":"object","properties":{"overallStatus":{"type":"string"},"projectId":{"type":"string"},"totalBadFiles":{"type":"integer","format":"int32"},"totalDuplicates":{"type":"integer","format":"int32"},"totalEntries":{"type":"integer","format":"int32"},"totalFileErrors":{"type":"integer","format":"int32"},"totalMismatchedFiles":{"type":"integer","format":"int32"},"totalMovedFiles":{"type":"integer","format":"int32"},"totalRemovedFiles":{"type":"integer","format":"int32"},"totalUids":{"type":"integer","format":"int32"}},"title":"SurveyReportSummary"},"ThemeConfig":{"type":"object","properties":{"enabled":{"type":"boolean"},"name":{"type":"string"},"path":{"type":"string"},"roles":{"type":"array","items":{"type":"object"}}},"title":"ThemeConfig"},"TimedEventStatus":{"type":"object","properties":{"message":{"type":"string"},"status":{"type":"string"},"timestamp":{"type":"string","example":"yyyy-MM-dd HH:mm:ss z"}},"title":"TimedEventStatus"},"TimestampFilter":{"title":"TimestampFilter","allOf":[{"$ref":"#/definitions/Filter"},{"type":"object","properties":{"after":{"type":"string"},"afterOrOn":{"type":"string"},"before":{"type":"string"},"beforeOrOn":{"type":"string"}},"title":"TimestampFilter"}]},"TorqueField":{"type":"object","properties":{"defaultValue":{"type":"string"},"inheritance":{"type":"string"},"inheritanceClass":{"type":"string"},"inheritanceExtends":{"type":"string"},"inheritanceKey":{"type":"string"},"javaName":{"type":"string"}},"title":"TorqueField"},"TriggeringEvent":{"type":"object","properties":{"URI":{"type":"string"},"event-name":{"type":"string"},"is-xsi-type":{"type":"boolean"},"label":{"type":"string"},"status":{"type":"string"},"xnat-type":{"type":"string"}},"title":"TriggeringEvent"},"Triple«string,int,boolean»":{"type":"object","properties":{"left":{"type":"string"},"middle":{"type":"integer","format":"int32"},"right":{"type":"boolean"}},"title":"Triple«string,int,boolean»"},"TypeOption":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"title":"TypeOption"},"URI":{"type":"object","properties":{"absolute":{"type":"boolean"},"authority":{"type":"string"},"fragment":{"type":"string"},"host":{"type":"string"},"opaque":{"type":"boolean"},"path":{"type":"string"},"port":{"type":"integer","format":"int32"},"query":{"type":"string"},"rawAuthority":{"type":"string"},"rawFragment":{"type":"string"},"rawPath":{"type":"string"},"rawQuery":{"type":"string"},"rawSchemeSpecificPart":{"type":"string"},"rawUserInfo":{"type":"string"},"scheme":{"type":"string"},"schemeSpecificPart":{"type":"string"},"userInfo":{"type":"string"}},"title":"URI"},"URL":{"type":"object","properties":{"authority":{"type":"string"},"content":{"type":"object"},"defaultPort":{"type":"integer","format":"int32"},"file":{"type":"string"},"host":{"type":"string"},"path":{"type":"string"},"port":{"type":"integer","format":"int32"},"protocol":{"type":"string"},"query":{"type":"string"},"ref":{"type":"string"},"userInfo":{"type":"string"}},"title":"URL"},"User":{"type":"object","properties":{"authorization":{"description":"The user's authorization record used when logging in.","$ref":"#/definitions/UserAuthI"},"currentPassword":{"type":"string"},"email":{"type":"string"},"enabled":{"type":"boolean"},"firstName":{"type":"string"},"id":{"type":"integer","format":"int32"},"lastModified":{"type":"string","format":"date-time"},"lastName":{"type":"string"},"lastSuccessfulLogin":{"type":"string","format":"date-time"},"password":{"type":"string","description":"The user's encrypted password."},"pendingEmail":{"type":"string"},"salt":{"type":"string","description":"The salt used to encrypt the user's password."},"secured":{"type":"boolean"},"username":{"type":"string"},"verified":{"type":"boolean"}},"title":"User","description":"Contains the properties that define a user on the system."},"UserAuth":{"type":"object","properties":{"authMethod":{"type":"string"},"authMethodId":{"type":"string"},"authUser":{"type":"string"},"failedLoginAttempts":{"type":"integer","format":"int32"},"lastLoginAttempt":{"type":"string","format":"date-time"},"lastSuccessfulLogin":{"type":"string","format":"date-time"},"xdatUsername":{"type":"string"}},"title":"UserAuth","description":"Contains the properties that define a user's authentication provider mapping entry on the system."},"UserAuthI":{"type":"object","discriminator":"type","properties":{"accountNonExpired":{"type":"boolean"},"accountNonLocked":{"type":"boolean"},"authMethod":{"type":"string"},"authMethodId":{"type":"string"},"authUser":{"type":"string"},"authorities":{"type":"array","items":{"$ref":"#/definitions/GrantedAuthority"}},"credentialsNonExpired":{"type":"boolean"},"enabled":{"type":"boolean"},"failedLoginAttempts":{"type":"integer","format":"int32"},"lastLoginAttempt":{"type":"string","format":"date-time"},"lastSuccessfulLogin":{"type":"string","format":"date-time"},"lockoutTime":{"type":"string","format":"date-time"},"passwordUpdated":{"type":"string","format":"date-time"},"xdatUsername":{"type":"string"}},"title":"UserAuthI"},"UserPrincipalLookupService":{"type":"object","title":"UserPrincipalLookupService"},"Validated":{"type":"object","properties":{"message":{"type":"string"},"valid":{"type":"boolean"}},"title":"Validated"},"XFTDataModel":{"type":"object","properties":{"db":{"type":"string"},"elementNames":{"type":"array","items":{"type":"string"}},"fileName":{"type":"string"},"packageName":{"type":"string"},"resource":{"$ref":"#/definitions/Resource"},"schema":{"$ref":"#/definitions/XFTSchema"},"schemaAbbr":{"type":"string"},"source":{"$ref":"#/definitions/Resource"},"uri":{"type":"string"}},"title":"XFTDataModel"},"XFTElement":{"type":"object","properties":{"absoluteParent":{"$ref":"#/definitions/XFTElement"},"abstract":{"type":"boolean"},"addin":{"type":"string"},"anoChildElement":{"type":"boolean"},"autoActivate":{"type":"boolean"},"briefDescription":{"type":"string"},"code":{"type":"string"},"createdChild":{"type":"boolean"},"dataModel":{"$ref":"#/definitions/XFTDataModel"},"displayIdentifiers":{"type":"array","items":{"type":"string"}},"extended":{"type":"boolean"},"extension":{"type":"boolean"},"extensionType":{"$ref":"#/definitions/XMLType"},"fields":{"type":"object","additionalProperties":{"type":"object"}},"fullDescription":{"type":"string"},"ignoreWarnings":{"type":"boolean"},"matchByValues":{"type":"boolean"},"metaElement":{"$ref":"#/definitions/XFTMetaElement"},"name":{"type":"string"},"parent":{"$ref":"#/definitions/XFTNode"},"parentElement":{"$ref":"#/definitions/XFTElement"},"preLoad":{"type":"boolean"},"quarantine":{"type":"boolean"},"rootElement":{"type":"boolean"},"schema":{"$ref":"#/definitions/XFTSchema"},"schemaPrefix":{"type":"string"},"sequence":{"type":"integer","format":"int32"},"skipSQL":{"type":"boolean"},"sortedFields":{"type":"array","items":{"type":"object"}},"sqlElement":{"$ref":"#/definitions/XFTSqlElement"},"type":{"$ref":"#/definitions/XMLType"},"webAppElement":{"$ref":"#/definitions/XFTWebAppElement"},"xsDescription":{"type":"string"}},"title":"XFTElement"},"XFTFactoryI":{"type":"object","title":"XFTFactoryI"},"XFTField":{"type":"object","properties":{"absoluteParent":{"$ref":"#/definitions/XFTElement"},"attribute":{"type":"boolean"},"baseCol":{"type":"string"},"baseElement":{"type":"string"},"childFields":{"type":"object","additionalProperties":{"type":"object"}},"description":{"type":"string"},"displayName":{"type":"string"},"expose":{"type":"string"},"extension":{"type":"boolean"},"filter":{"type":"boolean"},"finalSqlName":{"type":"string"},"fixed":{"type":"string"},"fullName":{"type":"string"},"id":{"type":"string"},"localMap":{"type":"boolean"},"maxOccurs":{"type":"string"},"minOccurs":{"type":"string"},"name":{"type":"string"},"onlyRoot":{"type":"boolean"},"parent":{"$ref":"#/definitions/XFTNode"},"parentElement":{"$ref":"#/definitions/XFTElement"},"possibleLoop":{"type":"boolean"},"preventLoop":{"type":"boolean"},"relation":{"$ref":"#/definitions/XFTRelation"},"required":{"type":"string"},"rule":{"$ref":"#/definitions/XFTRule"},"sequence":{"type":"integer","format":"int32"},"size":{"type":"string"},"sortedFields":{"type":"array","items":{"type":"object"}},"sqlField":{"$ref":"#/definitions/XFTSqlField"},"unique":{"type":"string"},"uniqueComposite":{"type":"string"},"use":{"type":"string"},"webAppField":{"$ref":"#/definitions/XFTWebAppField"},"xmlDisplay":{"type":"string"},"xmlOnly":{"type":"string"},"xmltype":{"$ref":"#/definitions/XMLType"}},"title":"XFTField"},"XFTFieldWrapper":{"type":"object","properties":{"booleanField":{"type":"boolean"},"factory":{"$ref":"#/definitions/XFTFactoryI"},"genericXFTField":{"$ref":"#/definitions/GenericWrapperField"},"hidden":{"type":"boolean"},"id":{"type":"string"},"multiple":{"type":"boolean"},"name":{"type":"string"},"parentElement":{"$ref":"#/definitions/SchemaElementI"},"reference":{"type":"boolean"},"referenceElement":{"$ref":"#/definitions/SchemaElementI"},"sqlname":{"type":"string"},"wrapped":{"$ref":"#/definitions/XFTField"},"xpath":{"type":"string"}},"title":"XFTFieldWrapper"},"XFTManyToManyReference":{"type":"object","properties":{"element1":{"$ref":"#/definitions/GenericWrapperElement"},"element2":{"$ref":"#/definitions/GenericWrapperElement"},"field1":{"$ref":"#/definitions/GenericWrapperField"},"field2":{"$ref":"#/definitions/GenericWrapperField"},"historyTableName":{"type":"string"},"manyToMany":{"type":"boolean"},"mappingColumns":{"type":"array","items":{"type":"object"}},"mappingTable":{"type":"string"},"unique":{"type":"boolean"}},"title":"XFTManyToManyReference"},"XFTMetaElement":{"type":"object","properties":{"code":{"type":"string"},"element":{"$ref":"#/definitions/XFTElement"},"javaName":{"type":"string"},"localXMLName":{"type":"string"},"prefix":{"type":"string"},"sqlName":{"type":"string"}},"title":"XFTMetaElement"},"XFTNode":{"type":"object","properties":{"absoluteParent":{"$ref":"#/definitions/XFTElement"},"parent":{"$ref":"#/definitions/XFTNode"},"parentElement":{"$ref":"#/definitions/XFTElement"}},"title":"XFTNode"},"XFTReferenceI":{"type":"object","properties":{"manyToMany":{"type":"boolean"}},"title":"XFTReferenceI"},"XFTRelation":{"type":"object","properties":{"duplicateRelationships":{"type":"array","items":{"type":"object"}},"foreignCol":{"type":"string"},"foreignKeyName":{"type":"string"},"foreignKeyTable":{"type":"string"},"onDelete":{"type":"string"},"onUpdate":{"type":"string"},"relationName":{"type":"string"},"relationType":{"type":"string"},"unique":{"type":"boolean"},"uniqueComposite":{"type":"string"}},"title":"XFTRelation"},"XFTRelationSpecification":{"type":"object","properties":{"foreignCol":{"type":"string"},"foreignKey":{"$ref":"#/definitions/GenericWrapperField"},"foreignTable":{"type":"string"},"localCol":{"type":"string"},"localKey":{"$ref":"#/definitions/GenericWrapperField"},"localTable":{"type":"string"},"localXMLPath":{"type":"string"},"schemaType":{"$ref":"#/definitions/XMLType"}},"title":"XFTRelationSpecification"},"XFTRule":{"type":"object","properties":{"baseType":{"type":"string"},"length":{"type":"string"},"mask":{"type":"string"},"maxInclusive":{"type":"string"},"maxLength":{"type":"string"},"message":{"type":"string"},"minInclusive":{"type":"string"},"minLength":{"type":"string"},"possibleValues":{"type":"array","items":{"type":"object"}}},"title":"XFTRule"},"XFTSchema":{"type":"object","properties":{"dataModel":{"$ref":"#/definitions/XFTDataModel"},"dbType":{"type":"string"},"elementsByName":{"type":"object","additionalProperties":{"type":"object"}},"sortedElementNames":{"type":"array","items":{"type":"string"}},"sortedElements":{"type":"array","items":{"type":"object"}},"targetNamespacePrefix":{"type":"string"},"targetNamespaceURI":{"type":"string"},"webAppSchema":{"$ref":"#/definitions/XFTWebAppSchema"},"xmlns":{"type":"string"}},"title":"XFTSchema"},"XFTSqlElement":{"type":"object","properties":{"name":{"type":"string"}},"title":"XFTSqlElement"},"XFTSqlField":{"type":"object","properties":{"autoIncrement":{"type":"string"},"defaultValue":{"type":"string"},"index":{"type":"string"},"key":{"type":"string"},"primaryKey":{"type":"string"},"sqlName":{"type":"string"},"type":{"type":"string"}},"title":"XFTSqlField"},"XFTSuperiorReference":{"type":"object","properties":{"element1":{"$ref":"#/definitions/GenericWrapperElement"},"element2":{"$ref":"#/definitions/GenericWrapperElement"},"field1":{"$ref":"#/definitions/GenericWrapperField"},"field2":{"$ref":"#/definitions/GenericWrapperField"},"keyRelations":{"type":"array","items":{"$ref":"#/definitions/XFTRelationSpecification"}},"manyToMany":{"type":"boolean"},"subordinateElement":{"$ref":"#/definitions/GenericWrapperElement"},"subordinateElementName":{"type":"string"},"subordinateField":{"$ref":"#/definitions/GenericWrapperField"},"subordinateFieldSQLName":{"type":"string"},"superiorElement":{"$ref":"#/definitions/GenericWrapperElement"},"superiorElementLocalName":{"type":"string"},"superiorElementName":{"type":"string"},"superiorField":{"$ref":"#/definitions/GenericWrapperField"},"superiorFieldSQLName":{"type":"string"}},"title":"XFTSuperiorReference"},"XFTWebAppElement":{"type":"object","properties":{"idMethod":{"type":"string"},"javaName":{"type":"string"}},"title":"XFTWebAppElement"},"XFTWebAppField":{"type":"object","properties":{"javaName":{"type":"string"}},"title":"XFTWebAppField"},"XFTWebAppSchema":{"type":"object","title":"XFTWebAppSchema"},"XMLType":{"type":"object","properties":{"foreignPrefix":{"type":"string"},"foreignXMLNS":{"type":"string"},"fullForeignType":{"type":"string"},"fullLocalType":{"type":"string"},"localPrefix":{"type":"string"},"localType":{"type":"string"},"localXMLNS":{"type":"string"},"schema":{"$ref":"#/definitions/XFTSchema"}},"title":"XMLType"},"XdatUserAuth":{"title":"XdatUserAuth","allOf":[{"$ref":"#/definitions/UserAuthI"},{"type":"object","properties":{"accountNonExpired":{"type":"boolean"},"accountNonLocked":{"type":"boolean"},"authMethod":{"type":"string"},"authMethodId":{"type":"string"},"authUser":{"type":"string"},"authorities":{"type":"array","items":{"$ref":"#/definitions/GrantedAuthority"}},"created":{"type":"string","format":"date-time"},"credentialsNonExpired":{"type":"boolean"},"disabled":{"type":"string","format":"date-time"},"enabled":{"type":"boolean"},"failedLoginAttempts":{"type":"integer","format":"int32"},"id":{"type":"integer","format":"int64"},"lastLoginAttempt":{"type":"string","format":"date-time"},"lastSuccessfulLogin":{"type":"string","format":"date-time"},"lockoutTime":{"type":"string","format":"date-time"},"passwordUpdated":{"type":"string","format":"date-time"},"timestamp":{"type":"string","format":"date-time"},"xdatUsername":{"type":"string"}},"title":"XdatUserAuth"}]},"XnatAuthenticationProviderApiPojo":{"type":"object","properties":{"authMethod":{"type":"string"},"name":{"type":"string"},"providerId":{"type":"string"}},"title":"XnatAuthenticationProviderApiPojo"},"XnatDataModelBean":{"type":"object","properties":{"code":{"type":"string"},"plural":{"type":"string"},"secured":{"type":"boolean"},"singular":{"type":"string"},"type":{"type":"string"}},"title":"XnatDataModelBean"},"XnatFormsIOEnv":{"type":"object","properties":{"features":{"type":"object","additionalProperties":{"type":"object"}},"siteHasProtocolsPluginDeployed":{"type":"boolean"}},"title":"XnatFormsIOEnv"},"XnatPluginBean":{"type":"object","properties":{"beanName":{"type":"string"},"dataModelBeans":{"type":"array","items":{"$ref":"#/definitions/XnatDataModelBean"}},"description":{"type":"string"},"entityPackages":{"type":"array","items":{"type":"string"}},"extendedAttributes":{"$ref":"#/definitions/ListMultimap«string,string»"},"id":{"type":"string"},"logConfigurationFile":{"type":"string"},"name":{"type":"string"},"namespace":{"type":"string"},"pluginClass":{"type":"string"},"version":{"type":"string"}},"title":"XnatPluginBean"}}}