sid • The session id (optional if basic authentication or an OAuth token is used) name • Name of the route (account_id|group_id|location_id|namespace_id) • uuid of the account, group or location or namespace the route is linked with conditions • Route conditions in JSON format actions • Route actions in JSON format options • Route options in JSON format (optional) schedule • Route schedule in JSON format (optional) on_share • Apply the rule to studies shared into the namespace on_harvest • Apply the rule to studies harvested into the namespace on_upload • Apply the rule to studies uploaded into the namespace - flag (optional) on_manual_route • Apply this rule for a manually routed study - flag (optional) on_thin • Apply this rule to thin studies when they are created - flag (optional) no_re_run • Do not run this rule on a re-notification from storage - flag (optional) suspended • This rule is suspended and not applied - flag (optional) delay • Number of minutes to delay running this rule for after it is triggered (optional) delay_till_schedule • Delay running this rule after it is triggered until the next scheduled time - flag (optional) other_namespaces • A comma separated list of the uuid of other namespaces to apply this rule to (optional) manual_roles • A comma separated list of the uuid of roles that can run the rule manually (optional) |
| Returns |
status • OK uuid • The route uuid |
| Permission | route_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag ACCOUNT_NOT_FOUND • The account was not found NOT_PERMITTED • You are not permitted to add a route to that account INVALID_LINKAGE • The linkage is invalid INVALID_CONDITION • A condition is invalid. The error_subtype holds the condition INVALID_ACTION • An action is invalid. The error_subtype holds the error detail INVALID_OPTION • An option is invalid. The error_subtype holds the error detail INVALID_SCHEDULE • The schedule is invalid. The error_subtype holds the error detail INVALID_OTHER_NAMESPACES • The other_namespaces is invalid. The error_subtype holds the error detail INVALID_MANUAL_ROLES • The manual_roles is invalid. The error_subtype holds the error detail |
| Notes |
|
| Description | Save a routing rule |
|---|---|
| URL | /route/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The route uuid name • Name of the route (optional) conditions • Route conditions in JSON format (optional) actions • Route actions in JSON format (optional) options • Route options in JSON format (optional) schedule • Route schedule in JSON format (optional) on_share • Apply the rule to studies shared into the namespace (optional) on_harvest • Apply the rule to studies harvested into the namespace (optional) on_upload • Apply the rule to studies uploaded into the namespace - flag (optional) on_manual_route • Apply this rule for a manually routed study- flag (optional) on_thin • Apply this rule to thin studies when they are created - flag (optional) no_re_run • Do not run this rule on a re-notification from storage - flag (optional) suspended • This rule is suspended and not applied - flag (optional) delay • Number of minutes to delay running this rule for after it is triggered (optional) delay_till_schedule • Delay running this rule after it is triggered until the next scheduled time - flag (optional) other_namespaces • A comma separated list of the uuid of other namespaces to apply this rule to (optional) manual_roles • A comma separated list of the uuid of roles that can run the rule manually (optional) |
| Returns |
status • OK |
| Permission | route_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The route can not be found NOT_PERMITTED • You are not permitted to edit the route INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field INVALID_CONDITION • A condition is invalid. The error_subtype holds the condition INVALID_ACTION • An action is invalid. The error_subtype holds the error detail INVALID_OPTION • An option is invalid. The error_subtype holds the error detail INVALID_SCHEDULE • The schedule is invalid. The error_subtype holds the error detail INVALID_OTHER_NAMESPACES • The other_namespaces is invalid. The error_subtype holds the error detail INVALID_MANUAL_ROLES • The manual_roles is invalid. The error_subtype holds the error detail |
| Notes | See the /route/add command notes for the format of the conditions and actions fields |
| Description | Get a routing rule |
|---|---|
| URL | /route/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The route uuid |
| Returns |
status • OK name • Name of the route namespace_id • uuid of the namespaces the route is associated with namespace_name • Name of the namespaces the route is associated with conditions • Route conditions as a JSON structure actions • Route actions as a JSON structure options • Route actions as a JSON structure schedule • Route schedule in JSON format on_share • Apply the rule to studies shared into the namespace - flag on_harvest • Apply the rule to studies harvested into the namespace - flag on_upload • Apply the rule to studies uploaded into the namespace - flag on_manual_route • Apply this rule for a manually routed study- flag on_thin • Apply this rule to thin studies when they are created - flag no_re_run • Do not run this rule on a re-notification from storage - flag suspended • This rule is suspended and not applied - flag delay • Number of minutes to delay running this rule for after it is triggered delay_till_schedule • Delay running this rule after it is triggered until the next scheduled time - flag capture_email • Does an email need to be captured to run this rule - flag other_namespaces • A comma separated list of the uuid of other namespaces to apply this rule to manual_roles • A comma separated list of the uuid of roles that can run the rule manually |
| Permission | route_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The route can not be found NOT_PERMITTED • You are not permitted to view the route |
| Notes |
| Description | Delete a routing rule |
|---|---|
| URL | /route/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The route uuid |
| Returns |
status • OK |
| Permission | route_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The route can not be found NOT_PERMITTED • You are not permitted to delete the route |
| Notes |
| Description | Test the matching on PHYSICIAN_ALIAS |
|---|---|
| URL | /route/physician/alias/match |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account to test in lv • The tag text to match against the PHYSICIAN_ALIAS rule. |
| Returns |
status • OK users • An array of the users that matched the tag. Each object holds the fields from the /account/user/get call excluding the locations and groups fields |
| Permission | route_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to do this |
| Notes |
Account (organization) commands
| Description | List the accounts the user belongs to |
|---|---|
| URL | /account/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) permissions • Flag to return the users role and permissions in the accounts (optional) |
| Returns |
status • OK page • The pagination status hash accounts • An array of the accounts. Each object holds the following same fields as the /account/get call --- The following field fields are append to the account objects if the permissions flag is specified --- * permissions • The users permissions in the account * role_id • uuid of the users account role * role_name • Name of the users account role * default_role_id • uuid of the default account role * default_role_name • Name of the default account role |
| Errors | |
| Notes |
| Description | Save an account |
|---|---|
| URL | /account/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The account uuid name • Name of the account (optional) vanity • Vanity host name for the account. Multiple host names can be specified in a comma separate list (optional) password_expire • Number of days before account passwords expire. No expiration if zero. (optional) session_expire • Number of minutes before an idle session expires. (optional) must_approve • Flag if shared studies must be approved for the account namespace (optional) must_approve_upload • Flag if uploaded studies must be approved (optional) must_approve_harvest • Flag if harvested studies must be approved (optional) no_share • Flag if studies can not be shared with this account (optional). Studies can still be shared with locations, groups and users in the account. can_request • Flag if user can request to join the account share_code • The share code of the account (optional) share_description • The share description of the account (optional) share_settings • Share settings JSON structure of the share display settings (optional) share_via_gateway • Flag if a gateway share is allowed (optional) hl7_template • The HL7 reporting template for the account (optional) search_threshold • The number of studies record in the namespace to switch the UI from list to search mode (optional) settings • A hash of the account settings (optional) setting_SETTING_NAME • Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional) css • Custom CSS for the account (optional) vendor • Vendor name (optional) role_id • Id for the default role for the account (optional) customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) |
| Returns |
status • OK |
| Permission | account_edit |
| Errors |
NOT_FOUND • The object was not found. The error_subtype holds the name of field that triggered the error NOT_PERMITTED • You are not permitted to modify this record DUPLICATE_NAME • The account name is already taken DUPLICATE_VANITY • The vanity host name is already taken. The error_subtype holds the taken hostname INVALID_VANITY • The vanity host name is invalid. The error_subtype holds the invalid hostname INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag DUP_SHARE_CODE • The share code is already used INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details INVALID_INTEGER • An invalid integer was passed. The error_subtype holds the name of the invalid integer INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field |
| Notes |
|
| Description | Get an account |
|---|---|
| URL | /account/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The account uuid permissions • Flag to return the users role and permissions in the accounts (optional) brand_settings • A comma delimited list of the settings from /brand/get for this vanity to return (optional) |
| Returns |
status • OK uuid • Account uuid name • Name of the account vanity • Vanity host name(s) for the account password_expire • Number of days before account passwords expire. session_expire • Number of minutes before an idle session expires. namespace_id • Namespace of the account must_approve • Flag if shared studies must be approved must_approve_upload • Flag if uploaded studies must be approved must_approve_harvest • Flag if harvested studies must be approved no_share • Flag to stop sharing into this namespace can_request • Flag if user can request to join the account share_code • The share code of the account share_description • The share description of the account share_settings • Share settings JSON structure of the share display settings share_via_gateway • Flag if a gateway share is allowed hl7_template • The HL7 reporting template for the account search_threshold • The number of studies record in the namespace to switch the UI from list to search mode css • The account CSS settings vendor • Vendor name role_id • Id of the default role for the account role_name • Name of the default role for the account settings • A hash of the account settings and brand settings (returned as brand_(SETTING NAME) connected • Flag if they are connected to a payment processor tags • An array of user tags associated with this object (This is only returned if the object has tags) customfields • An array of the custom fields associated with this account. Each object has the following fields (This is only returned if the group has custom fields) --- The following field fields are returned if the permissions flag is specified --- * permissions • The users permissions in the account * role_id • uuid of the users account role * role_name • Name of the users account role * default_role_id • uuid of the default account role * default_role_name • Name of the default account role * has_activity_permission • Flag if the user has activity permissions within the account |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found |
| Notes |
| Description | Add a user to an account |
|---|---|
| URL | /account/user/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The account uuid (email|user_id) • The email address or uuid of the user to add role_id • uuid of the users role in the account (optional). account_email • Users account_email. Only set this if it is different than the users login email (optional). account_alias • Users alias in the account. (optional). account_login • Users login name in the account. (optional). account_password • Password for the account_password. (optional). password_reset • Flag if the password needs to be reset. (optional). global • Flag if this is a global user. (optional). session_expire • Number of minutes before an idle session expires. (optional) max_sessions • Over-ride value for the max number of simultaneous sessions the user can have. (optional). event_share • Notify the user on a share into the account namespace (optional) event_approve • Notify the user on a approval needed into the account namespace (optional) event_upload • Notify the user on an upload into the account namespace (optional) event_upload_fail • Notify the user on a failed upload into the account namespace (optional) event_harvest • Notify the user on a harvest into the account namespace (optional) event_join • Notify the user on a join request for the account (optional) event_purge • Notify the user the results of a purge job for the account (optional) event_new_report • Notify the user when a report is attached in the account namespace (optional) event_report_remove • Notify the user when a report is removed in the account namespace (optional) event_study_comment • Notify the user when a comment is attached to a study in the namespace (optional) event_status_change • Notify the user when the status of a study is changed (optional) event_message • Notify the user when a message is sent to the account namespace (optional) event_node • Notify the user when an account node sends an event (optional) event_link • Notify the user when an anonymous link is hit in the namespace (optional) event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace (optional) event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds (optional) event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails (optional) event_case_assignment • Notify the user when they are assigned a case as a medical or admin user (optional) settings • A hash of the account settings that the user can override (optional) setting_SETTING_NAME • Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional) |
| Returns |
status • OK uuid • uuid of the user |
| Permission | account_user_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to add this user to the account USER_NOT_FOUND • The user can not be found ALREADY_EXISTS • The user is already a member of the account INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag DUPLICATE_NAME • The account_login is already in use BAD_PASSWORD • Password needs to be at least 8 characters long, contain at least two numbers, contain at least two characters and can't be one of your last three passwords INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details |
| Notes |
|
| Description | Edit the users account information |
|---|---|
| URL | /account/user/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The account uuid user_id • The users uuid role_id • uuid of the users role in the account (optional). account_email • Users account_email. Only set this if it is different than the users login email (optional). account_alias • Users alias in the account. (optional). account_login • Users login name in the account. (optional). account_password • Password for the account_password. (optional). password_reset • Flag if the password needs to be reset. (optional). global • Flag if this is a global user. (optional). session_expire • Number of minutes before an idle session expires. (optional) max_sessions • Over-ride value for the max number of simultaneous sessions the user can have. (optional). event_share • Notify the user on a share into the account namespace (optional) event_approve • Notify the user on a approval needed into the account namespace (optional) event_upload • Notify the user on an upload into the account namespace (optional) event_upload_fail • Notify the user on a failed upload into the account namespace (optional) event_harvest • Notify the user on a harvest into the account namespace (optional) event_join • Notify the user on a join request for the account (optional) event_purge • Notify the user the results of a purge job for the account (optional) event_new_report • Notify the user when a report is attached in the account namespace (optional) event_report_remove • Notify the user when a report is removed in the account namespace (optional) event_study_comment • Notify the user when a comment is attached to a study in the namespace (optional) event_status_change • Notify the user when the status of a study is changed (optional) event_message • Notify the user when a message is sent to the account namespace (optional) event_node • Notify the user when an account node sends an event (optional) event_link • Notify the user when an anonymous link is hit in the namespace (optional) event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace (optional) event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds (optional) event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails (optional) event_case_assignment • Notify the user when they are assigned a case as a medical or admin user (optional) customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) settings • A hash of the account settings that the user can override (optional) setting_SETTING_NAME • Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional) |
| Returns |
status • OK |
| Permission | account_user_edit or the user can set the event flags and custom fields for themselves |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to edit this user USER_NOT_FOUND • The user can not be found or is not a member of this account ROLE_NOT_FOUND • The role was not found or is not an account role INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag DUPLICATE_NAME • The account_login is already in use BAD_PASSWORD • Password needs to be at least 8 characters long, contain at least two numbers, contain at least two characters and can't be one of your last three passwords INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details CAN_NOT_PROMOTE • A user can not switch themselves to an admin role if they are currently not in an admin role NO_USER_OVERRIDE • The setting does not allow a user override |
| Notes | The same account_email can be used for multiple users in an account. It does not have to be unique. |
| Description | Get the users account information |
|---|---|
| URL | /account/user/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The account uuid user_id • The users uuid |
| Returns |
status • OK user_id • The user id user_name • The user name user_email • The users email address role_id • uuid of the users account role role_name • Name of the users account role disabled • Is the user disabled account_email • Email address for account usage account_alias • Users account alias account_login • Users login name in the account password_reset • Flag if the password needs to be reset user_account_id • Id linking user and account for external integrations global • Flag if this is a global user. session_expire • Number of minutes before an idle session expires max_sessions • Over-ride value for the max number of simultaneous sessions the user can have event_share • Notify the user on a share into the account namespace event_approve • Notify the user on a approval needed into the account namespace event_upload • Notify the user on an upload into the account namespace event_upload_fail • Notify the user on a failed upload into the account namespace event_harvest • Notify the user on a harvest into the account namespace event_join • Notify the user on a join request for the account event_purge • Notify the user the results of a purge job for the account event_new_report • Notify the user when a report is attached in the account namespace event_report_remove • Notify the user when a report is removed in the account namespace event_study_comment • Notify the user when a comment is attached to a study in the namespace event_status_change • Notify the user when the status of a study is changed event_message • Notify the user when a message is sent to the account namespace event_node • Notify the user when an account node sends an event event_link • Notify the user when an anonymous link is hit in the namespace event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds (optional) event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails (optional) event_case_assignment • Notify the user when they are assigned a case as a medical or admin user (optional) groups • An array of the accounts groups the user is a member of locations • An array of the accounts locations the user is a member of. Both of these contain the following fields. * uuid • uuid of the group/location * name • name of the group/location * role_id • uuid of the role in the group/location * role_name • name of the role in the group/location tags • An array of user tags associated with this object (This is only returned if the object has tags) customfields • An array of the custom fields associated with this user. Each object has the following fields (This is only returned if the user has custom fields) settings • A hash of the account settings that the user has overridden |
| Permission | account_user_view or the user can get the information for themselves |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found USER_NOT_FOUND • The user can not be found or is not a member of this account |
| Notes |
| Description | Delete a user from the account |
|---|---|
| URL | /account/user/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The account uuid user_id • The user uuid |
| Returns |
status • OK |
| Permission | account_user_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to delete this user USER_NOT_FOUND • The user can not be found or is not a member of this account |
| Notes | The user will also be deleted from all groups and locations in the account |
| Description | List the users in an account |
|---|---|
| URL | /account/user/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The account uuid filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Permission | account_user_view or case_edit |
| Returns |
status • OK page • The pagination status hash users • An array of the users. Each object holds the fields from the /account/user/get call excluding the locations and groups fields |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to list the users in this account |
| Notes |
| Description | Build a user login report |
|---|---|
| URL | /account/user/report/login |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The account uuid user_id • Limit to this user_id (optional) |
| Permission | account_user_view |
| Returns |
status • OK report_id • The report id |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to list the users in this account |
| Notes | This call will kick off the building of the report. Poll for the report status with /report/status command and download it with the /report/zip command. |
| Description | Set a rule on who can share with whom |
|---|---|
| URL | /account/can/share |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account id by_type • The type of object that can share. (user|account|group|location) by_id • The uuid of the object that can share with_type • The type of object that they can share with (user|account|group|location) with_id • The uuid of the object that they can share with |
| Returns |
status • OK |
| Permission | account_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to perform this action BY_NOT_FOUND • The "by" object can not be found WITH_NOT_FOUND • The "with" object can not be found INVALID_TYPE • The type of object is invalidate. The error_subtype holds the type that is invalid |
| Notes |
| Description | Stop a account share rule |
|---|---|
| URL | /account/can/share/stop |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account id by_type • The type of object that can share. (user|account|group|location) by_id • The uuid of the object that can share with_type • The type of object that they can share with (user|account|group|location) with_id • The uuid of the object that they can share with |
| Returns |
status • OK |
| Permission | account_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to perform this action BY_NOT_FOUND • The "by" object can not be found WITH_NOT_FOUND • The "with" object can not be found INVALID_TYPE • The type of object is invalidate. The error_subtype holds the type that is invalid |
| Notes |
| Description | Get a list of the account share rules |
|---|---|
| URL | /account/can/share/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account id |
| Returns |
status • OK rules • An array of the account share rules. Each rule holds the following fields. * by_type • The type of object that can share. (user|account|group|location) * by_id • The uuid of the object that can share * by_name • The name of the object that can share * with_type • The type of object that they can share with (user|account|group|location) * with_id • The uuid of the object that they can share with * with_name • The name of the object that they can share with |
| Permission | account_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to perform this action |
| Notes |
| Description | Get any customized css for the account |
|---|---|
| URL | /account/css |
| Parameters |
(account_id|vanity) • The account_id or vanity name to get the css for (optional) |
| Returns | A CSS file |
| Errors | |
| Notes |
| Description | Get the settings for an account |
|---|---|
| URL | /account/settings |
| Parameters |
sid • The session id (optional if not passed then only un-authenticated settings are returned) (account_id|vanity) • The account_id or vanity name to get the settings for settings • A comma delimited list of the settings to return (optional) brand_settings • A comma delimited list of the settings from /brand/get for this vanity to return (optional) namespace_id • Apply overrides for the namespace (optional) |
| Returns |
status • OK settings • A hash of the account settings, brand settings (returned as brand_(SETTING NAME), and vanity registration customfields if defined |
| Errors |
NOT_FOUND • The account or namespace can not be found |
| Notes |
| Description | Connect the account to the payment processor |
|---|---|
| URL | /account/connect |
| Parameters |
sid • The session id uuid • The account_id code • The OAuth code |
| Returns |
status • OK |
| Permission | account_edit |
| Errors |
NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to do this TOKEN_FAILED • The OAuth code did not return a valid token from the processor |
| Notes |
| Description | Return a counter value for the passed MD5 value |
|---|---|
| URL | /account/md5/counter |
| Parameters |
(sid || node_id && serial_no) • Either a sid or the node id and serial number uuid • UUID of the account (only needed for sid authentication) md5 • The MD5 value |
| Returns |
status • OK counter • The numeric counter value |
| Errors |
NOT_FOUND • The account can not be found or the user is not a part of it |
| Notes | If the MD5 does not exist for the account a new counter value will be created. If it does exist the old counter value will be returned. |
Location commands
| Description | List the locations for an account |
|---|---|
| URL | /location/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash locations • An array of the locations. Each object holds the following same fields as the /location/get call |
| Permission | location_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view this list |
| Notes |
| Description | Add a location |
|---|---|
| URL | /location/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) name • Name of the location account_id • uuid of the account must_approve • Flag if shared studies must be approved for the location (optional) must_approve_upload • Flag if uploaded studies must be approved (optional) must_approve_harvest • Flag if harvested studies must be approved (optional) no_share • Flag if studies can not be shared with this location (optional). Studies can still be shared with users in the location. share_code • The share code of the location (optional) share_description • The share description of the location (optional) share_settings • Share settings JSON structure of the share display settings (optional) share_via_gateway • Flag if a gateway share is allowed (optional) hl7_template • The HL7 reporting template for the location (optional) search_threshold • The number of studies record in the namespace to switch the UI from list to search mode (optional) role_id • Id for the default role for the location (optional) customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) |
| Returns |
status • OK uuid • The uuid namespace_id • The association namespace uuid |
| Permission | location_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields ACCOUNT_NOT_FOUND • The account was not found NOT_FOUND • The object was not found. The error_subtype holds the name of field that triggered the error NOT_PERMITTED • You are not permitted to add a location to the account INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag DUP_SHARE_CODE • The share code is already used INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field |
| Notes |
| Description | Save a location |
|---|---|
| URL | /location/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The location uuid name • Name of the location (optional) must_approve • Flag if shared studies must be approved for the location (optional) must_approve_upload • Flag if uploaded studies must be approved (optional) must_approve_harvest • Flag if harvested studies must be approved (optional) no_share • Flag if studies can not be shared with this location (optional). Studies can still be shared with users in the location. share_code • The share code of the location (optional) share_description • The share description of the location (optional) share_settings • Share settings JSON structure of the share display settings (optional) share_via_gateway • Flag if a gateway share is allowed (optional) hl7_template • The HL7 reporting template for the location (optional) search_threshold • The number of studies record in the namespace to switch the UI from list to search mode (optional) role_id • Id for the default role for the location (optional) customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) |
| Returns |
status • OK |
| Permission | location_edit |
| Errors |
NOT_FOUND • The object was not found. The error_subtype holds the name of field that triggered the error NOT_PERMITTED • You are not permitted to edit the location INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag DUP_SHARE_CODE • The share code is already used INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field |
| Notes |
| Description | Get a location |
|---|---|
| URL | /location/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The location uuid |
| Returns |
status • OK uuid • The location uuid name • Name of the location namespace_id • namespace of the location must_approve • Flag if shared studies must be approved must_approve_upload • Flag if uploaded studies must be approved must_approve_harvest • Flag if harvested studies must be approved no_share • Flag to stop sharing into this namespace share_code • The share code of the location share_description • The share description of the location share_settings • Share settings JSON structure of the share display settings share_via_gateway • Flag if a gateway share is allowed (optional) hl7_template • The HL7 reporting template for the location search_threshold • The number of studies record in the namespace to switch the UI from list to search mode (optional) tags • An array of user tags associated with this object (This is only returned if the object has tags) role_id • Id of the default role for the location role_name • Name of the default role for the location customfields • An array of the custom fields associated with this location. Each object has the following fields (This is only returned if the group has custom fields) |
| Permission | location_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The location can not be found NOT_PERMITTED • You are not permitted to view this location |
| Notes |
| Description | Delete a location |
|---|---|
| URL | /location/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The location uuid |
| Returns |
status • OK |
| Permission | location_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The location can not be found NOT_PERMITTED • You are not permitted to delete the location NOT_EMPTY • The location still has studies in it |
| Notes |
| Description | Add or update a user to a location |
|---|---|
| URL | /location/user/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The location id user_id • Id of the user role_id • Id of the users role within the location (optional). If not passed the default location role will be assigned event_share • Notify the user on a share into the location namespace (optional) event_approve • Notify the user on a approval needed into the location namespace (optional) event_upload • Notify the user on an upload into the location namespace (optional) event_upload_fail • Notify the user on a failed upload into the location namespace event_harvest • Notify the user on a harvest into the location namespace (optional) event_new_report • Notify the user when a report is attached in the location namespace (optional) event_report_remove • Notify the user when a report is removed in the location namespace (optional) event_study_comment • Notify the user when a comment is attached to a study in the namespace (optional) event_status_change • Notify the user when the status of a study is changed (optional) event_message • Notify the user when a message is sent to the location namespace (optional) event_node • Notify the user when a location node sends an event (optional) event_link • Notify the user when an anonymous link is hit in the namespace (optional) event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace (optional) event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds (optional) event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails (optional) event_case_assignment • Notify the user when they are assigned a case as a medical or admin user (optional) no_physician_alias_share • Flag to exclude this location from a physician alias share (optional) |
| Returns |
status • OK |
| Permission | location_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The location can not be found NOT_PERMITTED • You are not permitted to edit the location USER_NOT_FOUND • The user was not found or is not in the account ROLE_NOT_FOUND • The role was not found or is not in the account INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag |
| Notes |
| Description | Remove a user from a location |
|---|---|
| URL | /location/user/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The location id user_id • The user id |
| Returns |
status • OK |
| Permission | location_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The location can not be found NOT_PERMITTED • You are not permitted to edit the location |
| Notes |
| Description | List the users in a location |
|---|---|
| URL | /location/user/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The location id filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash users • An array of the users. Each object holds the following fields * user_id • The user id * user_name • The user name * role_id • The users role id * role_name • The users role name * event_share • Notify the user on a share into the location namespace * event_approve • Notify the user on a approval needed into the location namespace * event_upload • Notify the user on an upload into the location namespace * event_upload_fail • Notify the user on a failed upload into the location namespace * event_harvest • Notify the user on a harvest into the location namespace * event_new_report • Notify the user when a report is attached in the location namespace * event_report_remove • Notify the user when a report is removed in the location namespace * event_study_comment • Notify the user when a comment is attached to a study in the namespace * event_status_change • Notify the user when the status of a study is changed * event_message • Notify the user when a message is sent to the location namespace * event_node • Notify the user when a location node sends an event * event_link • Notify the user when an anonymous link is hit in the namespace * event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace * event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds * event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails * event_case_assignment • Notify the user when they are assigned a case as a medical or admin user * no_physician_alias_share • Flag to exclude this location from a physician alias share |
| Permission | location_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The location can not be found NOT_PERMITTED • You are not permitted list the users at the location |
| Notes |
Group commands
| Description | List the groups for an account |
|---|---|
| URL | /group/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash groups • An array of the groups. Each object holds the following same fields as the /group/get call |
| Permission | group_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view this list |
| Notes |
| Description | Add a group |
|---|---|
| URL | /group/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) name • Name of the group account_id • uuid of the account must_approve • Flag if shared studies must be approved for the group (optional) must_approve_upload • Flag if uploaded studies must be approved (optional) must_approve_harvest • Flag if harvested studies must be approved (optional) no_share • Flag if studies can not be shared with this group (optional). Studies can still be shared with users in the group. share_code • The share code of the group (optional) share_description • The share description of the group (optional) share_settings • Share settings JSON structure of the share display settings (optional) share_via_gateway • Flag if a gateway share is allowed (optional) hl7_template • The HL7 reporting template for the group (optional) search_threshold • The number of studies record in the namespace to switch the UI from list to search mode (optional) role_id • Id for the default role for the group (optional) customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) |
| Returns |
status • OK uuid • The uuid namespace_id • The association namespace uuid |
| Permission | group_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields ACCOUNT_NOT_FOUND • The account was not found NOT_FOUND • The object was not found. The error_subtype holds the name of field that triggered the error NOT_PERMITTED • You are not permitted to add a group to that account INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag DUP_SHARE_CODE • The share code is already used INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field |
| Notes |
| Description | Save a group |
|---|---|
| URL | /group/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The group uuid name • Name of the group (optional) must_approve • Flag if shared studies must be approved for the group (optional) must_approve_upload • Flag if uploaded studies must be approved (optional) must_approve_harvest • Flag if harvested studies must be approved (optional) no_share • Flag if studies can not be shared with this group (optional). Studies can still be shared with users in the group. share_code • The share code of the group (optional) share_description • The share description of the group (optional) share_settings • Share settings JSON structure of the share display settings (optional) share_via_gateway • Flag if a gateway share is allowed (optional) hl7_template • The HL7 reporting template for the group (optional) search_threshold • The number of studies record in the namespace to switch the UI from list to search mode (optional) role_id • Id for the default role for the group (optional) customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) |
| Returns |
status • OK |
| Permission | group_edit |
| Errors |
NOT_FOUND • The object was not found. The error_subtype holds the name of field that triggered the error NOT_PERMITTED • You are not permitted to edit the location INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag DUP_SHARE_CODE • The share code is already used INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field |
| Notes |
| Description | Get a group |
|---|---|
| URL | /group/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The group uuid |
| Returns |
status • OK uuid • The group uuid name • Name of the group namespace_id • Namespace of the group must_approve • Flag if shared studies must be approved must_approve_upload • Flag if uploaded studies must be approved must_approve_harvest • Flag if harvested studies must be approved no_share • Flag to stop sharing into this group share_code • The share code of the group share_description • The share description of the group share_settings • Share settings JSON structure of the share display settings share_via_gateway • Flag if a gateway share is allowed (optional) hl7_template • The HL7 reporting template for the group search_threshold • The number of studies record in the namespace to switch the UI from list to search mode tags • An array of user tags associated with this object (This is only returned if the object has tags) role_id • Id of the default role for the group role_name • Name of the default role for the group customfields • An array of the custom fields associated with this group. Each object has the following fields (This is only returned if the group has custom fields) |
| Permission | group_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The group can not be found NOT_PERMITTED • You are not permitted to view this group |
| Notes |
| Description | Delete a group |
|---|---|
| URL | /group/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The group uuid |
| Returns |
status • OK |
| Permission | group_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The group can not be found NOT_PERMITTED • You are not permitted to delete this group NOT_EMPTY • The group still has studies in it |
| Notes |
| Description | Add or update a user to a group |
|---|---|
| URL | /group/user/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The group id user_id • Id of the user role_id • Id of the users role within the group (optional). If not passed the default group role will be assigned event_share • Notify the user on a share into the group namespace (optional) event_approve • Notify the user on a approval needed into the group namespace (optional) event_upload • Notify the user on an upload into the group namespace (optional) event_upload_fail • Notify the user on a failed upload into the group namespace (optional) event_harvest • Notify the user on a harvest into the group namespace (optional) event_new_report • Notify the user when a report is attached in the group namespace (optional) event_report_remove • Notify the user when a report is removed in the group namespace (optional) event_study_comment • Notify the user when a comment is attached to a study in the namespace (optional) event_status_change • Notify the user when the status of a study is changed (optional) event_message • Notify the user when a message is sent to the group namespace (optional) event_node • Notify the user when a group node sends an event (optional) event_link • Notify the user when an anonymous link is hit in the namespace (optional) event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace (optional) event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds (optional) event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails (optional) event_case_assignment • Notify the user when they are assigned a case as a medical or admin user (optional) no_physician_alias_share • Flag to exclude this group from a physician alias share (optional) |
| Returns |
status • OK |
| Permission | group_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The group can not be found NOT_PERMITTED • You are not permitted to edit the group USER_NOT_FOUND • The user was not found or is not in the account ROLE_NOT_FOUND • The role was not found or is not in the account INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag |
| Notes |
| Description | Remove a user from a group |
|---|---|
| URL | /group/user/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The group id user_id • Id of the user |
| Returns |
status • OK |
| Permission | group_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The group can not be found NOT_PERMITTED • You are not permitted to edit the group |
| Notes |
| Description | List the users in a group |
|---|---|
| URL | /group/user/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The group id filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash users • An array of the users. Each object holds the following fields * user_id • The user id * user_name • The user name * role_id • The users role id * role_name • The users role name * event_share • Notify the user on a share into the group namespace * event_approve • Notify the user on a approval needed into the group namespace * event_upload • Notify the user on an upload into the group namespace * event_upload_fail • Notify the user on a failed upload into the group namespace * event_harvest • Notify the user on a harvest into the group namespace * event_new_report • Notify the user when a report is attached in the group namespace * event_report_remove • Notify the user when a report is removed in the group namespace * event_study_comment • Notify the user when a comment is attached to a study in the namespace * event_status_change • Notify the user when the status of a study is changed * event_message • Notify the user when a message is sent to the group namespace * event_node • Notify the user when a group node sends an event * event_link • Notify the user when an anonymous link is hit in the namespace * event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace * event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds * event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails * event_case_assignment • Notify the user when they are assigned a case as a medical or admin user * no_physician_alias_share • Flag to exclude this group from a physician alias share |
| Permission | group_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The group can not be found NOT_PERMITTED • You are not permitted list the group |
| Notes |
Role commands
| Description | List the roles for an account |
|---|---|
| URL | /role/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash roles • An array of the roles. Each object holds the following same fields as the /role/get call |
| Permission | role_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view this list |
| Notes |
| Description | Add a role |
|---|---|
| URL | /role/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) name • Name of the role account_id • uuid of the account permissions • A hash of the role permissions (optional) |
| Returns |
status • OK uuid • The uuid |
| Permission | role_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields ACCOUNT_NOT_FOUND • The account was not found NOT_PERMITTED • You are not permitted to add a role to that account INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field INVALID_PERMISSION • Invalid permission flag. The error_subtype holds the name of the permission flag. INVALID_PERMISSION_VALUE • The permission flag has an invalid value. The error_subtype holds the name of the permission flag. |
| Notes | If permissions are not passed the role is given the default set of permissions |
| Description | Save a role |
|---|---|
| URL | /role/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The role uuid name • Name of the role (optional) description • Description of the role (optional) permissions • A hash of the role permissions (optional) permission_PERMISSION_NAME • Set an individual permission. This is an alternative to the permissions hash for easier use in the API tester (optional) |
| Returns |
status • OK |
| Permission | role_edit |
| Errors |
NOT_FOUND • The role can not be found NOT_PERMITTED • You are not permitted to edit the role INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field INVALID_PERMISSION • Invalid permission flag. The error_subtype holds the name of the permission flag. INVALID_PERMISSION_VALUE • The permission flag has an invalid value. The error_subtype holds the name of the permission flag. NO_OTHER_ROLE_EDIT • No other role has role_edit permissions so you can not disable role_edit for this role |
| Notes | The permissions hash does not need to be complete. It can include only the items you want to update or the entire set. |
| Description | Get a role |
|---|---|
| URL | /role/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The role uuid |
| Returns |
status • OK uuid • The role uuid name • Name of the role description • Description of the role. type • Type of the role. If it is system generated this will be either admin or user permissions • The role permissions as a JSON hash |
| Permission | role_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The role can not be found NOT_PERMITTED • You are not permitted to view this role |
| Notes |
| Description | Delete a role |
|---|---|
| URL | /role/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The role uuid |
| Returns |
status • OK |
| Permission | role_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The role can not be found NOT_PERMITTED • You are not permitted to delete this role IN_USE • The role is in use. The error_subtype holds a array of the objects that are using it |
| Notes |
| Description | Get the default permissions |
|---|---|
| URL | /role/default/permissions |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account id (optional) |
| Returns |
status • OK permissions • A hash of the permissions. Each key is a permission and the value list is the default admin/user values as per the permissions documentation |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields |
| Notes |
| Description | Build a detailed role report |
|---|---|
| URL | /role/report/detail |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account id |
| Returns |
status • OK report_id • The report id |
| Permission | role_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account was not found NOT_PERMITTED • You are not permitted to run this report REPORT_ERROR • Unable to start the report |
| Notes | This call will kick off the building of the report. Poll for the report status with /report/status command and download it with the /report/zip command. |
Activity commands
| Description | List the activities for the user |
|---|---|
| URL | /activity/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • Limit to activities in this account and the personal activities filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) strict_account_filter • Flag to apply the account_id to personal activites as well (optional) |
| Returns |
status • OK page • The pagination status hash activities • An array of the activities. Each object holds the same fields as the /activity/get call |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields |
| Notes |
| Description | Count the activities for the user |
|---|---|
| URL | /activity/list/count |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • Limit to activities in this account and the personal activities filter.* Filters (optional) |
| Returns |
status • OK count • Count of the activities |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields RUNNING • This call is currently runnning for the user |
| Notes |
| Description | Get the activity |
|---|---|
| URL | /activity/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The activity uuid |
| Returns |
status • OK uuid • The activity uuid created • The date and time the activity was created. created_by • The name of the user who created the activity. type • Type of activities. Based on the type different fields are returned as follows
|
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The activity was not found NOT_PERMITTED • You are not permitted to access this activity |
| Notes |
|
| Description | Delete an activity |
|---|---|
| URL | /activity/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The activity uuid |
| Returns |
status • OK |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The activity was not found NOT_PERMITTED • You are not permitted to delete this activity |
| Notes |
Audit commands
| Description | Audit the changes to an object |
|---|---|
| URL | /audit/object |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The uuid of the object to audit filter.* • Filters (optional) page.* Pagination (optional) reverse • Flag to reverse the default sort order (optional) download • Flag to create a zipped CSV file. A report_id will be returned and the file can be accessed via /report/status and /report/zip (optional) customfield_detail • Flag to include the customfield name in the detail (optional) |
| Returns |
status • OK report_id • The report id if the download flag was set. The rest of the parameters will not be returned (optional) page • The pagination status hash events • An array of the events associated with this object. Each object in the array will have the following fields * uuid • uuid of the object * action • The type of change or event * what • Name of the object the action was on * who • Name of the user who did this * proxy • Name of the proxy user who did this if the action was done by a proxy * when • Date and time * type • Type of object the action was on * detail • Details - see the notes * with • If this event involves another entity (e.g. a share) this field will exist and have the name of the other entity (optional) * track • A JSON hash of tracking keys and values if tracking is applied to this event (optional) * client_address • IP address that performed the action * sid • sid that performed the action |
| Permission | audit_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to access this object NOT_FOUND • The object was not found |
| Notes |
|
| Description | Audit what a user has done in an account |
|---|---|
| URL | /audit/user |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) user_id • The id of the user to audit account_id • The id of the account page.* Pagination (optional) reverse • Flag to reverse the default sort order (optional) download • Flag to create a zipped CSV file. A report_id will be returned and the file can be accessed via /report/status and /report/zip (optional) |
| Returns |
status • OK report_id • The report id if the download flag was set. The rest of the parameters will not be returned (optional) page • The pagination status hash events • An array of the events associated with this object. Each object in the array will have the following fields * uuid • uuid of the object * action • The type of change or event * what • Name of the object the action was on * who • Name of the user who did this * proxy • Name of the proxy user who did this if the action was done by a proxy * when • Date and time * type • Type of object the action was on * detail • Details - see the notes in /audit/object * with • If this event involves another entity (e.g. a share) this field will exist and have the name of the other entity (optional) * track • A JSON hash of tracking keys and values if tracking is applied to this event (optional) * client_address • IP address that performed the action * sid • sid that performed the action |
| Permission | audit_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to access this user record NOT_FOUND • The user was not found |
| Notes |
|
| Description | Audit all events in an account |
|---|---|
| URL | /audit/account |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The id of the account filter.* • Filters (optional) page.* • Pagination (optional) reverse • Flag to reverse the default sort order (optional) download • Flag to create a zipped CSV file. A report_id will be returned and the file can be accessed via /report/status and /report/zip (optional) |
| Returns |
status • OK report_id • The report id if the download flag was set. The rest of the parameters will not be returned (optional) page • The pagination status hash events • An array of the events associated with this object. Each object in the array will have the following fields * uuid • uuid of the object * action • The type of change or event * what • Name of the object the action was on * who • Name of the user who did this * proxy • Name of the proxy user who did this if the action was done by a proxy * when • Date and time * type • Type of object the action was on * detail • Details - see the notes in /audit/object * with • If this event involves another entity (e.g. a share) this field will exist and have the name of the other entity (optional) * track • A JSON hash of tracking keys and values if tracking is applied to this event (optional) * client_address • IP address that performed the action * sid • sid that performed the action |
| Permission | audit_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to access this information NOT_FOUND • The account was not found |
| Notes |
|
| Description | Return deleted records |
|---|---|
| URL | /audit/deleted |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The id of the account type • The type of the object (Study|User etc.) page.* Pagination (optional) |
| Returns |
status • OK page • The pagination status hash objects • An array of the objects . Each object in the array will have the following fields * uuid • uuid of the deleted object * who • Name of the user who deleted the object * proxy • Name of the proxy user who did this if the action was done by a proxy * when • Date and time * client_address • IP address that performed the action * sid • sid that performed the action |
| Permission | audit_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to access this record |
| Notes | Use the uuid to retrieve the full history from /audit/object |
| Description | Log a message |
|---|---|
| URL | /audit/log |
| Parameters |
sid • sid (optional) bucket • Name of the bucket to log to The rest of the parameters are logged to a message in the bucket |
| Returns |
status • OK |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_BUCKET • The bucket name can only contain A-z characters and must be between 4 and 16 characters long |
| Notes |
| Description | Get the failed login events |
|---|---|
| URL | /audit/failedlogins |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The id of the account from_time • Only return events after the epoch time (optional) |
| Returns |
status • OK events • An array of the events. Each event is an array with the following fields * Epoch time of the event * LOCKOUT if the login failed due to the lockout or PRIMARY if the login failed due to invalid credentials * The vanity of the event * The client IP address * The rest of the fields hold the email and account information depending on the parameters used for /session/login |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to access this information NOT_FOUND • The account was not found |
| Notes | Collection of this data needs to be enabled via the audit_failed_logins account switch |
Namespace commands
| Description | Get the study permissions for the namespace |
|---|---|
| URL | /namespace/permissions |
| Parameters |
(sid|uuid&serial_no) • Either the sid or the node id and serial number (namespace_id|study_id|study_uid && storage_namespace && phi_namespace) The uuid of the namespace or study or the study_uid/storage_namespace/phi_namespace triplet oauth • Flag to return the OAuth token information for the user (optional) |
| Returns |
status • OK study_edit • The permission flag setting ↳ study_edit_approved • The permission flag setting ↳ study_edit_unapproved • The permission flag setting study_download • The permission flag setting study_browse • The permission flag setting study_share • The permission flag setting ↳ study_share_email • The permission flag setting ↳ study_share_share_code • The permission flag setting ↳ study_share_account • The permission flag setting ↳ study_share_location • The permission flag setting ↳ study_share_group • The permission flag setting ↳ study_share_user • The permission flag setting ↳ study_share_rsna • The permission flag setting ↳ study_share_npi • The permission flag setting study_push • The permission flag setting study_delete • The permission flag setting study_approve • The permission flag setting study_view • The permission flag setting study_upload • The permission flag setting study_report_upload • The permission flag setting study_report_delete • The permission flag setting study_sync • The permission flag setting study_merge • The permission flag setting reports • A JSON array of the report ids they can view. This is not returned if they can view all reports oauth • A JSON hash containing the the OAuth token and ttl |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_CREDENTIALS • The sid or node credentials are invalid NOT_FOUND • The object was not found |
| Notes |
| Description | Set/get the settings for the namespace |
|---|---|
| URL | /namespace/settings |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The uuid of the namespace no_dup_share • Flag to stop duplicate studies (same study_uid and image count) from getting shared into the namespace study_field_flags • A JSON hash of study_field_* role values to override the role values for studies in the namespace ------ The following account settings can be over-ridden in the namespace ------ enable_dicom_wrapping • Value for the setting auto_enable_dicom_wrapping • Value for the setting single_file_dicom_wrapping • Value for the setting disable_duplicate_study_upload • Value for the setting enable_multipart_uploader • Value for the setting link_defaults • Value for the setting upload_settings • Value for the setting auto_create_patient • Value for the setting enable_epic_patient_lookup • Value for the setting ui_json • Value for the setting cloud_storage_config • Value for the setting pixel_anonymize_color • Value for the setting priority_notifications • Value for the setting And all the ai_* settings |
| Returns |
status • OK no_dup_share • The setting value study_field_flags • The setting value ------ Account settings that have been over-ridden in the namespace ------ |
| Permission | account_edit or ownership for a PHR namespace to modify the settings |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The namespace was not found INVALID_SETTING • An invalid setting was passed. The error_subtype holds the name of the invalid setting INVALID_SETTING_VALUE • An invalid setting value was passed. The error_subtype holds the name of the setting with the invalid value |
| Notes |
| Description | Validate and get the full description of a share code |
|---|---|
| URL | /namespace/share_code |
| Parameters |
(share_code|namespace_id) • The share code or namespace id (sid || uuid && serial_no) • Either the sid or the node id and serial number (optional) |
| Returns |
status • OK share_code • The share code share_description • The share description share_settings • Share settings JSON structure of the share display settings share_type • What are you sharing with (account|location|group|user) share_name • The name of what you are sharing with namespace_id • Namespace for the share code account_id • Id of the account currency • 3-letter ISO code for currency to charge in (optional - see notes) charge_description • The description of the charge (optional - see notes) second_opinion_share • Flag if this is a second opinion workflow (optional) second_opinion_config • JSON configuration for the second opinion workflow (optional) second_opinion_case • The second opinion case. The fields are per /case/get (optional) pricing • Pricing table in JSON format. (optional - see notes) case_pricing • Pricing table in JSON format. (optional - see notes) sum_case_price_matches • A flag to be used with case_pricing pricing table payment_processor • JSON hash of the payment processor information (optional) cc_description • A description of the users credit card on file (optional - see notes) enable_dicom_wrapping • Is dicom wrapping enabled for the associated account enable_dicom_deidentification • Is the dicom de-identification tool enabled for the associated account enable_dicomdir_scan • Is dicomdir scanning enabled for the associated account consolidate_wrapped_jpegs • Is consolidated wrapped jpegs enabled for the associated account upload_one_study • Only allow one study to be selected and uploaded render_wrapped_pdf • Value of the flag for the associated account render_wrapped_avi • Value of the flag for the associated account render_wrapped_video • Value of the flag for the associated account sr_render_css • Value of the flag for the associated account auto_wrap_images • Value of the flag for the associated account reencode_dicom_mp4 • Value of the flag for the associated account duplicate_study_check • Value of the flag for the associated account disable_duplicate_study_upload • Flag for the setting confirm_before_upload • Value of the flag for the associated account study_download_no_reports • Value of the flag for the associated account case_charge_by_modality • Value of the flag for the associated account auto_enable_dicom_wrapping • Flag for the setting single_file_dicom_wrapping • Flag for the setting enable_multipart_uploader • Flag for the setting upload_select_none • Flag for the setting hide_help_tool • Flag for the setting is_production • Flag if this is a production site is_anonymous • Flag if this is an anonymous upload anonymize_rules • If the upload should anonymize the study this will hold the rules from the /namespace/anonymize calls dicom_tag_map • If the upload should anonymize the study this will hold the dicom tag to name map prompt_for_anonymize • Flag to prompt if the anonymization rules should be applied batch_encode_cine • Value of the flag for the associated account encapsulate_wrapped_pdf • Value of the flag for the associated account dicom_deidentification_at_ingress • Value of the flag for the associated account upload_settings • Value of the namespace setting customfields • An array of the custom fields that should be captured during the share process ordered by display_order. Each object has the following fields plus these additional fields. (This is only returned if the share has custom fields). If a sid is passed all custom fields for the namespace will be returned * capture_on_share_code • Should the field be capture on the share code * wrapped_dicom_only • Only capture for wrapped DICOM uploads link_parameters • A JSON hash of any additional parameters generated by a link usage (optional) permissions • The namespace permissions |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The share code was not found or if gateway credentials are passed is not valid for gateway uploads INVALID_LINK • The anonymous upload link is no longer valid |
| Notes |
Namespace share_settings is a JSON hash; keys are the action, value are specific to the action and defined here:
|
| Description | Set/get the price for sharing with a namespace, also enable and configure the second opinion workflow |
|---|---|
| URL | /namespace/share/pricing |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The uuid of the namespace currency • 3-letter ISO code for currency to charge in (USD|GBP) (optional) charge_description • The description of the charge (optional) pricing • Pricing table in JSON format (optional) second_opinion_share • Flag to enable/disable the second opinion workflow for the share (optional) second_opinion_config • JSON configuration for the second opinion workflow (optional) |
| Returns |
status • OK currency • 3-letter ISO code for currency to charge in is_production • Flag if this is a production site charge_description • The description of the charge pricing • Pricing table in JSON format. second_opinion_share • Flag to enable/disable the second opinion workflow for the share second_opinion_config • JSON configuration for the second opinion workflow |
| Permission | account_edit if setting account_view if getting |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to price this namespace NOT_FOUND • The namespace was not found INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field NOT_HASH • The pricing field is not a hash INVALID_CURRENCY • Invalid currency NEEDS_ANY_OR_ALL • The hash needs an "ANY" or "ALL" key ONLY_ALL • If the hash has an ALL value it can't have any other values INVALID_AMOUNT • An invalid amount. The error_subtype holds the invalid amount |
| Notes |
Pricing table
|
| Description | Set/get the price for second opinion workflow, also enable and configure the second opinion workflow |
|---|---|
| URL | /namespace/case/pricing |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The uuid of the namespace case_pricing • Pricing table in JSON format (optional) sum_case_price_matches • Flag to search for all matches in pricing table and to add them up (optional) |
| Returns |
status • OK case_pricing • Pricing table in JSON format. sum_case_price_matches • Flag to search for all matches in pricing table and to add them up (optional) |
| Permission | account_edit if setting account_view if getting |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to price this namespace NOT_FOUND • The namespace was not found INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field INVALID_INTEGER • The price is not an integer number INVALID_CONDITION • The pricing condition is invalid NOT_LIST • The pricing table is not a JSON list INVALID_FLAG • The field is not a valid flag |
| Notes |
Pricing table
|
| Description | Set/get the anonymization rules for the namespace |
|---|---|
| URL | /namespace/anonymize |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The uuid of the namespace rules • Anonymization rules in JSON format. The format is a hash with the keys the names of the fields to anonymize and the values the regular expressions to apply. (optional) prompt_for_anonymize • Flag to prompt if the anonymization rules should be applied. Only applicable to ingress anonymization. (optional) |
| Returns |
status • OK rules • The anonymization rules in JSON format. anonymize_at_ingress • If the anonymize at ingress feature is turned on this flag is returned prompt_for_anonymize • Flag to prompt if the anonymization rules should be applied. Only applicable to ingress anonymization dicom_tag_map • If the anonymize at ingress feature is turned on this map of field names to dicom tags is returned |
| Permission | account_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to anonymize this namespace NOT_FOUND • The namespace was not found INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field NOT_HASH • The rules field is not a hash INVALID_FIELD_NAME • The field name is n the rules hash is invalid. The error_subtype holds the invalid field name INVALID_REGEXP • Invalid regular expression. The error_subtype holds the invalid regexp. |
| Notes |
|
| Description | Set/get the cover page template for the namespace |
|---|---|
| URL | /namespace/coverpage |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The uuid of the namespace coverpage • The coverpage value. See the notes for formatting details or pass an empty string to remove the current cover page. (optional) |
| Returns |
status • OK coverpage • The coverpage value. |
| Permission | account_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to do this NOT_FOUND • The namespace was not found |
| Notes |
The coverpage value should be a JSON structure with Text::Template expressions for the key values. e.g.
\{ "title": "This is an outside study", "footer": "Dicomgrid.com", "uploadedDate": "{$created_at}", "uploadedBy": "{$created_by_name}", "studyInstanceUid": "{$study_uid}", "modality": "{$modality}", "accessionNumber": "{$accession_number}", "studyDescription": "{$study_description}", "studyDate": "{$study_date}" \} |
| Description | Validate custom field values for a namespace |
|---|---|
| URL | /namespace/validate/customfields |
| Parameters |
share_code • The share code customfield-CUSTOMFIELD_UUID • Custom field(s) |
| Returns |
status • OK |
| Errors |
INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details |
| Notes |
| Description | Set/get the event default values that are applied when a user is added to a namespace |
|---|---|
| URL | /namespace/event/defaults |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The uuid of the namespace event_share • Notify the user on a share into the namespace (optional) event_approve • Notify the user on a approval needed into the namespace (optional) event_upload • Notify the user on an upload into the namespace (optional) event_upload_fail • Notify the user on a failed upload into the namespace (optional) event_harvest • Notify the user on a harvest into the namespace (optional) event_new_report • Notify the user when a report is attached in the namespace (optional) event_report_remove • Notify the user when a report is removed in the namespace (optional) event_study_comment • Notify the user when a comment is attached to a study in the namespace (optional) event_status_change • Notify the user when the status of a study is changed (optional) event_message • Notify the user when a message is sent to the namespace (optional) event_node • Notify the user when a namespace node sends an event (optional) event_link • Notify the user when an anonymous link is hit in the namespace (optional) event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace (optional) event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds (optional) event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails (optional) event_case_assignment • Notify the user when they are assigned a case as a medical or admin user (optional) |
| Returns |
status • OK event_share • Notify the user on a share into the namespace event_approve • Notify the user on a approval needed into the namespace event_upload • Notify the user on an upload into the namespace event_upload_fail • Notify the user on a failed upload into the namespace event_harvest • Notify the user on a harvest into the namespace event_new_report • Notify the user when a report is attached in the namespace event_report_remove • Notify the user when a report is removed in the namespace event_study_comment • Notify the user when a comment is attached to a study in the namespace event_status_change • Notify the user when the status of a study is changed event_message • Notify the user when a message is sent to the namespace event_node • Notify the user when a namespace node sends an event event_link • Notify the user when an anonymous link is hit in the namespace event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds (optional) event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails (optional) event_case_assignment • Notify the user when they are assigned a case as a medical or admin user (optional) |
| Permission | account_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to apply defaults to this namespace NOT_FOUND • The namespace was not found INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag |
| Notes |
| Description | Set/get the study default values for the namespace |
|---|---|
| URL | /namespace/study/defaults |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The uuid of the namespace defaults • Default values in JSON format. The format is a hash with the keys the names of the fields and the values are the default value. The available field name are as listed in the returned field hash. (optional) |
| Returns |
status • OK defaults • The default values in JSON format. fields • A hash of the fields that can have default values. The study fields have the DICOM tag as the value and the custom fields have the field name as the value. |
| Permission | account_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to apply defaults to this namespace NOT_FOUND • The namespace was not found INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field NOT_HASH • The rules field is not a hash INVALID_FIELD_NAME • The field name in the default hash is invalid. The error_subtype holds the invalid field name |
| Notes |
|
| Description | Get the FQDN for the storage engine |
|---|---|
| URL | /namespace/engine/fqdn |
| Parameters |
(namespace_id|study_id|study_uid && storage_namespace && phi_namespace) • The uuid of the namespace or study or the study_uid/storage_namespace/phi_namespace triplet source • The source of the query (optional) |
| Returns |
status • OK engine_fqdn • The FQDN of the storage engine to use engine_url • URL of the storage engine to use storage_namespace • Storage namespace to use |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The namespace was not found |
| Notes |
| Description | Build a report of the users who have been removed from the namespace |
|---|---|
| URL | /namespace/removed/user/report |
| Parameters |
sid • The session id uuid • The UUID of the namespace email • Optional email address to send the report to |
| Returns |
status • OK report_id • The report id |
| Permission | account_edit or sysadmin or support user |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The namespace was not found NOT_PERMITTED • You are not permitted to do this |
| Notes |
help commands
| Description | Get help |
|---|---|
| URL | /help/get |
| Parameters |
sid • The session id key • The help key |
| Returns |
status • OK text • The help text |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The help was not found |
| Notes |
| Description | Set help text |
|---|---|
| URL | /help/set |
| Parameters |
sid • The session id of a system administrator or account support user key • The help key text • The help text |
| Returns |
status • OK |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_SYSADMIN_OR_SUPPORT • The user is not a sysadmin or support user |
| Notes |
Terminology commands
| Description | List terminology overrides for the account |
|---|---|
| URL | /terminology/account/overrides |
| Parameters |
sid • The session id of a system administrator or account administrator (account_id || vanity || study_uid && storage_namespace && phi_namespace) • The uuid or vanity name of the account or study triplet to apply any account overrides for (optional) |
| Returns |
status • OK tags • An array of hashes of tags * tag • The tag * val • The value of the tag * language • The language of the tag * vanity • The vanity of the tag |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account or vanity was not found |
| Notes | If a tag is not overridden for the account or vanity it is not returned. |
| Description | Get the terminology tags |
|---|---|
| URL | /terminology/tags |
| Parameters |
tags • A comma separated list of the terminology tags to look up (optional) language • The ISO 639-1 language code (account_id || vanity || study_uid && storage_namespace && phi_namespace) • The uuid or vanity name of the account or study triplet to apply any account overrides for (optional) |
| Returns |
status • OK values • A hash of the tags and their values |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields |
| Notes | If a tag does not have a value in the database the tag is not returned |
| Description | Set terminology values |
|---|---|
| URL | /terminology/set |
| Parameters |
sid • The session id of a system administrator or account administrator tag • The tag to set language • The ISO 639-1 language code account_id • The uuid of the account to apply the tag for (optional) vanity • Vanity to apply the tag for (optional) value • The value of the tag. If this is empty the tag is deleted |
| Returns |
status • OK |
| Permission | account_edit or sysadmin |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_SYSADMIN_OR_SUPPORT • The user is not a sysadmin or support user and is trying to set global tags NOT_PERMITTED • The user is not an account administrator and is trying to set account tags NO_VALUE • The value parameter was not passed NOT_FOUND • The account was not found |
| Notes |
| Description | Get a list of the terminology tags |
|---|---|
| URL | /terminology/list |
| Parameters |
tags • A comma separated list of the terminology tags to look up language • The ISO 639-1 language code (account_id|vanity) • The uuid or vanity name of the account to apply any account overrides for (optional) |
| Returns |
status • OK tags • An array of hashes of tags * tag • The tag * val • The value of the tag * language • The language of the tag |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields |
| Notes | If you pass in both a vanity and account_id the account/vanity override tags will be returned as well |
| Description | Get the terminology in i18next format |
|---|---|
| URL | /terminology/i18next |
| Parameters |
lng • The language code (account_id|vanity) • The uuid or vanity name of the account to apply any account overrides for (optional) |
| Returns | The data in i18next format |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields |
| Notes |
Analytics commands
| Description | Get the study analytics |
|---|---|
| URL | /analytics/study |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (account_id|namespace_id) • The account or namespace to get the analytics for period • The time period (day|week|month|year) count • The number of periods to get end_date • The end date, default is today if not passed (optional) |
| Returns |
status • OK current • The date and timestamp for how current the analytics data is periods • An array of the periods for earliest to latest each object in the array will have the following fields * start • Starting date of the period * end • Ending date of the period * label • Display label for the period * study_create • Number of studies created * study_create_harvest • Number of harvested studies created * study_create_upload • Number of uploaded studies created * study_create_share • Number of shared studies created * study_create_copy • Number of copied studies created * study_delete • Number of studies deleted * study_view • Number of studies viewed * study_report_view • Number of reports viewed * study_download • Number of studies downloaded * study_push • Number of studies pushed * study_share_out • Number of studies shared out of the account or namespace * study_share_in • Number of studies shared into the account or namespace * study_approve • Number of studies approved into the account or namespace * study_auto_approve • Number of studies auto approved into the account or namespace |
| Permission | analytics_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_PARAMETERS • Only pass a account_id or namespace_id NOT_FOUND • The account or namespace can not be found NOT_PERMITTED • You are not permitted to view analytics for this account or namespace INVALID_PERIOD • An invalid period INVALID_END_DATE • An invalid period INVALID_COUNT• Invalid or excessive count value |
| Notes |
| Description | Get the patient portal analytics |
|---|---|
| URL | /analytics/patient/portal |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account id patient_id • Patient filter (optional) period • The time period (day|week|month|year) count • The number of periods to get end_date • The end date, default is today if not passed (optional) |
| Returns |
status • OK current • The date and timestamp for how current the analytics data is periods • An array of the periods for earliest to latest each object in the array will have the following fields * start • Starting date of the period * end • Ending date of the period * label • Display label for the period * study_view • Number of studies viewed * study_report_view • Number of reports viewed * study_download • Number of studies downloaded * study_share_out • Number of studies shared out of the account or namespace * login • Number of logins |
| Permission | analytics_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account or patient can not be found NOT_PERMITTED • You are not permitted to view analytics for this account or namespace INVALID_PERIOD • An invalid period INVALID_END_DATE • An invalid period INVALID_COUNT • Invalid or excessive count value |
| Notes |
| Description | Get the radreport analytics |
|---|---|
| URL | /analytics/radreport |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account id namespace_id • Namespace filter (optional) user_id • User filter (optional) period • The time period (day|week|month|year) count • The number of periods to get end_date • The end date, default is today if not passed (optional) |
| Returns |
status • OK current • The date and timestamp for how current the analytics data is periods • An array of the periods for earliest to latest each object in the array will have the following fields * start • Starting date of the period * end • Ending date of the period * label • Display label for the period * radreport_create • Number of radreports created * radreport_delete • Number of radreports deleted * radreport_signed • Number of radreports signed * radreport_report_generated • Number of radreports generated * namespaces • A JSON array of unique namespaces covered by the period. Each array element is a hash with a id and name kv pair * users • A JSON array of unique users covered by the period. Each array element is a hash with a id and name kv pair |
| Permission | analytics_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account or patient can not be found NOT_PERMITTED • You are not permitted to view analytics for this account or namespace INVALID_PERIOD • An invalid period INVALID_END_DATE • An invalid period INVALID_COUNT • Invalid or excessive count value |
| Notes |
Filter commands
| Description | List the filters the user has |
|---|---|
| URL | /filter/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) type • The type of filter to list account_id • Limit to global filters and filters within the account namespaces filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash filters • An array of the filters the user has. Each object holds the following same fields as the /filter/get call |
| Errors | |
| Notes |
| Description | Add a filter |
|---|---|
| URL | /filter/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) name • The name of the filter type • The type of the filter configuration • The configuration as a JSON data structure |
| Returns |
status • OK uuid • The filter uuid |
| Errors | |
| Notes |
The configuration can be either of these forms
|
| Description | Get a filter |
|---|---|
| URL | /filter/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The filter uuid |
| Returns |
status • OK name • The name of the filter type • The type of the filter configuration • The configuration as a JSON data structure owner • Flag if the user is the owner of this filter |
| Errors |
NOT_FOUND • The filter can not be found |
| Notes |
| Description | Edit a filter |
|---|---|
| URL | /filter/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The filter uuid name • The name of the filter (optional) type • The type of the filter (optional) configuration • The configuration as a JSON data structure (optional) |
| Returns |
status • OK uuid • The filter uuid |
| Errors |
NOT_FOUND • The filter can not be found NOT_PERMITTED • You are not the owner of the filter |
| Notes |
| Description | Delete a filter |
|---|---|
| URL | /filter/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The filter uuid |
| Returns |
status • OK |
| Errors |
NOT_FOUND • The filter can not be found NOT_PERMITTED • You are not the owner of the filter |
| Notes |
| Description | Share a filter |
|---|---|
| URL | /filter/share |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The filter uuid (account_id|location_id|group_id|user_id) • uuid of the account, location, group or user to share this filter with |
| Returns |
status • OK |
| Errors |
NOT_FOUND • The filter or share object can not be found. The error_subtype holds a the name of the key that can not be found NOT_PERMITTED • You are not the owner of the filter or are not permitted to share a filter with the destination INVALID_PARAMETERS • Only pass a account_id or a location_id or a group_id or a user_id |
| Notes |
| Description | Stop sharing a filter |
|---|---|
| URL | /filter/share/stop |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The filter uuid (account_id|location_id|group_id|user_id) • uuid of the account, location, group or user to stop sharing this filter with |
| Returns |
status • OK |
| Errors |
NOT_FOUND • The filter can not be found NOT_PERMITTED • You are not the owner of the filter |
| Notes |
| Description | Get the filter shares |
|---|---|
| URL | /filter/share/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The filter uuid |
| Returns |
status • OK account_id • A list of the account_id's the filter is shared with location_id • A list of the location_id's the filter is shared with group_id • A list of the group_id's the filter is shared with user_id • A list of the user_id's the filter is shared with |
| Errors |
NOT_FOUND • The filter can not be found |
| Notes |
Custom field commands
Custom fields| Description | List the custom fields for the account |
|---|---|
| URL | /customfield/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash customfields • An array of the customfields. Each object holds the following same fields as the /customfield/get call |
| Permission | customfield_view or role_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view this list |
| Notes |
| Description | Add a custom field to the account |
|---|---|
| URL | /customfield/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account name • Name of the customfield object • The object to associate the customfield with (Study|User_account|Group|Location|Account|Patient|Case|Order|Appointment|Dicomdata) type • Type of the custom field (text|number|date|memo|select|multiselect|radio|checkbox|search) capture_on_share_code • Flag if the field should be captured during a share code exchange (only applicable to study fields) display_order • Integer to order how the fields should be displayed wrapped_dicom_only • Only capture for wrapped DICOM uploads during a share code exchange required • Flag if the field is required options • Additional options in JSON format (optional) hl7_segment • Segment to map this field to in HL7 ORM messages. Valid values are (NTE|PID|PID1|PV1|PV2|OBR|DG1|OBX|CTI|BLG|ORC) (only applicable to study fields) (optional) hl7_field • Segment field number to map this field to in HL7 ORM messages. Valid values are 1 to 64. (only applicable to study fields) (optional) hl7_component • Component number to map this field to in HL7 ORM messages. Valid values are 1 to 64. (only applicable to study fields) (optional) load_hl7 • If this is set to a HL7 message type the value of this field will be updated from the hl7_segment, hl7_field and hl7_component from incoming HL7 messages of the matching message type (only applicable to study fields) (optional) load_hl7_filter • Filter token for the load_hl7 option (only applicable to study fields) (optional) dicom_tag • DICOM tag to map this field to. Format should be of form (1234,1234). (only applicable to study fields) (optional) other_dicom_tags • JSON array of other DICOM tags to map this field to. (only applicable to study fields) (optional) load_dicom_tag • Flag to load the current value from the study into this field. (only applicable if a dicom_tag is specified) (optional) dicom_tag_ignore_empty • Flag to not map an empty custom field to the DICOM tag. (only applicable if a dicom_tag is specified) (optional) load_from_sr • Load the value from the structured reports in the study (only applicable to study fields) .(optional) |
| Returns |
status • OK uuid • uuid of the customfield |
| Permission | customfield_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to add a customfield to this account INVALID_TYPE • An invalid type was passed. INVALID_OBJECT • An invalid object was passed. INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field INVALID_OPTIONS • An option is invalid. The error_subtype holds the specific error message INVALID_HL7_OBJECT • HL7 fields can only be applied to study fields INVALID_HL7_SEGMENT • Invalid segment name INVALID_DICOM_TAG_OBJECT • DICOM tags can only be applied to study fields INVALID_DICOM_TAG • The DICOM tag is invalid INVALID_SEARCH_SOURCE • An invalid search source was passed. NO_DICOM_TAG_DEFINED • The load_dicom_tag flag is set but the dicom_tag field is not defined |
| Notes |
|
| Description | Edit a custom field |
|---|---|
| URL | /customfield/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the customfield name • Name of the customfield (optional) capture_on_share_code • Flag if the study type field should be captured during a share code exchange (optional) display_order • Integer to order how the fields should be displayed (optional) wrapped_dicom_only • Only capture for wrapped DICOM uploads during a share code exchange (optional) required • Flag if the field is required (optional) options • Additional options in JSON format (optional) hl7_segment • Segment to map this field to in HL7 ORM messages. Valid values are (NTE|PID|PID1|PV1|PV2|OBR|DG1|OBX|CTI|BLG|ORC) (only applicable to study fields) (optional) hl7_field • Segment field number to map this field to in HL7 ORM messages. Valid values are 1 to 64. (only applicable to study fields) (optional) hl7_component • Component number to map this field to in HL7 ORM messages. Valid values are 1 to 64. (only applicable to study fields) (optional) load_hl7 • If this is set to a HL7 message type the value of this field will be updated from the hl7_segment, hl7_field and hl7_component from incoming HL7 messages of the matching message type (only applicable to study fields) (optional) load_hl7_filter • Filter token for the load_hl7 option (only applicable to study fields) (optional) dicom_tag • Dicom tag to map this field to. Format should be of form (1234,1234). (only applicable to study fields) (optional) other_dicom_tags • JSON array of other DICOM tags to map this field to. (only applicable to study fields) (optional) load_dicom_tag • Flag to load the current value from the study into this field. (only applicable if a dicom_tag is specified) (optional) dicom_tag_ignore_empty • Flag to not map an empty custom field to the DICOM tag. (only applicable if a dicom_tag is specified) (optional) load_from_sr • Load the value from the structured reports in the study. (only applicable to study fields) .(optional) |
| Returns |
status • OK |
| Permission | customfield_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The customfield can not be found NOT_PERMITTED • You are not permitted to edit the customfield INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field INVALID_OPTIONS • An option is invalid. The error_subtype holds the specific error message INVALID_HL7_OBJECT • HL7 fields can only be applied to study fields INVALID_HL7_SEGMENT • Invalid segment name INVALID_HL7_FIELD • Invalid field number INVALID_DICOM_TAG_OBJECT • DICOM tags can only be applied to study fields INVALID_DICOM_TAG • The DICOM tag is invalid NO_DICOM_TAG_DEFINED • The load_dicom_tag flag is set but the dicom_tag field is not defined |
| Notes | See the /customfield/add command notes for the format of the options field |
| Description | Delete a customfield |
|---|---|
| URL | /customfield/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the customfield |
| Returns |
status • OK |
| Permission | customfield_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The customfield can not be found NOT_PERMITTED • You are not permitted to delete the customfield |
| Notes |
| Description | Lookup a custom field by name |
|---|---|
| URL | /customfield/lookup |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account name • Name of the customfield |
| Returns |
status • OK uuid • Id of the customfield object • Object it is associated with type • Type of the customfield |
| Permission | You need to be a member of the account |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The customfield can not be found NOT_PERMITTED • You are not permitted to do this |
| Notes |
| Description | Search and return the results for a search type customfield |
|---|---|
| URL | /customfield/search |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the customfield search • The value to search for (optional) |
| Returns |
status • OK results • An array of the search results |
| Permission | You need to be a member of the account |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The customfield can not be found NOT_PERMITTED • You are not permitted to do this NOT_A_SEARCH • This is not a search type of customfield |
| Notes |
Webhook commands
| Description | List the webhooks for the account |
|---|---|
| URL | /webhook/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account |
| Returns |
status • OK webhooks • An array of the webhooks. Each object holds the following same fields as the /webhook/get call |
| Permission | webhook_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view this list |
| Notes |
| Description | Add a webhook to the account |
|---|---|
| URL | /webhook/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account node_id • uuid of the node to proxy the webhook through (optional) name • Name of the webhook event • Event to call it on (See the notes for the available events) url • URL to call method • Method to call it with (POST|GET|POST_JSON|PUT) suspended • This webhook is suspended and not triggered (optional) parameters • A JSON object of the parameter names and values (optional) retry • Retry the webhook if it fails (optional) sid_user_id • UUID of the user to generate a sid as (optional) filter_field • Name of the study field to filter on (optional) filter_regexp • Regular expression to match the value of the filter_field against (optional) once • Flag that this webhook should only be run once for a specific study (optional) by_uid • Flag to expand the once search to include studies with the same study_uid (optional) by_accession_number • Flag to expand the once search to include studies with the same accession_number (optional) delay • Number of seconds to delay running this webhook for after it is triggered (optional) max_age • Ignore studies that are more than this number of days old based on the study_date (optional) auth • A JSON hash with the authentication details (optional) cron • Cron timing string for CRON events e.g 0 9 * * mon-fri (optional) |
| Returns |
status • OK uuid • uuid of the webhook |
| Permission | webhook_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields ACCOUNT_NOT_FOUND • The account can not be found NODE_NOT_FOUND • The node can not be found USER_NOT_FOUND • The basic authentication user can not be found NOT_PERMITTED • You are not permitted to add a webhook to this account INVALID_METHOD • An invalid method was passed INVALID_EVENT • An invalid event was passed INVALID_JSON • The parameters field is not in valid JSON format. NOT_HASH • The parameter or auth field is not a hash. SID_USER_NOT_FOUND • The sid user can not be found SID_USER_NOT_IN_ACCOUNT • The sid user is not a member of this account INVALID_REGEXP • Invalid regular expression INVALID_FILTER_FIELD • Invalid filter field name INCOMPLETE_FILTER • Both a field and regexp are required INVALID_TRANSFORM_CONDITION • The transform condition is invalid SFDC_NOT_HASH • The SFDC auth value is not a JSON hash SFDC_MISSING_FIELDS • Fields are missing for the SFDC auth hash CUSTOM_NOT_HASH • The custom auth value is not a JSON hash INVALID_CRON • The cron value is invalid NOT_WITH_CRON • The delay or retry option can not be used for cron events |
| Notes |
|
| Description | Edit a webhook |
|---|---|
| URL | /webhook/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the webhook name • Name of the webhook (optional) event • Event to call it on (optional see add command for options) url • URL to call (optional) method • Method to call it with (optional see add command for options) suspended • This webhook is suspended and not triggered (optional) parameters • A JSON object of the parameter names and values (optional see add command for options) node_id • uuid of the node to proxy the webhook through (optional) retry • Retry the webhook if it fails (optional) sid_user_id • UUID of the user to generate a sid as (optional) filter_field • Name of the field to filter on (optional) filter_regexp • Regular expression to match the value of the filter_field against (optional) once • Flag that this webhook should only be run once for a specific study (optional) by_uid • Flag to expand the once search to include studies with the same study_uid (optional) by_accession_number • Flag to expand the once search to include studies with the same accession_number (optional) delay • Number of seconds to delay running this webhook for after it is triggered (optional) max_age • Ignore studies that are more than this number of days old based on the study_date (optional) auth • A JSON hash with the authentication details (optional) cron • Cron timing string for CRON events (optional) |
| Returns |
status • OK |
| Permission | webhook_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The webhook can not be found NOT_PERMITTED • You are not permitted to edit the webhook INVALID_METHOD • An invalid method was passed INVALID_EVENT • An invalid event was passed INVALID_JSON • The parameters field is not in valid JSON format. NOT_HASH • The parameter field is not a hash. NODE_NOT_FOUND • The node can not be found SID_USER_NOT_FOUND • The sid user can not be found SID_USER_NOT_IN_ACCOUNT • The sid user is not a member of this account INVALID_REGEXP • Invalid regular expression INVALID_FILTER_FIELD • Invalid filter field name INCOMPLETE_FILTER • Both a field and regexp are required INVALID_TRANSFORM_CONDITION • The transform condition is invalid SFDC_NOT_HASH • The SFDC auth value is not a JSON hash SFDC_MISSING_FIELDS • Fields are missing for the SFDC auth hash INVALID_CRON • The cron value is invalid NOT_WITH_CRON • The delay or retry option can not be used for cron events |
| Notes |
| Description | Get a webhook |
|---|---|
| URL | /webhook/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the webhook |
| Returns |
status • OK uuid • uuid of the webhook name • Name of the webhook event • Event to call it on url • URL to call method • Method to call it with suspended • This webhook is suspended and not triggered parameters • An object of the parameter names and values node_id • uuid of the node to proxy the webhook through retry • Retry the webhook if it fails sid_user_id • UUID of the user to generate a sid as filter_field • Name of the field to filter on filter_regexp • Regular expression to match the value of the filter_field against once • Flag that this webhook should only be run once for a specific study by_uid • Flag to expand the once search to include studies with the same study_uid by_accession_number • Flag to expand the once search to include studies with the same accession_number last_error • Error text from the last time this webhook failed delay • Number of seconds to delay running this webhook for after it is triggered max_age • Ignore studies that are more than this number of days old based on the study_date auth • A JSON hash with the authentication details cron • Cron timing string for CRON events |
| Permission | webhook_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The webhook can not be found NOT_PERMITTED • You are not permitted to view the webhook |
| Notes |
| Description | Delete a webhook |
|---|---|
| URL | /webhook/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the webhook |
| Returns |
status • OK |
| Permission | webhook_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The webhook can not be found NOT_PERMITTED • You are not permitted to delete the webhook |
| Notes |
| Description | Manually trigger a webhook |
|---|---|
| URL | /webhook/trigger |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the webhook study_id • uuid of the study to fire the webhook for |
| Returns |
status • OK |
| Permission | webhook_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The webhook or study can not be found NOT_PERMITTED • You are not permitted to trigger the webhook |
| Notes | This is an administrative call that can be used to re-fire triggers |
| Description | Send an event that may trigger a webhook |
|---|---|
| URL | /webhook/event |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) type • The type of event (STUDY_UPLOAD_START|STUDY_UPLOAD_END) (namespace_id|share_code) • The namespace or share code for the event integration_key • The integration key associated with the event (optional) study_count • The number of studies associated with the event (optional) |
| Returns |
status • OK |
| Permission | |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_TYPE • Invalid event type |
| Notes |
| Description | Send an email (a helper method for webhooks) |
|---|---|
| URL | /webhook/email |
| Parameters |
webhook_id • The uuid of the calling webhook to • The email address(es) to send the email to subject • The subject of the email text • The text part of the email html • The HTML part of the email template_id • The email template UUID to be used |
| Returns |
status • OK |
| Permission | This can only be called by a webhook |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • This is not a call from a valid webhook PARSE_FAILED • Template parsing failed for a field. The error_subtype holds the name of the field |
| Notes |
|
Link commands
Links allow you to generate static URLs that give controlled access to the application| Description | List the links for the study, user or account |
|---|---|
| URL | /link/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (study_id|user_id|account_id) • uuid of the study, user or account to get the links for page.* Pagination (optional) |
| Returns |
status • OK page • The pagination status hash links • An array of the links. Each object holds the following same fields as the /link/get call |
| Permission | link_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view this list |
| Notes |
| Description | Add a link |
|---|---|
| URL | /link/add |
| Parameters |