[Index]
GlobalSettings
Model ref.: view/GlobalSettings
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{ "$schema": "http://json-schema.org/draft-03/schema", "type": "object", "properties": { "global_setting_flow_through_provisioning_update_pwf": { "choices": [ { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting stores the Flow Through Provisioning PWF name to execute when LDAP Update sync executes.", "title": "Provisioning Workflow to execute after LDAP Update Sync" }, "global_setting_webex_teams_user_csv_recipients_email_group": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to configure the recipients of the Webex Teams message containing the generated CSV file. This must be a valid email group already defined in the portal.", "title": "Email group containing recipients of the generated Webex Teams user CSV file" }, "global_setting_service_cisco_webex_teams": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to enable Cisco Webex Team services. The default behaviour is No which means that the Cisco Webex Team services will be disabled by default.", "title": "Enable Cisco Webex Teams" }, "current_global_setting_user_auth_method": { "type": "string", "description": "Current value of [global_setting_user_auth_method] field", "title": " " }, "current_global_setting_flow_through_provisioning_qas_cft": { "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "global_setting_service_cisco_microsoft": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to enable Cisco / Microsoft hybrid services. The default behaviour is No which means that the Cisco/ Microsoft hybrid services will be disabled by default.", "title": "Enable Cisco / Microsoft Hybrid" }, "current_global_setting_flow_through_provisioning_delete_enabled": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "global_setting_webex_teams_refresh_token_expires_threshold": { "choices": [ { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting controls the max threshold in seconds for when to send a SNMP trap to the SNMP server. The default is 172800 seconds which is 2 days. This setting has no effect if the 'Send SNMP trap message when the Webex Teams Refresh Token expires' setting is set to false.", "title": "Webex Teams Refresh Token expires threshold (in seconds)" }, "current_global_setting_flow_through_provisioning_enabled": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "global_setting_flow_through_provisioning_qas_cft": { "choices": [ { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting stores the Flow Through Provisioning QAS CFT name to use adding a Subscriber.", "title": "Quick Add Subscriber CFT to use" }, "current_global_setting_webex_teams_refresh_token_expires_threshold": { "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "current_global_setting_webex_teams_refresh_token_expires_email_group": { "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "hidden_field": { "type": "string" }, "current_global_setting_cooling_duration": { "type": "string", "description": "Current value of [global_setting_cooling_duration] field", "title": " " }, "current_global_setting_generate_webex_teams_user_csv": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "global_setting_send_webex_teams_manual_steps": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to determine whether manual configuration steps is sent on creation or modification of a Webex Teams workspace. If enabled the steps will be sent via a Webex Teams message to a configured list of recipients.", "title": "Send manual Webex Teams Workspace configuration steps via Webex Teams message" }, "current_global_setting_retain_pexip_conference": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "current_global_setting_webex_teams_manual_steps_recipients_email_group": { "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "global_setting_service_pexip": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to enable Pexip services. The default behaviour is No which means that the Pexip services will be disabled by default.", "title": "Enable Pexip" }, "current_global_setting_flow_through_provisioning_delete_pwf": { "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "current_global_setting_flow_through_provisioning_update_pwf": { "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "global_setting_service_cisco_ccx": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to enable Cisco CCX (Contact Center Express) services. The default behaviour is No which means that the Cisco CCX services will be disabled by default.", "title": "Enable CCX" }, "global_setting_user_auth_method": { "choices": [ { "value": "Local", "title": "Local" }, { "value": "Automatic", "title": "Automatic" }, { "value": "LDAP", "title": "LDAP" }, { "value": "SSO", "title": "SSO" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting control the user's default auth method when created for the first time", "title": "User Default Auth Method" }, "global_setting_flow_through_provisioning_criteria": { "target": "/api/data/FlowThroughProvisioningCriteria/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Subscriber criteria", "choices": [], "target_model_type": "data/FlowThroughProvisioningCriteria", "type": "string", "description": "This setting control the user's default subscriber profile criteria" }, "global_setting_flow_through_provisioning_enable_ldap_user_update": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting controls if the LDAP User is allowed to be updated after Flow Through Provisioning. The default setting is No.", "title": "Enable Update of LDAP User after Flow Through Provisioning" }, "current_global_setting_service_cisco_webex_teams": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "global_setting_flow_through_provisioning_delete_pwf": { "choices": [ { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting stores the Flow Through Provisioning PWF name to execute when LDAP Delete sync executes.", "title": "Provisioning Workflow to execute after LDAP Delete Sync" }, "global_setting_service_zoom": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to enable Zoom services. The default behaviour is No which means that the Zoom services will be disabled by default.", "title": "Enable Zoom" }, "global_setting_flow_through_provisioning_enabled": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting controls if Flow Through Provisioning is enabled ot not. The default setting is No.", "title": "Enable Flow Through Provisioning" }, "global_setting_service_avaya_microsoft": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to enable Avaya / Microsoft hybrid services. The default behaviour is No which means that the Avaya / Microsoft hybrid services will be disabled by default.", "title": "Enable Avaya / Microsoft Hybrid" }, "global_setting_include_ini_description": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "If this is set to \"Yes\", then the description value in the Internal Number Inventory, will show up as additional information in number drop-downs. For example, let's say you had number '1000' with a description of \"CEO Internal\". When using Quick Add Subscriber, or similar features, and selecting numbers from a drop-down, you'd see an option of \"1000 - CEO Internal\".", "title": "Include the Number Inventory description in all number dropdowns" }, "current_global_setting_service_cisco_broadworks": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "current_global_setting_send_webex_teams_refresh_token_expires_message": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "global_setting_service_avaya": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to enable Avaya services. The default behaviour is No which means that the Avaya services will be disabled by default.", "title": "Enable Avaya" }, "current_global_setting_service_avaya_microsoft": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "global_setting_flow_through_provisioning_delete_enabled": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting controls if Flow Through Provisioning on LDAP Delete sync is enabled ot not. The default setting is No.", "title": "Enable Provisioning after Delete Sync" }, "global_setting_enforce_hcs_dialplan_rules": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "If this setting is set to \"Yes\", then the dialplan workflows will enforce HCS Rules with regards to provisioning Customers, Countries, Sites, etc. By default this is set to \"Inherit\", which means it takes the value from higher up in the hierarchy tree. If you're unsure, then keep the default. If your deployment uses a custom or specific dialplan which does not conform to the HCS rules, this setting should be set to \"No\".", "title": "Enforce HCS Dialplan Rules" }, "current_global_setting_service_cisco_microsoft": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "current_global_setting_service_pexip": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "global_setting_send_webex_teams_refresh_token_expires_message": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is a flag to control whether a notification is sent when the Webex Teams refresh token expires for a specific customer. This would send both SNMP trap as well as a Webex Teams message to the recipients configured in the email group below.", "title": "Send notification when the Webex Teams Refresh Token expires" }, "global_setting_service_microsoft": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to enable Cisco Microsoft services. The default behaviour is No which means that the Microsoft services will be disabled by default.", "title": "Enable Microsoft" }, "global_setting_enable_unassigned_phone_removal": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting allows an existing Phone, which has no Owner set, to be Deleted if a Phone with the same Name and Product Type is re-added. The default setting is No.", "title": "Delete existing Unassigned Phone when re-adding an identical Phone" }, "current_global_setting_enforce_hcs_dialplan_rules": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "Current value of [global_setting_enforce_hcs_dialplan_rules] field", "title": " " }, "current_global_setting_include_ini_description": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "global_setting_auto_move_ini_into_cooling": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting controls the reserved state of numbers, when a phone/user/service is deleted, and the number no longer associated with that phone/user/service. When this is set to \"Yes\" it will keep numbers in a reserved state for a duration as set in the \"Number Inventory Cooling Duration (Days)\" field. Meaning, the number will not appear as available in drop-downs, until the cooling period has expired. By default, this is set to \"Inherit\". If the value is \"No\", then numbers become immediately available after deletion/dissociation from a phone/user/service.", "title": "Enable Number Inventory Cooling" }, "current_global_setting_service_microsoft": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "global_setting_cooling_duration": { "choices": [ { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting control the duration of cooling (reservation) days, when the \"Enable Number Inventory Cooling\" is turned on. By default, this is set to \"Inherit\". An admin can override this setting, by replacing \"Inherit\" with a numeric value such as \"14\", \"30\", \"100\" etc", "title": "Number Inventory Cooling Duration (Days)" }, "global_setting_webex_teams_refresh_token_expires_email_group": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to configure the recipients of the Webex Teams message sent when the token refresh fails.", "title": "Email group containing recipients of the Webex Teams message for token refresh failure" }, "current_global_setting_service_zoom": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "global_setting_retain_pexip_conference": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to determine if a Pexip Conference needs to be deleted when a Subscriber is deleted. The default behaviour is No which means that the Pexip Conference user will be deleted be default.", "title": "Retain a Pexip Conference when a Subscriber is deleted." }, "global_setting_retain_webex_teams_user": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to determine if a Webex Teams user needs to be deleted when a Subscriber is deleted. The default behaviour is No which means that the Webex Teams user will be deleted be default.", "title": "Retain a Webex Teams User when a Subscriber is deleted." }, "current_global_setting_service_avaya": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "current_global_setting_send_webex_teams_manual_steps": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "global_setting_qas_send_email_to_user": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting controls if an email needs to be sent to a user when added via Quick Add Subscriber. The default value is No. Email Account and HTML Email Template (Quick Add Subscriber) need to be set up. Please refer to documentation for setting up an Email account.", "title": "Allow welcome email to be sent to user after Quick Add Subscriber" }, "current_global_setting_enable_unassigned_phone_removal": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "This setting allows an existing Phone, which has no Owner set, to be Deleted if a Phone with the same Name and Product Type is re-added. The default setting is No.", "title": " " }, "current_global_setting_service_cisco_cucx": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "global_setting_apply_default_calling_behaviour": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to determine whether the default calling behaviour will be applied to new Webex Teams users synced into VOSS-4-UC.", "title": "Automatically apply default calling behaviour on Webex Teams user data sync" }, "global_setting_flow_through_provisioning_add_enabled": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting controls if Flow Through Provisioning on LDAP Add sync is enabled ot not. The default setting is No.", "title": "Enable Provisioning after Add Sync" }, "global_setting_flow_through_provisioning_add_pwf": { "choices": [ { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting stores the Flow Through Provisioning PWF name to execute when LDAP Add sync executes.", "title": "Provisioning Workflow to execute after LDAP Add Sync" }, "global_setting_webex_teams_place_hybrid_calling_qag": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting determines which Quick Add Group is used when creating dummy Unified CM users for Webex Teams workspace hybrid calling.", "title": "Quick Add Group for Hybrid Calling Workspace Unified CM users" }, "current_global_setting_flow_through_provisioning_add_pwf": { "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "global_setting_webex_teams_manual_steps_recipients_email_group": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to configure the recipients of the Webex Teams message containing the manual Control Hub steps. This must be a valid email group already defined in the portal.", "title": "Email group containing recipients of the manual Control Hub steps" }, "global_setting_service_cisco_broadworks": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to enable Cisco Broadworks services. The default behaviour is No which means that the Cisco Broadworks services will be disabled by default.", "title": "Enable Cisco Broadworks" }, "global_setting_flow_through_provisioning_update_enabled": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting controls if Flow Through Provisioning on LDAP Update sync is enabled ot not. The default setting is No.", "title": "Enable Provisioning after Update Sync" }, "global_setting_service_cisco_cucx": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to enable Cisco CUCX (Unity) services. The default behaviour is Yes which means that the Cisco CUCX services will be enabled by default.", "title": "Enable Cisco CUCX" }, "current_global_setting_webex_teams_user_csv_recipients_email_group": { "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "current_global_setting_flow_through_provisioning_update_enabled": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "current_global_setting_retain_webex_teams_user": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "current_global_setting_service_cisco_cucm": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "current_global_setting_service_cisco_ccx": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "current_global_setting_auto_move_ini_into_cooling": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "Current value of [global_setting_auto_move_ini_into_cooling] field", "title": " " }, "current_global_setting_service_cisco_webex": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "global_setting_service_cisco_cucm": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to enable Cisco CUCM (Call Manager) services. The default behaviour is Yes which means that the Cisco UC services will be enabled by default.", "title": "Enable Cisco CUCM" }, "global_setting_service_cisco_webex": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to enable Cisco WebEx services. The default behaviour is No which means that the Cisco WebEx services will be disabled by default.", "title": "Enable Cisco WebEx" }, "current_global_setting_webex_teams_place_hybrid_calling_qag": { "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "current_global_setting_flow_through_provisioning_enable_ldap_user_update": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "current_global_setting_flow_through_provisioning_criteria": { "type": "string", "description": "Current value of [global_setting_flow_through_provisioning_subscriber_criteria] field", "title": " " }, "current_global_setting_flow_through_provisioning_add_enabled": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "global_setting_generate_webex_teams_user_csv": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" }, { "value": "Inherit", "title": "Inherit" } ], "type": "string", "description": "This setting is used to determine if a CSV import file should be generated on creation or modification of a Webex Teams user. If enabled the CSV file will be sent via a Webex Teams message to a configured list of recipients.", "title": "Generate and send Webex Teams User CSV file via Webex Teams message" }, "current_global_setting_apply_default_calling_behaviour": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " }, "current_global_setting_qas_send_email_to_user": { "choices": [ { "value": "True", "title": "Yes" }, { "value": "False", "title": "No" } ], "type": "string", "description": "The current resolved value for this setting at the current hierarchy.", "title": " " } }, "schema_version": "1.4" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/view/GlobalSettings/add/ |
|
The GUI Add form of view/GlobalSettings as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Create | POST | /api/view/GlobalSettings/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]shows the View resource has no instance pkid, because a view model stores no instances.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/view/GlobalSettings/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/view/GlobalSettings/ |
|
The view/GlobalSettings schema and all instances as JSON. |
(The list will return 0 to 3 view/GlobalSettings instances)
{ "operations": [ "add", "help", "configuration_template", "field_display_policy", "export_bulkload_template", "transform" ], "pagination": { "direction": "asc", "order_by": null, "maximum_limit": 2000, "skip": 0, "current": "/api/view/GlobalSettings/?skip=0&limit=3&order_by=None&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "1.4", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/view/GlobalSettings/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/view/GlobalSettings/+tag/?hierarchy=[hierarchy]", "class": "tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "title": "Tag Version", "support_async": true, "method": "PATCH", "href": "/api/view/GlobalSettings/+tag_version/?hierarchy=[hierarchy]", "class": "tag_version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/view/GlobalSettings/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/view/GlobalSettings/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/view/GlobalSettings/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "view/GlobalSettings", "model_specific_actions": [ "add" ], "summary_attrs": [ { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for view/GlobalSettings. | GET | /api/view/GlobalSettings/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/GlobalSettings as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/view/GlobalSettings/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/view/GlobalSettings/[pkid]/ | hierarchy=[hierarchy] | The view/GlobalSettings instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/view/GlobalSettings/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/GlobalSettings. |