Workflow Engine

Introduction

Provides a set of APIs to access data from the Synapse database.

AIThinkLog

API	Description
POST AIThinkLog/UpdateAIThinklogInfo	No documentation available.
POST AIThinkLog/SaveAIScanStatus	No documentation available.
GET AIThinkLog/StopPolling	No documentation available.
DELETE AIThinkLog/ClearAIThinklogInfo?studyInstanceEuid={studyInstanceEuid}&userName={userName}	No documentation available.
GET AIThinkLog/IsAIResearchEnabled	No documentation available.
GET AIThinkLog/IsAIEnabled	No documentation available.

DisplayStates

API	Description
POST DisplayStates/Rename	Renames the display state.
DELETE DisplayStates/Delete	Deletes the display states.
GET DisplayStates/Get?studyInstanceUid={studyInstanceUid}&userLogin={userLogin}&culture={culture}	Gets all display states of the study for the given user.
POST DisplayStates/GetByListOfInstanceEuid	Gets the display state flags by instance euid.
POST DisplayStates/GetByListOfUid	Gets the display states by identifier.

ThinkLog

API	Description
GET ThinkLog/GetThinkLogUsersAndRoles?loginName={loginName}&qbeString={qbeString}	No documentation available.

Patient

API	Description
GET Patient/ByUuid?PatientUuid={PatientUuid}&Culture={Culture}	Returns the Patient for the givent PatientId
GET Patient/ByCriteria?patientUuid={patientUuid}	Gets the patient criteria.
GET Patient/ById?patientId={patientId}	No documentation available.

DataSource

API	Description
GET DataSource/All	Gets all data sources.
GET DataSource/VnaCommonViewConfiguration	No documentation available.
GET DataSource/ForLoginUser?userName={userName}	Gets the data sources for login.
GET DataSource/ForUser?userName={userName}	Gets all data sources.
GET DataSource/Version	No documentation available.
POST DataSource/RemoveUser?userName={userName}&uuid={uuid}	Removes the user data source.
POST DataSource/RevertDatasource?identifier={identifier}&loggedInUser={loggedInUser}&cascadeLevel={cascadeLevel}	No documentation available.
POST DataSource/AddUser?userName={userName}&uuid={uuid}	No documentation available.
POST DataSource/ReinstateRemoveUser	Reinstate/Remove user data sources based on the IsReinstate flag
GET DataSource/GetDataSourcesByLevel?userName={userName}&loggedInUser={loggedInUser}&cascadeLevel={cascadeLevel}	No documentation available.
POST DataSource/UpdateDatasourceByLevel?identifier={identifier}&cascadeLevel={cascadeLevel}	No documentation available.
GET DataSource/VnaMode	No documentation available.

Documents

API	Description
GET Documents/RenameDocument?documentId={documentId}&newDocumentName={newDocumentName}&contextType={contextType}&userName={userName}&contextUid={contextUid}	Rename the specified document
GET Documents/DeleteDocument?documentId={documentId}&contextUid={contextUid}&userName={userName}&contextType={contextType}	Delete the specified document
GET Documents/DownloadDocument?contextType={contextType}&filePath={filePath}&dataSource={dataSource}	No documentation available.
POST Documents/UploadFiles	Save uploaded files to the file system and their info to the database
POST Documents/UploadScannedDocument	Uploads the scanned document.
GET Documents?contextType={contextType}&contextUid={contextUid}	Gets all documents satisfying the given parameters.

I18n

i18n translations service

API	Description
GET I18n/Resources?culture={culture}	Translates the specified text.
GET I18n/Resource?text={text}&culture={culture}	Translates the text.

Worklist

API	Description
POST Worklist/Query?identifier={identifier}&global={global}	Queries the worklist having the given name and matching the criteria in the request.
POST Worklist/Retrieve?identifier={identifier}&global={global}	Retrieves the worklist having the given name and matching the criteria in the request.
POST Worklist/FetchNextStudy?identifier={identifier}&clientID={clientID}	Retrieves the next study item having the given name and matching the criteria in the request.
GET Worklist/Metadata?identifier={identifier}&userLogin={userLogin}&worklistType={worklistType}&culture={culture}&global={global}&forceRefresh={forceRefresh}	No documentation available.
GET Worklist/Worklists?userLogin={userLogin}&simpleDashboardOnly={simpleDashboardOnly}&forceRefresh={forceRefresh}&culture={culture}	Gets all the active worklists.
GET Worklist/GlobalWorklistsForAllUsers?userLogin={userLogin}&culture={culture}	Gets the worklist for all users.
GET Worklist/ContentChanged?identifier={identifier}&worklistType={worklistType}&userLogin={userLogin}&lastAccessed={lastAccessed}&culture={culture}&sessionID={sessionID}&global={global}	Determines whether the worklist content is changed or not.
GET Worklist/MetadataChanged?identifier={identifier}&worklistType={worklistType}&userLogin={userLogin}&culture={culture}&global={global}	No documentation available.
DELETE Worklist/Cache?sessionId={sessionId}	Clears the cache data
POST Worklist/CreateQbeFolder	Create new Qbe Folder
POST Worklist/UpdateQbeFolder	Update existing Qbe Folder
POST Worklist/DeleteQbeFolder	Delete existing Qbe Folder
POST Worklist/RestoreQbeFolder	Restore Qbe Folder
POST Worklist/CreateLinkFolder	Create Link Folder
POST Worklist/UpdateLinkFolder	Update Link Folder
POST Worklist/UpdateLinkFolderParent	No documentation available.
POST Worklist/DeleteLinkFolder	Delete Link Folder
POST Worklist/ReplaceLinkFolder	No documentation available.
POST Worklist/RestoreLinkFolder	Restore Link Folder
GET Worklist/LinkFolders?userLogin={userLogin}&culture={culture}&scope={scope}	Gets the link folders' name and uuid.
GET Worklist/FavoriteFolders?userLogin={userLogin}&culture={culture}	Gets the Favorite Folders name and uuid.
POST Worklist/AddItemsToLinkFolder	Adds the records to link folder.
POST Worklist/MoveItemstoLinkFolder	Moves the records to link folder.
DELETE Worklist/RemoveItemsFromLinkFolder	Removes the items from link folder.
POST Worklist/AddToFavorite	Adds to favorite.
DELETE Worklist/RemoveFromFavorite?folderUuid={folderUuid}&userLogin={userLogin}	Removes from favorite.
POST Worklist/UpdateFavorite	Update favorite.
POST Worklist/GrantWorklistPermission	Sets the worklist privilage.
GET Worklist/GetFolderStatus?loginName={loginName}&identifier={identifier}	Determines whether this instance has previlage.
POST Worklist/ShareFolder	Allows the client to change the sharing property of a worklist folder between public and private.
GET Worklist/CollectionOwner?identifier={identifier}&userLogin={userLogin}	Returns the name of the owner of a specific collection.
GET Worklist/UserInfo?userLogin={userLogin}	No documentation available.
POST Worklist/SetDefaultWorklist	No documentation available.
GET Worklist/GetDefaultWorklist?userName={userName}	No documentation available.
GET Worklist/GetSubscriptionSettings?userName={userName}&machineName={machineName}	No documentation available.
POST Worklist/SetSubscriptionSettings	No documentation available.
GET Worklist/GetRelatedProcedureCodes?procedureCode={procedureCode}&userLogin={userLogin}	Gets the related procedure codes.
GET Worklist/RevokedStudyList?userLogin={userLogin}	Gets the revoked study list.
GET Worklist/GetLinkFolderPermission?linkFolderUuid={linkFolderUuid}&userLogin={userLogin}	No documentation available.
POST Worklist/SetLinkFolderPermission	No documentation available.

Notes

API	Description
GET Notes/GetLegacyNote?studyIuid={studyIuid}&userLogin={userLogin}	Gets the Legacy Note from the db.
POST Notes/SaveLegacyNote	Saves the legacy note to a file and the db.
POST Notes/SaveNote	No documentation available.
GET Notes/CannedNote?userLogin={userLogin}	No documentation available.

User

API	Description
GET User/HasPrivilege?loginName={loginName}&privilegeName={privilegeName}	Determine whether the specified user has the specified privilege
GET User/GetUserPrivileges?loginName={loginName}	Gets all the privileges assigned to a particular user.
GET User/GetAllUsersAndRoles?loginName={loginName}	Gets all users and roles.
GET User/GetAllAccessorDetails?loginName={loginName}&forceRefresh={forceRefresh}	Gets all users and roles.
GET User/RefreshCache	Refresh the cache with the data from DB
GET User/UsersWithPrivilege?privilegeName={privilegeName}&userSearchText={userSearchText}	No documentation available.
GET User/GetUserDetails?userLogin={userLogin}	No documentation available.
GET User/GetUsersAndRoles?loginName={loginName}	No documentation available.

Logging

API	Description
POST Logging/FunctionalLog	Adds the functional log.
POST Logging/AuditLog	Adds the audit log event.

PowerJacket

API	Description
GET PowerJacket/GetApplications	No documentation available.
POST PowerJacket/GetConfiguredUrl?userId={userId}&studyIuid={studyIuid}&baseUrl={baseUrl}	No documentation available.
POST PowerJacket/AddRelatedProcedure	Set as a related procedure.
POST PowerJacket/RemoveRelatedProcedure	Remove as a related procedure.

WorkflowAction

The Workflow Action Service

API	Description
GET WorkflowAction/AvailableAction?UserUuid={UserUuid}&WorkflowId={WorkflowId}&StudyUuid={StudyUuid}	Gets the Available Actions for the Workflow
POST WorkflowAction/PerformAction?UserUuid={UserUuid}	Performs the Action available.

WorkflowSettings

API	Description
GET WorkflowSettings/GetWorkflowSettingsByLevel?identifier={identifier}&cascadeLevel={cascadeLevel}	No documentation available.
GET WorkflowSettings/GetPowerJacketSettingsByLevel?identifier={identifier}&cascadeLevel={cascadeLevel}	No documentation available.
GET WorkflowSettings/CurrentCulture?userName={userName}	Gets the current culture.
POST WorkflowSettings/SavePowerJacketSettings?identifier={identifier}&loggedInUser={loggedInUser}&cascadeLevel={cascadeLevel}	No documentation available.
POST WorkflowSettings/SaveWorkflowSettings?identifier={identifier}&loggedInUser={loggedInUser}&cascadeLevel={cascadeLevel}	No documentation available.
POST WorkflowSettings/SaveLocalStorage	Save Browser's LocalStorage
GET WorkflowSettings/GetLocalStorage?userName={userName}&userMachineIp={userMachineIp}	Retrieves Browser's saved localStorage.
GET WorkflowSettings/GetSessionAliveInterval	Gets the session alive interval.
GET WorkflowSettings/DefaultReservationExpirationTime	Gets the default reservation expiration time.
GET WorkflowSettings/GetCollapsedFolders?userName={userName}	No documentation available.
POST WorkflowSettings/SaveCollapsedFolders	No documentation available.

Dictation

API	Description
POST Dictation/ShouldGroupDictationOpen	Returns whether the group dictation can be open or not.

Study

API	Description
GET Study/GetStudyByIuid?iuid={iuid}&dataSource={dataSource}	No documentation available.
GET Study/GetStudiesByIuid?Iuids[0]={Iuids[0]}&Iuids[1]={Iuids[1]}	Gets a list studies by their iuid.
POST Study/GetStudiesInfoByIuid	Gets a list studies by their iuid.
POST Study/UpdateStudyStatus	Update the status of the specified study
GET Study/GetStudyPriorities	Gets all Priority codes present.
POST Study/UpdateStudyPriority	Updates the study priority.
POST Study/FetchStudyReportImpressions	Returns the report impressions for the specified list of studies.
POST Study/LockStudy?studyEuid={studyEuid}&userLogin={userLogin}	Locks the study.
POST Study/RemoveStudyLock?studyEuid={studyEuid}&userLogin={userLogin}	Unlock the study.
GET Study/GetStudyLockInfo?studyEuid={studyEuid}	Gets the study lock information.
GET Study/GetStudyLockCountInfo?userLogin={userLogin}	Gets the study lock count.
POST Study/ByCommonViewSettings?userLogin={userLogin}&syncommConfigured={syncommConfigured}&includeStudyLockInfo={includeStudyLockInfo}&currentCulture={currentCulture}	No documentation available.
POST Study/SetStudyPermission	Sets the study permission
GET Study/GetStudyPermission?loginName={loginName}&studyIuid={studyIuid}	Determines whether the study has access permission
POST Study/ReserveStudy	Reserves the specified reserve information request.
POST Study/UnreserveStudy	Unreserves the specified study uids list.
GET Study/StudyReservationInfo?studyInstanceEuid={studyInstanceEuid}	Gets the study reserve information.
GET Study/StudyStatusList	Gets the study status list.

Document

API	Description
GET DocumentType/GetAllDocumentTypes	Returns all of the Document Types and their attributes
POST DocumentType/UpdateDocumentTypes	Update all document types
POST DocumentType/DeleteDocumentType	Delete the specified document

ReportMacro

API	Description
GET ReportMacro	Gets all report macros present.

LocalAE

API	Description
GET LocalAE	No documentation available.

Report

API	Description
GET Report	Get a list of all birads
GET Report?StudyIuid={StudyIuid}	Gets the External Reports associated with the given StudyIuid.