Endpoints in AR REST API
This version of AR System supports v1.0 and earlier versions of the REST API. The base URL for the latest API version is:
http://localhost:8008/api
{ "swagger" : "2.0",
"info" : {
"version" : "23.3.02",
"title" : "REST API Documentation"
},
"tags" : [ {
"name" : "AdminSettingsResource to manage admin settings"
}, {
"name" : "AppInfoResource for managing Application Info"
}, {
"name" : "AssociationDefinitionResource for managing association related definitions"
}, {
"name" : "AttachmentResource for managing attachemnts"
}, {
"name" : "AuthTokenResource to get authentication tokens"
}, {
"name" : "BundleDescriptorResource to manage bundle descriptors"
}, {
"name" : "BundleRollbackResource for managing rollback of bundle during upgrade"
}, {
"name" : "ChatApplicationConfigurationResource to manage chat configurations"
}, {
"name" : "ChatDefinitionResource for managing chatbot definitions"
}, {
"name" : "ChatEventResource for managing chatbot events"
}, {
"name" : "ChatbotChannelTypeDescriptorResource for retrieving chabot channel type descriptor"
}, {
"name" : "ChatbotConfigurationResource to manage chatbot configurations"
}, {
"name" : "CommandResource for executing various commands"
}, {
"name" : "ConnectionInstanceResource for managing connection instances of various connection types"
}, {
"name" : "ConnectorOperationResource for executing connector operations"
}, {
"name" : "ConnectorResource for managing connector services"
}, {
"name" : "ContainerRolePermissionResource for managing container role permissions"
}, {
"name" : "CreatePackageStatusResource for managing created packages"
}, {
"name" : "DataPageResource for data page queries"
}, {
"name" : "DataSourceResource for managing data sources"
}, {
"name" : "DeploymentPackageResource for managing deployment packages"
}, {
"name" : "DeploymentPackageStatusResource for managing deployment packages' status"
}, {
"name" : "DeploymentRollbackStatusResource for managing bundle rollback status"
}, {
"name" : "DeploymentStatusResource for managing status of deployment"
}, {
"name" : "DeploymentTrackerResource to startend of rollback of bundle during upgrade"
}, {
"name" : "DocumentDefinitionResource for managing document definitions"
}, {
"name" : "EventDefinitionResource for managing event definitions"
}, {
"name" : "EventStatisticsDefinitionResource for managing event statistics definitions"
}, {
"name" : "FunctionResource for managing workflow functions"
}, {
"name" : "FunctionalRoleResource for managing functional roles"
}, {
"name" : "Gainsight resource for managing Gainsight telemetry configuration and user preferences"
}, {
"name" : "GroupResource for managing groups"
}, {
"name" : "HealthCheckonitorResource for managing health check monitoring services"
}, {
"name" : "HelixGPT Resource to retrieve information"
}, {
"name" : "KnowledgeResource for knowledge articles"
}, {
"name" : "LicenseManagementResource for managing application licenses"
}, {
"name" : "LicenseUsageResource for managing license usages"
}, {
"name" : "LivehatResource to retrieve live chat configurations"
}, {
"name" : "LocalizedStringsResource for managing localized strings"
}, {
"name" : "LoginContentResource for managing various login contents"
}, {
"name" : "LoginRequestResource to manage login requests"
}, {
"name" : "LogoutRequestResource to manage logout requests"
}, {
"name" : "NamedListDefinitionResource for managing named list definitions"
}, {
"name" : "NotificationHistoryResource to fetch notification history records"
}, {
"name" : "OAuthResource for managing auth tokens for configurations"
}, {
"name" : "PiiResource for managing GDPR operations"
}, {
"name" : "PinResource for managing pin services"
}, {
"name" : "ProcessDefinitionResource for managing process definitions"
}, {
"name" : "ProcessInstanceResource for managing process instances"
}, {
"name" : "RecordDefinitionResource for managing record definitions"
}, {
"name" : "RecordInstanceResource for managing record instances"
}, {
"name" : "RemoteServerResource for managing remote servers"
}, {
"name" : "Rest resource to manage shared view presets"
}, {
"name" : "RoleResource for managing role definitions"
}, {
"name" : "RuleDefinitionResource for managing rule definitions"
}, {
"name" : "SanityResource"
}, {
"name" : "SmartReportingUrlResource for managing smart reporting url service"
}, {
"name" : "SystemConfigurationResource for managing system configurations"
}, {
"name" : "TenantResource for managing tenants"
}, {
"name" : "TextTemplateResource for managing text templates"
}, {
"name" : "The resource class for CRU operations on notification config details"
}, {
"name" : "ThemeResource for managing themeCss"
}, {
"name" : "UCWAChatResource for managing UCWA skype chat resources"
}, {
"name" : "User resource for managing people permissions"
}, {
"name" : "User resource for managing users"
}, {
"name" : "ViewDefinitionResource for managing view definitions"
}, {
"name" : "WebApiConnectionResource for managing web API connections"
}, {
"name" : "WebApiDefinitionResource for managing Web Api definitions"
}, {
"name" : "WebhookCallbackProcessorMetadataResource for webhook processor metadata"
}, {
"name" : "WebhookCallbackProcessorResource"
}, {
"name" : "WebhookDefinitionResource for managing webhook definitions"
} ],
"paths" : {
"/rx/application/admin-settings/component" : {
"post" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Creates component",
"description" : "Creates component provided admin component definition",
"operationId" : "createComponentDefinition",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The component definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AdminComponentDefinition"
}
} ],
"responses" : {
"201" : {
"description" : "CRATED: Successful creation of component"
}
}
}
},
"/rx/application/admin-settings/component-definition/{compName}" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the component definition",
"description" : "Gets the component definition provided component name",
"operationId" : "getAdminSettingMetaData",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of component definition",
"schema" : {
"$ref" : "#/definitions/AdminSettingMetaData"
}
}
}
}
},
"/rx/application/admin-settings/component-griddata/{compName}" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the admin component grid data",
"description" : "Gets the admin component grid data provided component name",
"operationId" : "getSettingsDataCollection",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of admin component grid data",
"schema" : {
"$ref" : "#/definitions/AdminComponentGridData"
}
}
}
}
},
"/rx/application/admin-settings/component-griddata/{compName}/{parentOwnerKey}" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the admin component grid data",
"description" : "Gets the admin component grid data provided component name and parent owner key",
"operationId" : "getSettingsDataCollection",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"name" : "parentOwnerKey",
"in" : "path",
"description" : "The parent owner key",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of admin component grid data",
"schema" : {
"$ref" : "#/definitions/AdminComponentGridData"
}
}
}
}
},
"/rx/application/admin-settings/component-settings/{compName}" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the admin setting data container",
"description" : "Retrieves the admin setting data container provided the component name",
"operationId" : "getAdminSettingData",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of admin setting data container",
"schema" : {
"$ref" : "#/definitions/AdminSettingDataContainer"
}
}
}
},
"post" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Creates component setting",
"description" : "Creates component setting provided component name and setting data",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The setting data",
"required" : true,
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AdminSettingData"
}
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of component setting"
}
}
}
},
"/rx/application/admin-settings/component-settings/{compName}/{compValue}" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the admin setting data",
"description" : "Retrieves the admin setting data provided component name and value",
"operationId" : "getAdminSettingData",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"name" : "compValue",
"in" : "path",
"description" : "The component value",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of admin setting data",
"schema" : {
"$ref" : "#/definitions/AdminSettingDataContainer"
}
}
}
}
},
"/rx/application/admin-settings/component-settings/{compName}/{ownerKey}" : {
"put" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Updates component setting",
"description" : "Updates component setting provided component name, setting data and parent owner key",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"name" : "ownerKey",
"in" : "path",
"description" : "The parent owner key",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The admin setting data",
"required" : true,
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AdminSettingData"
}
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of component setting"
}
}
},
"delete" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Deletes component setting",
"description" : "Deletes component setting provided component name and parent owner key",
"operationId" : "delete",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"name" : "ownerKey",
"in" : "path",
"description" : "The parent owner key",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: The delete operation is successful"
}
}
}
},
"/rx/application/admin-settings/component-settings/{compName}/{parentOwnerKey}" : {
"post" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Creates component setting",
"description" : "Creates component setting provided component name, setting data and parent owner key",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"name" : "parentOwnerKey",
"in" : "path",
"description" : "The parent owner key",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The setting data",
"required" : true,
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AdminSettingData"
}
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of component setting"
}
}
}
},
"/rx/application/admin-settings/component-settings/{parentComponent}/{compName}/{parentCompValue}" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the admin setting data",
"description" : "Gets the admin setting data provided parent component data and component name",
"operationId" : "getAdminSettingData",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "parentComponent",
"in" : "path",
"description" : "The parent component",
"required" : true,
"type" : "string"
}, {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"name" : "parentCompValue",
"in" : "path",
"description" : "The parent component value",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of admin setting data",
"schema" : {
"$ref" : "#/definitions/AdminSettingDataContainer"
}
}
}
}
},
"/rx/application/admin-settings/component/{compName}" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the component definition",
"description" : "Gets the component definition provided component name",
"operationId" : "getComponentDefinition",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of component definition",
"schema" : {
"$ref" : "#/definitions/AdminComponentDefinition"
}
}
}
},
"put" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Updates component definition",
"description" : "Updates component definition provided component name and admin component definition ",
"operationId" : "updateComponentDefinition",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The component definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AdminComponentDefinition"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of component definition"
}
}
},
"delete" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Deletes component definition",
"description" : "Deletes component definition provided component name",
"operationId" : "deleteComponentDefinition",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: The delete operation is successful"
}
}
}
},
"/rx/application/admin-settings/components-list" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the components",
"description" : "Retrieves the components-list",
"operationId" : "getComponents",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of component",
"schema" : {
"type" : "array",
"items" : {
"type" : "array",
"items" : {
"type" : "object"
}
}
}
}
}
}
},
"/rx/application/admin-settings/local/component-definition/{compName}" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the component definition",
"description" : "Retrieves the component definition provided component name",
"operationId" : "getLocalAdminSettingMetaData",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of component definition",
"schema" : {
"$ref" : "#/definitions/AdminSettingMetaData"
}
}
}
}
},
"/rx/application/admin-settings/local/component-griddata/{compName}" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the admin component grid data",
"description" : "Gets the admin component grid data provided component name",
"operationId" : "getLocalSettingsDataCollection",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of admin component grid data",
"schema" : {
"$ref" : "#/definitions/AdminComponentGridData"
}
}
}
}
},
"/rx/application/admin-settings/local/component-griddata/{compName}/{parentOwnerKey}" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the admin component grid data",
"description" : "Gets the admin component grid data provided component name and parent owner key",
"operationId" : "getLocalSettingsDataCollection",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"name" : "parentOwnerKey",
"in" : "path",
"description" : "The parent owner key",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of admin component grid data",
"schema" : {
"$ref" : "#/definitions/AdminComponentGridData"
}
}
}
}
},
"/rx/application/admin-settings/local/component-settings/{compName}" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the admin setting data",
"description" : "Gets the admin setting data provided component name",
"operationId" : "getLocalAdminSettingData",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of admin setting data",
"schema" : {
"$ref" : "#/definitions/AdminSettingDataContainer"
}
}
}
},
"post" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Creates local component setting",
"description" : "Creates local component setting provided component name and admin setting data",
"operationId" : "createLocalComponent",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The setting data",
"required" : true,
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AdminSettingData"
}
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation for local component setting"
}
}
}
},
"/rx/application/admin-settings/local/component-settings/{compName}/{compValue}" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the admin setting data",
"description" : "Gets the admin setting data provided component name and component value",
"operationId" : "getLocalAdminSettingData",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"name" : "compValue",
"in" : "path",
"description" : "The component value",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of admin setting data",
"schema" : {
"$ref" : "#/definitions/AdminSettingDataContainer"
}
}
}
}
},
"/rx/application/admin-settings/local/component-settings/{compName}/{ownerKey}" : {
"put" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Update local component setting",
"description" : "Update local component setting provided component name, owner key and setting data",
"operationId" : "updateLocalComponent",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"name" : "ownerKey",
"in" : "path",
"description" : "The owner key",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The setting instance",
"required" : true,
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AdminSettingData"
}
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful update for local component setting"
}
}
},
"delete" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Deletes component setting",
"description" : "Deletes component setting provided component name and owner key",
"operationId" : "deleteLocalComponent",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"name" : "ownerKey",
"in" : "path",
"description" : "The owner key",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion"
}
}
}
},
"/rx/application/admin-settings/local/component-settings/{compName}/{parentOwnerKey}" : {
"post" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Creates local component setting",
"description" : "Creates local component setting provided component name, parent owner key and admin setting data",
"operationId" : "createLocalComponent",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"name" : "parentOwnerKey",
"in" : "path",
"description" : "The parent owner key",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The setting data",
"required" : true,
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AdminSettingData"
}
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation for local component setting"
}
}
}
},
"/rx/application/admin-settings/local/component-settings/{parentComponent}/{compName}/{parentCompValue}" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the admin setting data",
"description" : "Gets the admin setting data provided component name and parent component value",
"operationId" : "getLocalAdminSettingData",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "parentComponent",
"in" : "path",
"description" : "The parent component",
"required" : true,
"type" : "string"
}, {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"name" : "parentCompValue",
"in" : "path",
"description" : "The parent component value",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of admin setting data",
"schema" : {
"$ref" : "#/definitions/AdminSettingDataContainer"
}
}
}
}
},
"/rx/application/admin-settings/local/navigation-menu" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the admin navigation",
"description" : "Retrieves the admin navigation",
"operationId" : "getLocalNavigationData",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of admin navigation",
"schema" : {
"$ref" : "#/definitions/AdminNavigation"
}
}
}
}
},
"/rx/application/admin-settings/navigation-menu" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the admin navigation",
"description" : "Retrieves the admin navigation",
"operationId" : "getNavigationData",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of navigation",
"schema" : {
"$ref" : "#/definitions/AdminNavigation"
}
}
}
}
},
"/rx/application/admin-settings/user-preference-definition/{compName}" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the admin setting user preference meta data",
"description" : "Retrieves the admin setting user preference meta data provided component name",
"operationId" : "getAdminSettingUserreferenceMetaData",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of admin setting user preference meta data",
"schema" : {
"$ref" : "#/definitions/dminettingMetaData"
}
}
}
}
},
"/rx/application/admin-settings/user-preference-griddata/{compName}" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the admin component grid data",
"description" : "Retrieves the admin component grid data provided component name",
"operationId" : "getAdminSettingUserPreferenceDataCollection",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "he component name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of admin component grid data",
"schema" : {
"$ref" : "#/definitions/AdminComponentGridData"
}
}
}
}
},
"/rx/application/admin-settings/user-preference/{compName}" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the admin setting user preference data",
"description" : "Retrieves the admin setting user preference data provided component name",
"operationId" : "getAdminSettingUserPreferenceData",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of admin setting user preference data",
"schema" : {
"$ref" : "#/definitions/AdminSettingDataContainer"
}
}
}
},
"post" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Creates the user preference component setting",
"description" : "Creates the user preference component setting provided component name and setting data",
"operationId" : "createUserPreferenceComponentSettings",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The setting data",
"required" : true,
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AdminSettingData"
}
}
} ],
"responses" : {
"201" : {
"description" : "CRATED: Successful creation of user preference component setting"
}
}
}
},
"/rx/application/admin-settings/user-preference/{compName}/{compValue}" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the admin setting user preference data",
"description" : "Retrieves the admin setting user preference data provided component name and component value",
"operationId" : "getAdminSettingUserPreferenceData",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"name" : "compValue",
"in" : "path",
"description" : "The component value",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of admin setting user preference data",
"schema" : {
"$ref" : "#/definitions/AdminSettingDataContainer"
}
}
}
},
"put" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Update Setting",
"description" : "Update setting provided component name and component value",
"operationId" : "updateAdminSettingUserPreferenceData",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"name" : "compValue",
"in" : "path",
"description" : "The component value",
"required" : true,
"type" : "string"
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of setting"
}
}
}
},
"/rx/application/admin-settings/user-preference/{compName}/{ownerKey}" : {
"delete" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Delete user preference component settings",
"description" : "Delete user preference component settings provided component name and owner key",
"operationId" : "deleteUserPreferenceComponentSettings",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "compName",
"in" : "path",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"name" : "ownerKey",
"in" : "path",
"description" : "The owner key",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion"
}
}
}
},
"/rx/application/admin-settings/user-preferences" : {
"get" : {
"tags" : [ "AdminSettingsResource to manage admin settings" ],
"summary" : "Gets the user-preferences",
"description" : "Retrieve user-preferences",
"operationId" : "getUserPreferenceComponents",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of user preferences",
"schema" : {
"$ref" : "#/definitions/AdminNavigationComponent"
}
}
}
}
},
"/rx/application/appinfo" : {
"get" : {
"tags" : [ "AppInfoResource for managing Application Info" ],
"summary" : "Gets the application information",
"description" : "Gets the application information for all applications",
"operationId" : "getAppInfo",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of application information"
}
}
}
},
"/rx/application/association/associationdefinition" : {
"post" : {
"tags" : [ "AssociationDefinitionResource for managing association related definitions" ],
"summary" : "Creates an AssociationDefinition",
"description" : "Creates an association definition with given associationDefinition specifications",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The Association Definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AssociationDefinition"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of AssociationDefinition"
}
}
}
},
"/rx/application/association/associationdefinition/{associationName}" : {
"get" : {
"tags" : [ "AssociationDefinitionResource for managing association related definitions" ],
"summary" : "Gets an AssociationDefinition",
"description" : "Retrieves an AssociationDefinition provided an association name",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "associationName",
"in" : "path",
"description" : "The name of the AssociationDefinition.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of AssociationDefinition",
"schema" : {
"$ref" : "#/definitions/AssociationDefinition"
}
}
}
},
"put" : {
"tags" : [ "AssociationDefinitionResource for managing association related definitions" ],
"summary" : "Updates an association definition",
"description" : "Updates an association definition",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "associationName",
"in" : "path",
"description" : "The name of the AssociationDefinition",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The AssociationDefinition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AssociationDefinition"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of association definition"
}
}
},
"delete" : {
"tags" : [ "AssociationDefinitionResource for managing association related definitions" ],
"summary" : "Deletes an AssociationDefinition",
"description" : "Deletes an AssociationDefinition provided association name",
"operationId" : "delete",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "associationName",
"in" : "path",
"description" : "The name of the AssociationDefinition",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of AssociationDefinition"
}
}
}
},
"/rx/application/bundle/bundledescriptor" : {
"post" : {
"tags" : [ "undleDescriptorResource to manage bundle descriptors" ],
"summary" : "BundleDescriptor post",
"description" : "",
"operationd" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The bundle descriptor",
"required" : true,
"schema" : {
"$ref" : "#/definitions/BundleDescriptor"
}
} ],
"responses" : {
"200" : {
"description" : "OK: Successful operation"
}
}
}
},
"/rx/application/bundle/bundledescriptor/{bundleId}" : {
"get" : {
"tags" : [ "BundleDescriptorResource to manage bundle descriptors" ],
"summary" : "Gets the requested bundle details",
"description" : "Retrieves the requested bundle details provided bundle Id",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "bundleId",
"in" : "path",
"description" : "The bundle Id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval requested bundle details",
"schema" : {
"$ref" : "#/definitions/BundleDescriptor"
}
}
}
}
},
"/rx/application/bundle/bundledescriptor/{bundleId}/json" : {
"get" : {
"tags" : [ "BundleDescriptorResource to manage bundle descriptors" ],
"summary" : "Gets the bundle details as JSO response",
"description" : "Retrieves the bundle details as JSON response provided bundle Id",
"operationId" : "getJsonResponse",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "bundleId",
"in" : "path",
"description" : "The bundle Id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of bundle details as JSON response",
"schema" : {
"$ref" : "#/definitions/BundleDescriptor"
}
}
}
}
},
"/rx/application/bundle/bundledescriptor/{bundleId}/jsonp" : {
"get" : {
"tags" : [ "BundleDescriptorResource to manage bundle descriptors" ],
"summary" : "Gets the requested bundle details as JSONP response",
"description" : "Retrieves the requested bundle details as JSONP response provided bundle Id(Deprecated)",
"operationId" : "getJsonpResponse",
"produces" : [ "application/javascript", "application/x-javascript" ],
"parameters" : [ {
"name" : "bundleId",
"in" : "path",
"description" : "The bundle Id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of requested bundle details as JSONP response",
"schema" : {
"$ref" : "#/definitions/BundleDescriptor"
}
}
}
}
},
"/rx/application/bundle/containerrolepermission/{applicationName}/{roleName}" : {
"get" : {
"tags" : [ "ContainerRolePermissionResource for managing container role permissions" ],
"summary" : "Gets the container permissions",
"description" : "Retrieves the container permissions provided application name and role name",
"operationId" : "get",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "applicationName",
"in" : "path",
"description" : "The application container name",
"required" : true,
"type" : "string"
}, {
"name" : "roleName",
"in" : "path",
"description" : "The role name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of role permissions",
"schema" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
}
}
},
"put" : {
"tags" : [ "ContainerRolePermissionResource for managing container role permissions" ],
"summary" : "Sets container visible",
"description" : "Sets container visible provided application name and role name",
"operationId" : "show",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "applicationName",
"in" : "path",
"description" : "The application container name",
"required" : true,
"type" : "string"
}, {
"name" : "roleName",
"in" : "path",
"description" : "The role name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"delete" : {
"tags" : [ "ContainerRolePermissionResource for managing container role permissions" ],
"summary" : "Deletes permission against application container",
"description" : "Deletes permission against application container for given application name and role",
"operationId" : "delete",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "applicationName",
"in" : "path",
"description" : "The application container name",
"required" : true,
"type" : "string"
}, {
"name" : "roleName",
"in" : "path",
"description" : "The role name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion"
}
}
}
},
"/rx/application/bundle/createpackagestatus/{packageRegistryId}" : {
"get" : {
"tags" : [ "CreatePackageStatusResource for managing created packages" ],
"summary" : "Gets the requested created package",
"description" : "Retrieves the requested created package provided package registry id",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "packageRegistryId",
"in" : "path",
"description" : "The package registry id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval",
"schema" : {
"$ref" : "#/definitions/CreatePackageStatus"
}
}
}
}
},
"/rx/application/bundle/deploymentpackage" : {
"post" : {
"tags" : [ "DeploymentPackageResource for managing deployment packages" ],
"summary" : "Deploys the given package",
"description" : "Deploys the given package with given file input stream",
"operationId" : "post",
"consumes" : [ "multipart/form-data" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The input stream",
"required" : true,
"schema" : {
"$ref" : "#/definitions/InputStream"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/rx/application/bundle/deploymentpackage/status/{guid}" : {
"get" : {
"tags" : [ "DeploymentPackageStatusResource for managing deployment packages' status" ],
"summary" : "Returns status of package/bundle",
"description" : "Returns status of package/bundle provided package guid.",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "guid",
"in" : "path",
"description" : "Bundle GUID or package registry id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval"
}
}
}
},
"/rx/application/bundle/deploymentpackage/{bundleId}" : {
"delete" : {
"tags" : [ "DeploymentPackageResource for managing deployment packages" ],
"summary" : "Undeploy bundle",
"description" : "Undeploy given bundle with provided bundle id",
"operationId" : "delete",
"parameters" : [ {
"name" : "bundleId",
"in" : "path",
"description" : "The bundle Id/Package id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful undeployment"
}
}
}
},
"/rx/application/bundle/deploymentpackage/{bundleId}/{packageRegistryId}" : {
"get" : {
"tags" : [ "DeploymentPackageResource for managing deployment packages" ],
"summary" : "Gets the distributable package",
"description" : "Gets the distributable package provided package registry id",
"operationId" : "getDeploymentPackage",
"parameters" : [ {
"name" : "packageRegistryId",
"in" : "path",
"description" : "The package registry id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of distributable package",
"schema" : {
"$ref" : "#/definitions/PackageDescriptor"
}
}
}
}
},
"/rx/application/bundle/deploymentrollback/status/{guid}" : {
"get" : {
"tags" : [ "DeploymentRollbackStatusResource for managing bundle rollback status" ],
"summary" : "Returns status of rollback of package/bundle",
"description" : "Returns status of package/bundle provided package guid.",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "guid",
"in" : "path",
"description" : "Bundle GUID or package registry id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval"
}
}
}
},
"/rx/application/bundle/deploymentrollback/{bundleId}" : {
"post" : {
"tags" : [ "BundleRollbackResource for managing rollback of bundle during upgrade" ],
"summary" : "Rollback the given bundle",
"description" : "Rolls back given bundle",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "bundleId",
"in" : "path",
"description" : "The bundle id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/rx/application/bundle/deploymentstatus/{packageRegistryId}" : {
"get" : {
"tags" : [ "DeploymentStatusResource for managing status of deployment" ],
"summary" : "Gets the requested bundle dependency map.",
"description" : "Retrieves the requested bundle dependency map provided package registry id and bundle version",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "packageRegistryId",
"in" : "path",
"description" : "The package registry id",
"required" : true,
"type" : "string"
}, {
"name" : "bundleVersion",
"in" : "query",
"description" : "The bundle version",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of bundle dependency map",
"schema" : {
"$ref" : "#/definitions/DeploymentStatus"
}
}
}
}
},
"/rx/application/chat/chatapplicationconfiguration/{bundleid}/{chatbotprovider}" : {
"get" : {
"tags" : [ "ChatApplicationConfigurationResource to manage chat configurations" ],
"summary" : "Gets the chat application configuration",
"description" : "Gets the chat application configuration provided bundle id and chatbot provider",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "bundleid",
"in" : "path",
"description" : "The bundle id of the chatbot application",
"required" : true,
"type" : "string"
}, {
"name" : "chatbotprovider",
"in" : "path",
"description" : "The chatbot provider",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of chat application configuration",
"schema" : {
"$ref" : "#/definitions/RecordInstance"
}
}
}
}
},
"/rx/application/chat/chatbotchanneltypedescriptor/{type}" : {
"get" : {
"tags" : [ "ChatbotChannelTypeDescriptorResource for retrieving chabot channel type descriptor" ],
"summary" : "Gets the chatbot channel configuration",
"description" : "Retrieves the chatbot channel configuration provided descriptor type",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "type",
"in" : "path",
"description" : "The type",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of chatbot channel configuration",
"schema" : {
"$ref" : "#/definitions/RecordInstance"
}
}
}
}
},
"/rx/application/chat/chatbotconfiguration/availablechatbots/{locale}" : {
"get" : {
"tags" : [ "ChatbotConfigurationResource to manage chatbot configurations" ],
"summary" : "Get Available Chatbot configurations",
"description" : "Get all available chatbot configuration across bundles in application based of the user permission on bundles and provided locale.",
"operationId" : "getAvailableChatbotconfigurations",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "locale",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful Collection of chatbot information with id, name, locale, bundleid details"
}
}
}
},
"/rx/application/chat/chatbotconfiguration/chatbotlocale/locale" : {
"post" : {
"tags" : [ "ChatbotConfigurationResource to manage chatbot configurations" ],
"summary" : "Gets the details of the Watson workspace",
"description" : "Gets the details of the Watson workspace for given chatbot locale",
"operationId" : "getChatLocaleFromWorkspace",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The chatbot locale",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ChatbotLocale"
}
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of watson workspace details",
"schema" : {
"$ref" : "#/definitions/ChatbotLocale"
}
}
}
}
},
"/rx/application/chat/chatbotconfiguration/supportedlocales" : {
"get" : {
"tags" : [ "ChatbotConfigurationResource to manage chatbot configurations" ],
"summary" : "Gets the chat locale definition with workspace and other details.",
"description" : "",
"operationId" : "getSupportedLocales",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of chat locale definition with workspace and other details",
"schema" : {
"type" : "string"
}
}
}
}
},
"/rx/application/chat/chatbotconfiguration/virtualchattopics" : {
"get" : {
"tags" : [ "ChatbotConfigurationResource to manage chatbot configurations" ],
"summary" : "Gets the chat locale definition with workspace and other details",
"description" : "Gets the chat locale definition with workspace and other details",
"operationId" : "getVirtualChatTopics",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of chat locale definition with workspace and other details"
}
}
}
},
"/rx/application/chat/chatbotconfiguration/{chatbotconfigurationid}" : {
"get" : {
"tags" : [ "ChatbotConfigurationResource to manage chatbot configurations" ],
"summary" : "Gets the chat locale definition with workspace and other details",
"description" : "Retrieves the chat locale definition with workspace and other details provided chatbot configuration id",
"operationId" : "getChatWorkspaceInfo",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "chatbotconfigurationid",
"in" : "path",
"description" : "The chatbot configuration id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval chat locale definition",
"schema" : {
"$ref" : "#/definitions/ChatbotConfiguration"
}
}
}
}
},
"/rx/application/chat/chatbotconfiguration/{chatbotconfigurationid}/{locale}/chattopics" : {
"get" : {
"tags" : [ "ChatbotConfigurationResource to manage chatbot configurations" ],
"summary" : "Get the chat topics",
"description" : "Gets a Chat topics associated with the Chatbot configuration of passed locale",
"operationId" : "getChatTopics",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "chatbotconfigurationid",
"in" : "path",
"description" : "The chatbot configuration id",
"required" : true,
"type" : "string"
}, {
"name" : "locale",
"in" : "path",
"description" : "The locale id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of chat locale definition with workspace and other details"
}
}
}
},
"/rx/application/chat/chatdefinition" : {
"get" : {
"tags" : [ "ChatDefinitionResource for managing chatbot definitions" ],
"summary" : "Gets the chatbot workspace details",
"description" : "Gets the chatbot workspace details provided workspace id",
"operationId" : "getChatDefinition",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "workspaceId",
"in" : "query",
"required" : false,
"type" : "string"
}, {
"name" : "skillId",
"in" : "query",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of chatbot workspace details",
"schema" : {
"$ref" : "#/definitions/ChatDefinition"
}
}
}
},
"post" : {
"tags" : [ "ChatDefinitionResource for managing chatbot definitions" ],
"summary" : "Creates chat definition for a bundle",
"description" : "Creates chat definition for a bundle with given chat definition",
"operationId" : "post",
"consumes" : [ "application/json" ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of chat definition for a bundle"
}
}
}
},
"/rx/application/chat/chatdefinition/chatworkspace" : {
"post" : {
"tags" : [ "ChatDefinitionResource for managing chatbot definitions" ],
"summary" : "Gets the chat definition with workspace details",
"description" : "Gets the chat definition with workspace details provided like credentials and workpace id",
"operationId" : "getChatWorkspaceInfo",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The chatbot locale",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ChatbotLocale"
}
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval",
"schema" : {
"$ref" : "#/definitions/ChatDefinition"
}
}
}
}
},
"/rx/application/chat/chatdefinition/chatworkspace/{workspaceid}" : {
"put" : {
"tags" : [ "ChatDefinitionResource for managing chatbot definitions" ],
"summary" : "Modifies the chat definition workspace",
"description" : "Modifies workspace information like disambiuation properties etc.",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "workspaceid",
"in" : "path",
"description" : "The chat definition workspace id",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The chat definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ChatDefinition"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful update "
}
}
}
},
"/rx/application/chat/chatdefinition/import/helixgpt/{bundleId}" : {
"post" : {
"tags" : [ "ChatDefinitionResource for managing chatbot definitions" ],
"summary" : "Imports chat definition for a bundle",
"description" : "Imports chat definition for a bundle provided bundle Id and chat definition",
"operationId" : "importChatDefinitionForSkill",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "bundleId",
"in" : "path",
"description" : "The bundle id",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The chat definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ChatDefinition"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful import of chat definition"
}
}
}
},
"/rx/application/chat/chatdefinition/import/{bundleId}" : {
"get" : {
"tags" : [ "ChatDefinitionResource for managing chatbot definitions" ],
"summary" : "Gets the chat definition",
"description" : "Retrieves the chat definition for import to chatbot workspace",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "serviceRevisionId",
"in" : "query",
"description" : "The service revision id ",
"required" : true,
"type" : "string"
}, {
"name" : "chatImportSourceType",
"in" : "query",
"description" : "The chat import source type ",
"required" : true,
"type" : "string"
}, {
"name" : "bundleId",
"in" : "path",
"description" : "The bundle id",
"required" : true,
"type" : "string"
}, {
"name" : "locale",
"in" : "query",
"description" : "The locale preferred",
"required" : true,
"type" : "string"
}, {
"name" : "publicationType",
"in" : "query",
"description" : "The operation type if use new or last published chat defintion",
"required" : false,
"type" : "string"
}, {
"name" : "chatbotId",
"in" : "query",
"description" : "The chatbot configuration id",
"required" : false,
"type" : "string"
}, {
"name" : "skillId",
"in" : "query",
"description" : "The skill id",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of chat definition",
"schema" : {
"$ref" : "#/definitions/ChatDefinition"
}
}
}
},
"post" : {
"tags" : [ "ChatDefinitionResource for managing chatbot definitions" ],
"summary" : "Imports chat definition for a bundle",
"description" : "Imports chat definition for a bundle provided bundle Id and chat definition",
"operationId" : "importChatDefinition",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "bundleId",
"in" : "path",
"description" : "The bundle id",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The chat definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ChatDefinition"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful import of chat definition"
}
}
}
},
"/rx/application/chat/chatdefinition/intents" : {
"post" : {
"tags" : [ "ChatDefinitionResource for managing chatbot definitions" ],
"summary" : "Gets the details of the Watson workspace",
"description" : "Gets the details of the Watson workspace for given chatbot locale",
"operationId" : "getChatWorkspaceIntentDefinitions",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The chatbot locale",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ChatbotLocale"
}
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of Watson Assistant skill intents"
}
}
}
},
"/rx/application/chat/chatdefinition/workspace/{bundleId}" : {
"get" : {
"tags" : [ "ChatDefinitionResource for managing chatbot definitions" ],
"summary" : "Gets the chat definition with workspace details",
"description" : "Gets the chat definition with workspace details provided bundle id and locale",
"operationId" : "getChatWorkspaceInfo",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "bundleId",
"in" : "path",
"description" : "The bundle id",
"required" : true,
"type" : "string"
}, {
"name" : "locale",
"in" : "query",
"description" : "The locale preferred",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval",
"schema" : {
"$ref" : "#/definitions/ChatDefinition"
}
}
}
}
},
"/rx/application/chat/chatdefinition/{chatDefinitionName}" : {
"get" : {
"tags" : [ "ChatDefinitionResource for managing chatbot definitions" ],
"summary" : "Gets the chat definition",
"description" : "Retrieves the chat definition for a given name",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "chatDefinitionName",
"in" : "path",
"description" : "The name of chat definition",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of chat definition",
"schema" : {
"$ref" : "#/definitions/ChatDefinition"
}
}
}
},
"put" : {
"tags" : [ "ChatDefinitionResource for managing chatbot definitions" ],
"summary" : "Modifies the chat definition",
"description" : "Modifies the chat definition provided chat definition name and chat definition",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "chatDefinitionName",
"in" : "path",
"description" : "The chat definition name",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The chat definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ChatDefinition"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful update "
}
}
},
"delete" : {
"tags" : [ "ChatDefinitionResource for managing chatbot definitions" ],
"summary" : "Deletes the chat definition",
"description" : "Deletes the chat definition for given chat definition name",
"operationId" : "delete",
"parameters" : [ {
"name" : "chatDefinitionName",
"in" : "path",
"description" : "The chat definition name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of chat definition"
}
}
}
},
"/rx/application/chat/event/{chatProvider}/{tenantId}" : {
"post" : {
"tags" : [ "ChatEventResource for managing chatbot events" ],
"summary" : "Handles chat event",
"description" : "Handles chat event provided request body, chat provider and tenant Id",
"operationId" : "post",
"consumes" : [ "application/json", "application/x-www-form-urlencoded" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The request body",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "chatProvider",
"in" : "path",
"description" : "The chat provider",
"required" : true,
"type" : "string"
}, {
"name" : "tenantId",
"in" : "path",
"description" : "The tenant id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/rx/application/chat/event/{chatbotchannel}/{tenantId}/{botId}" : {
"post" : {
"tags" : [ "ChatEventResource for managing chatbot events" ],
"summary" : "Handles chat event",
"description" : "Handles chat event provided request body, chatbot channel, chatbot Id and tenant Id",
"operationId" : "post",
"consumes" : [ "application/json", "application/x-www-form-urlencoded" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The request body",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"name" : "chatbotchannel",
"in" : "path",
"description" : "The chatbot channel",
"required" : true,
"type" : "string"
}, {
"name" : "tenantId",
"in" : "path",
"description" : "The tenant id",
"required" : true,
"type" : "string"
}, {
"name" : "botId",
"in" : "path",
"description" : "The chatbot id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/rx/application/chat/helixgpt" : {
"post" : {
"tags" : [ "HelixGPT Resource to retrieve information" ],
"summary" : "Invokes message API for HelixGPT Assistant",
"description" : "Conversation based information retrieval from HelixGPT",
"operationId" : "post",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The helix gpt message request object",
"required" : true,
"schema" : {
"$ref" : "#/definitions/HelixGPTMessageRequest"
}
} ],
"responses" : {
"200" : {
"description" : "OK: Successful "
}
}
}
},
"/rx/application/chat/livechat/virtualchat" : {
"get" : {
"tags" : [ "LiveChatResource to retrieve live chat configurations" ],
"summary" : "Gets the virtual chat url",
"description" : "Retrieves the virtual chat url from virtual chat configuration",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "embedded",
"in" : "query",
"description" : "The application embedding live agent",
"required" : true,
"type" : "string"
}, {
"name" : "userId",
"in" : "query",
"description" : "The User ID",
"required" : true,
"type" : "string"
}, {
"name" : "screenName",
"in" : "query",
"description" : "The application screen name for live agent",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of virtual chat url"
}
}
}
},
"/rx/application/command" : {
"post" : {
"tags" : [ "CommandResource for executing various commands" ],
"summary" : "Command post call for multipart",
"description" : "Builds a command response provided formDataMultiPart",
"operationId" : "post",
"consumes" : [ "multipart/form-data" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The form data multi part",
"required" : true,
"schema" : {
"$ref" : "#/definitions/FormDataMultiPart"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/rx/application/configuration/viewpreset" : {
"post" : {
"tags" : [ "Rest resource to manage shared view presets" ],
"summary" : "Creates a shared view preset record instance",
"description" : "",
"operationId" : "createSharedViewPreset",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "Shared View Preset object",
"required" : true,
"schema" : {
"$ref" : "#/definitions/SharedViewPreset"
}
} ],
"responses" : {
"200" : {
"description" : "OK: Successful creation of shared view preset"
}
}
}
},
"/rx/application/configuration/viewpreset/{sharedViewPresetGuid}" : {
"put" : {
"tags" : [ "Rest resource to manage shared view presets" ],
"summary" : "Updates a shared view preset record instance",
"description" : "",
"operationId" : "updateSharedViewPreset",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "sharedViewPresetGuid",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "Shared view preset",
"required" : false,
"schema" : {
"$ref" : "#/definitions/SharedViewPreset"
}
} ],
"responses" : {
"200" : {
"description" : "OK: Successful update of shared view preset"
},
"404" : {
"description" : "NOT FOUND: shared view preset record not found"
}
}
}
},
"/rx/application/connectioninstance/{connectorType}" : {
"get" : {
"tags" : [ "ConnectionInstanceResource for managing connection instances of various connection types" ],
"summary" : "Gets the connection instance guids(owner keys)",
"description" : "Retrieves the connection instance guids(owner keys) for given connector type",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "connectorType",
"in" : "path",
"description" : "The connector type",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of connection instance guids",
"schema" : {
"$ref" : "#/definitions/ConnectionInstance"
}
}
}
},
"put" : {
"tags" : [ "ConnectionInstanceResource for managing connection instances of various connection types" ],
"summary" : "Updates the list of connection instances",
"description" : "Updates the list of connection instances of a connection type",
"operationId" : "put",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "connectorType",
"in" : "path",
"description" : "The connector type",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The connection instances",
"required" : true,
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ConnectionInstance"
}
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of connection instances"
}
}
}
},
"/rx/application/connector/operation" : {
"get" : {
"tags" : [ "ConnectorOperationResource for executing connector operations" ],
"summary" : "Gets the connector operation descriptor",
"description" : "",
"operationId" : "getConnectorOperationDescriptor",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "aliasName",
"in" : "query",
"description" : "The alias name",
"required" : true,
"type" : "string"
}, {
"name" : "aliasType",
"in" : "query",
"description" : "The alias type",
"required" : true,
"type" : "string"
}, {
"name" : "operationName",
"in" : "query",
"description" : "The operation name",
"required" : true,
"type" : "string"
}, {
"name" : "bundleId",
"in" : "query",
"description" : "The bundle id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval",
"schema" : {
"$ref" : "#/definitions/ConnectorOperationDescriptor"
}
}
}
}
},
"/rx/application/datapage" : {
"get" : {
"tags" : [ "DataPageResource for data page queries" ],
"summary" : "Returns data page for given query.",
"description" : "Retrieves data page provided query parameters by name",
"operationId" : "get",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of data page",
"schema" : {
"$ref" : "#/definitions/DataPage"
}
}
}
},
"post" : {
"tags" : [ "DataPageResource for data page queries" ],
"summary" : "Returns data page for given query from request body.",
"description" : "Retrieves data page provided query parameters by name in the request body",
"operationId" : "post",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The data page query request",
"required" : true,
"schema" : {
"$ref" : "#/definitions/DataPageRequest"
}
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of data page",
"schema" : {
"$ref" : "#/definitions/DataPage"
}
}
}
}
},
"/rx/application/datasource/alias" : {
"get" : {
"tags" : [ "DataSourceResource for managing data sources" ],
"summary" : "Gets the aliases",
"description" : "Gets the aliases",
"operationId" : "getAliases",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of aliases"
}
}
}
},
"/rx/application/datasource/alias/{aliasName}" : {
"get" : {
"tags" : [ "DataSourceResource for managing data sources" ],
"summary" : "Gets the data source configuration by alias",
"description" : "Retrieves the data source configuration by alias",
"operationId" : "getByAlias",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "aliasName",
"in" : "path",
"description" : "The alias name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of data source configuration by alias",
"schema" : {
"$ref" : "#/definitions/DataSourceConfiguration"
}
}
}
}
},
"/rx/application/datasource/configuration" : {
"post" : {
"tags" : [ "DataSourceResource for managing data sources" ],
"summary" : "Creates the data source configuration",
"description" : "Creates the data source configuration provided data source configuration data",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The data source configuration",
"required" : true,
"schema" : {
"$ref" : "#/definitions/DataSourceConfiguration"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of data source configuration"
}
}
}
},
"/rx/application/datasource/configuration/{guid}" : {
"get" : {
"tags" : [ "DataSourceResource for managing data sources" ],
"summary" : "Gets the data source configuration by guid",
"description" : "Retrieves the data source configuration by guid",
"operationId" : "getByGuid",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "guid",
"in" : "path",
"description" : "The guid",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of data source configuration by guid ",
"schema" : {
"$ref" : "#/definitions/DataSourceConfiguration"
}
}
}
},
"put" : {
"tags" : [ "DataSourceResource for managing data sources" ],
"summary" : "Updates the data source configuration",
"description" : "Updates the data source configuration provided data source configuration data",
"operationId" : "put",
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The data source configuration",
"required" : true,
"schema" : {
"$ref" : "#/definitions/DataSourceConfiguration"
}
}, {
"name" : "guid",
"in" : "path",
"description" : "The guid",
"required" : true,
"type" : "string"
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of data source configuration"
}
}
},
"delete" : {
"tags" : [ "DataSourceResource for managing data sources" ],
"summary" : "Deletes the data source service",
"description" : "Deletes the data source service provided guid",
"operationId" : "delete",
"parameters" : [ {
"name" : "guid",
"in" : "path",
"description" : "The guid",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of data source service"
}
}
}
},
"/rx/application/datasource/table/{dataSourceName}/{tableName}" : {
"get" : {
"tags" : [ "DataSourceResource for managing data sources" ],
"summary" : "Gets the record definition",
"description" : "Retrieves the record definition provided data source name and table name",
"operationId" : "getRecordDefinition",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataSourceName",
"in" : "path",
"description" : "The data source name",
"required" : true,
"type" : "string"
}, {
"name" : "tableName",
"in" : "path",
"description" : "The table name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of record definition",
"schema" : {
"$ref" : "#/definitions/RecordDefinition"
}
}
}
}
},
"/rx/application/datasource/type" : {
"get" : {
"tags" : [ "DataSourceResource for managing data sources" ],
"summary" : "Gets the types of data sources",
"description" : "Retrieves the types of data sources",
"operationId" : "getTypes",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of data sources types"
}
}
}
},
"/rx/application/datasource/type/{dataSourceType}" : {
"get" : {
"tags" : [ "DataSourceResource for managing data sources" ],
"summary" : "Gets the data source by type",
"description" : "Retrieves the data source by type",
"operationId" : "getByType",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataSourceType",
"in" : "path",
"description" : "The data source type",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of data source by type"
}
}
}
},
"/rx/application/document/documentdefinition" : {
"post" : {
"tags" : [ "DocumentDefinitionResource for managing document definitions" ],
"summary" : "Creates a document definition",
"description" : "Creates a document definition provided document definition specifications",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The document definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/DocumentDefinition"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of document definition"
}
}
}
},
"/rx/application/document/documentdefinition/{name}" : {
"get" : {
"tags" : [ "DocumentDefinitionResource for managing document definitions" ],
"summary" : "Gets the document definition",
"description" : "Retrieves the document definition provided the name of document definition",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of document definition ",
"schema" : {
"$ref" : "#/definitions/DocumentDefinition"
}
}
}
},
"put" : {
"tags" : [ "DocumentDefinitionResource for managing document definitions" ],
"summary" : "Updates document definition",
"description" : "Updates document definition with given document definition",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The document definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/DocumentDefinition"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of document definition"
}
}
},
"delete" : {
"tags" : [ "DocumentDefinitionResource for managing document definitions" ],
"summary" : "Deletes the document definition",
"description" : "Deletes the document definition provided document definition name",
"operationId" : "delete",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of document definition"
}
}
}
},
"/rx/application/event/eventdefinition" : {
"post" : {
"tags" : [ "EventDefinitionResource for managing event definitions" ],
"summary" : "Creates an event definition",
"description" : "Creates an event definition provided event definition",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The event definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/EventDefinition"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of event definition"
}
}
}
},
"/rx/application/event/eventdefinition/{name}" : {
"get" : {
"tags" : [ "EventDefinitionResource for managing event definitions" ],
"summary" : "Gets the event definition",
"description" : "Retrieves the event definition for given event definition name",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of event definition",
"schema" : {
"$ref" : "#/definitions/EventDefinition"
}
}
}
},
"put" : {
"tags" : [ "EventDefinitionResource for managing event definitions" ],
"summary" : "Updates the event definition",
"description" : "Updates the event definition with given name and event definition",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The event definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/EventDefinition"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of event definition"
}
}
},
"delete" : {
"tags" : [ "EventDefinitionResource for managing event definitions" ],
"summary" : "Deletes the event definition",
"description" : "Deletes the event definition provided name of event definition",
"operationId" : "delete",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of event definition"
}
}
}
},
"/rx/application/event/eventstatisticsdefinition" : {
"post" : {
"tags" : [ "EventStatisticsDefinitionResource for managing event statistics definitions" ],
"summary" : "Creates the event statistics definition",
"description" : "Creates the event statistics definition",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The event statistics definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/EventStatisticsDefinition"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of event statistics definition"
}
}
}
},
"/rx/application/event/eventstatisticsdefinition/{name}" : {
"get" : {
"tags" : [ "EventStatisticsDefinitionResource for managing event statistics definitions" ],
"summary" : "Gets the event statistics definition",
"description" : "Gets the event statistics definition for given name of event statistics definition",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval event statistics definition",
"schema" : {
"$ref" : "#/definitions/EventStatisticsDefinition"
}
}
}
},
"put" : {
"tags" : [ "EventStatisticsDefinitionResource for managing event statistics definitions" ],
"summary" : "Updates the event statistics definition",
"description" : "Updates the event statistics definition with given event statistics name and definition",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The event statistics definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/EventStatisticsDefinition"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of event statistics definition"
}
}
},
"delete" : {
"tags" : [ "EventStatisticsDefinitionResource for managing event statistics definitions" ],
"summary" : "Deletes the event statistics definition",
"description" : "Deletes the event statistics definition provided the name",
"operationId" : "delete",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of event statistics definition"
}
}
}
},
"/rx/application/foundation/people/permissions/{loginName}" : {
"get" : {
"tags" : [ "User resource for managing people permissions" ],
"summary" : "Gets the permission details of user",
"description" : "Retrieves IS Personas and Bundle Access related permission details for a user",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "loginName",
"in" : "path",
"description" : "The login name",
"required" : true,
"type" : "string",
"pattern" : ".+"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of permission details"
}
}
},
"put" : {
"tags" : [ "User resource for managing people permissions" ],
"summary" : "Updates the permissions for given user",
"description" : "Updates IS persona and IS bundles access details for given user",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "loginName",
"in" : "path",
"description" : "The login name",
"required" : true,
"type" : "string",
"pattern" : ".+"
}, {
"in" : "body",
"name" : "body",
"description" : "The permissions object",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PeoplePermissions"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of given user permissions"
}
}
},
"delete" : {
"tags" : [ "User resource for managing people permissions" ],
"summary" : "Deletes the given permissions",
"description" : "Deleting the permissions as specified.",
"operationId" : "delete",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "loginName",
"in" : "path",
"description" : "The login name",
"required" : true,
"type" : "string",
"pattern" : ".+"
}, {
"in" : "body",
"name" : "body",
"description" : "The permissions object",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PeoplePermissions"
}
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of given user"
}
}
}
},
"/rx/application/functionalrole" : {
"post" : {
"tags" : [ "FunctionalRoleResource for managing functional roles" ],
"summary" : "Creates the functional role",
"description" : "Creates the functional role with given functional role parameters",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The functional role",
"required" : true,
"schema" : {
"$ref" : "#/definitions/FunctionalRole"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of functional role"
}
}
}
},
"/rx/application/functionalrole/{applicationName}/{functionalRoleName}" : {
"get" : {
"tags" : [ "FunctionalRoleResource for managing functional roles" ],
"summary" : "Gets the functional role",
"description" : "Retrieves the functional role for given application name and functional role name",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "applicationName",
"in" : "path",
"description" : "The application name",
"required" : true,
"type" : "string"
}, {
"name" : "functionalRoleName",
"in" : "path",
"description" : "The functional role name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of functional role",
"schema" : {
"$ref" : "#/definitions/FunctionalRole"
}
}
}
},
"put" : {
"tags" : [ "FunctionalRoleResource for managing functional roles" ],
"summary" : "Updates the functional role",
"description" : "Updates the functional role provided application name and functional role name",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "applicationName",
"in" : "path",
"description" : "The application name",
"required" : true,
"type" : "string"
}, {
"name" : "functionalRoleName",
"in" : "path",
"description" : "The functional role name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of functional role"
}
}
},
"delete" : {
"tags" : [ "FunctionalRoleResource for managing functional roles" ],
"summary" : "Deletes the functional role",
"description" : "Deletes the functional role for given application name and functional role",
"operationId" : "delete",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "applicationName",
"in" : "path",
"description" : "The application name",
"required" : true,
"type" : "string"
}, {
"name" : "functionalRoleName",
"in" : "path",
"description" : "The functional role name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of functional role"
}
}
}
},
"/rx/application/group" : {
"post" : {
"tags" : [ "GroupResource for managing groups" ],
"summary" : "Creates the given group",
"description" : "Creates the given group",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The group",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Group"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of group"
}
}
}
},
"/rx/application/group/{groupName}" : {
"get" : {
"tags" : [ "GroupResource for managing groups" ],
"summary" : "Gets the requested group",
"description" : "Retrieves the requested group details provided group name",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "groupName",
"in" : "path",
"description" : "The group name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of requested group",
"schema" : {
"$ref" : "#/definitions/Group"
}
}
}
},
"put" : {
"tags" : [ "GroupResource for managing groups" ],
"summary" : "Updates the given group",
"description" : "Updates the given group provided group name and info",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "groupName",
"in" : "path",
"description" : "The group name",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The group",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Group"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of given group"
}
}
},
"delete" : {
"tags" : [ "GroupResource for managing groups" ],
"summary" : "Deletes the given group",
"description" : "Deletes the given group provided group name",
"operationId" : "delete",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "groupName",
"in" : "path",
"description" : "The group name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of requested group"
}
}
}
},
"/rx/application/health/chatbot" : {
"get" : {
"tags" : [ "SanityResource" ],
"summary" : "Gets response of sanity check",
"description" : "This REST API does a sanity check of the chatbot workspace configuration with WATSON. It post all the chatbot configurations data to the WATSON for validation for the bundle.",
"operationId" : "chatbotConfigSanityCheck",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of sanity check response"
}
}
}
},
"/rx/application/knowledge" : {
"get" : {
"tags" : [ "KnowledgeResource for knowledge articles" ],
"summary" : "Common GET api",
"description" : "",
"operationId" : "httpCommonGetRequest",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "ComAroundRequest",
"in" : "query",
"description" : "ComAround request",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful Common GET request"
}
}
},
"post" : {
"tags" : [ "KnowledgeResource for knowledge articles" ],
"summary" : "Common POST api",
"description" : "",
"operationId" : "httpCommonPostRequest",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "ComAroundRequest",
"in" : "query",
"description" : "ComAround request",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The json body",
"required" : false,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK: Successful Common POST request"
}
}
},
"delete" : {
"tags" : [ "KnowledgeResource for knowledge articles" ],
"summary" : "Common DELETE api",
"description" : "",
"operationId" : "httpCommonDeleteRequest",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "ComAroundRequest",
"in" : "query",
"description" : "ComAround request",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful Common DELETE request"
}
}
}
},
"/rx/application/knowledge/article/{articleId}" : {
"get" : {
"tags" : [ "KnowledgeResource for knowledge articles" ],
"summary" : "Gets the article details",
"description" : "Retrieves article details of the given article id",
"operationId" : "getKnowledgeArticle",
"produces" : [ "application/json;charset=UTF-8" ],
"parameters" : [ {
"name" : "articleId",
"in" : "path",
"description" : "The article id",
"required" : true,
"type" : "string"
}, {
"name" : "outputFormat",
"in" : "query",
"description" : "The Output format",
"required" : false,
"type" : "string"
}, {
"name" : "updateViewCount",
"in" : "query",
"description" : "The update view count",
"required" : false,
"type" : "boolean"
}, {
"name" : "locale",
"in" : "query",
"description" : "The locale",
"required" : false,
"type" : "string"
}, {
"name" : "includeViewCount",
"in" : "query",
"description" : "Include view count",
"required" : false,
"type" : "boolean"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of article details",
"schema" : {
"type" : "string"
}
}
}
}
},
"/rx/application/knowledge/hkm/settings" : {
"get" : {
"tags" : [ "KnowledgeResource for knowledge articles" ],
"summary" : "Get HKM configuration settings",
"description" : "",
"operationId" : "getHKMConfigSettings",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful Get HKM configuration settings"
}
}
}
},
"/rx/application/knowledge/mapping/delete/{hkmGroupMappingGuids}" : {
"delete" : {
"tags" : [ "KnowledgeResource for knowledge articles" ],
"summary" : "Delete mapping record definition",
"description" : "",
"operationId" : "deleteMappingRecordDefinition",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "hkmGroupMappingGuids",
"in" : "path",
"description" : "The HKM group mapping guids",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful Delete mapping record definition"
}
}
}
},
"/rx/application/knowledge/mapping/hkm" : {
"get" : {
"tags" : [ "KnowledgeResource for knowledge articles" ],
"summary" : "Get HKM mapping details",
"description" : "Retrieves the support groups by company include the mapping details of the supportGroups",
"operationId" : "getMappingDetailsHKM",
"produces" : [ "application/json;charset=UTF-8" ],
"responses" : {
"200" : {
"description" : "OK: Successful Mapping details of the supportGroups"
}
}
}
},
"/rx/application/knowledge/mapping/itsm" : {
"get" : {
"tags" : [ "KnowledgeResource for knowledge articles" ],
"summary" : "Get ITSM mapping details",
"description" : "Retrieves the support groups by company include the mapping details of the supportGroups",
"operationId" : "getMappingDetailsITSM",
"produces" : [ "application/json;charset=UTF-8" ],
"responses" : {
"200" : {
"description" : "OK: Successful Mapping details of the supportGroups"
}
}
}
},
"/rx/application/knowledge/mapping/save" : {
"post" : {
"tags" : [ "KnowledgeResource for knowledge articles" ],
"summary" : "Update mapping record definition",
"description" : "",
"operationId" : "createOrUpdateGroupMappingRecordDefinitions",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "hkmGroupMapping Object as String",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK: Successful Update mapping record definition"
}
}
}
},
"/rx/application/knowledge/remedy/access" : {
"get" : {
"tags" : [ "KnowledgeResource for knowledge articles" ],
"summary" : "Gets the support groups",
"description" : "Retrieves the support groups by company",
"operationId" : "knowledgeAccess",
"consumes" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of support groups by company"
}
}
}
},
"/rx/application/knowledge/remedy/access/user" : {
"get" : {
"tags" : [ "KnowledgeResource for knowledge articles" ],
"summary" : "Gets the user permission groups details",
"description" : "Retrieves permission groups details of the given user id",
"operationId" : "userAccess",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "user",
"in" : "query",
"description" : "The user id",
"required" : true,
"type" : "string"
}, {
"name" : "location-access",
"in" : "query",
"description" : "The location of group access",
"required" : false,
"type" : "string"
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful selection of user access"
}
}
}
},
"/rx/application/knowledge/search" : {
"get" : {
"tags" : [ "KnowledgeResource for knowledge articles" ],
"summary" : "Returns the articles",
"description" : "Returns articles based on the criteria",
"operationId" : "search",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "searchPhrase",
"in" : "query",
"description" : "The search phrase",
"required" : false,
"type" : "string"
}, {
"name" : "sortBy",
"in" : "query",
"description" : "The sort by",
"required" : false,
"type" : "string"
}, {
"name" : "pageNumber",
"in" : "query",
"description" : "The page number",
"required" : false,
"type" : "integer",
"default" : -1,
"format" : "int32"
}, {
"name" : "pageSize",
"in" : "query",
"description" : "The page size",
"required" : false,
"type" : "integer",
"default" : -1,
"format" : "int32"
}, {
"name" : "locale",
"in" : "query",
"description" : "The locales",
"required" : false,
"type" : "array",
"items" : {
"type" : "string"
},
"collectionFormat" : "multi"
}, {
"name" : "highlight",
"in" : "query",
"description" : "The highlight",
"required" : false,
"type" : "string"
}, {
"name" : "outputFormat",
"in" : "query",
"description" : "The Output format",
"required" : false,
"type" : "string"
}, {
"name" : "enablePagination",
"in" : "query",
"description" : "The Enable Pagination",
"required" : false,
"type" : "boolean"
}, {
"name" : "tag",
"in" : "query",
"description" : "The tags",
"required" : false,
"type" : "array",
"items" : {
"type" : "string"
},
"collectionFormat" : "multi"
}, {
"name" : "knowledgeStates",
"in" : "query",
"description" : "The knowledge states",
"required" : false,
"type" : "array",
"items" : {
"type" : "string"
},
"collectionFormat" : "multi"
}, {
"name" : "contentTagsOperator",
"in" : "query",
"description" : "The content tags operator",
"required" : false,
"type" : "string"
}, {
"name" : "searchFilterId",
"in" : "query",
"description" : "The search filter id",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of aricles",
"schema" : {
"type" : "string"
}
}
}
}
},
"/rx/application/knowledge/vote" : {
"post" : {
"tags" : [ "KnowledgeResource for knowledge articles" ],
"summary" : "Updates the helpful or not helpful counts",
"description" : "Updates the helpful or not helpful counts",
"operationId" : "vote",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The article feedback",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ArticleFeedback"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of the helpful or not helpful counts"
}
}
}
},
"/rx/application/license/licenseusage/{licenseType}/{operation}" : {
"get" : {
"tags" : [ "LicenseUsageResource for managing license usages" ],
"summary" : "Gets the license usage",
"description" : "Retrieves the license usage",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "licenseType",
"in" : "path",
"description" : "CognitiveService",
"required" : true,
"type" : "string"
}, {
"name" : "operation",
"in" : "path",
"description" : "chat, classify, search",
"required" : true,
"type" : "string"
}, {
"name" : "countType",
"in" : "query",
"description" : "The count type string",
"required" : true,
"type" : "string"
}, {
"name" : "startDate",
"in" : "query",
"description" : "The start date string in UTC",
"required" : true,
"type" : "string"
}, {
"name" : "endDate",
"in" : "query",
"description" : "The end date string in UTC",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of license usage",
"schema" : {
"$ref" : "#/definitions/LicenseUsage"
}
}
}
}
},
"/rx/application/license/licenseusage/{licenseType}/{operation}/{bundleId}" : {
"get" : {
"tags" : [ "LicenseUsageResource for managing license usages" ],
"summary" : "Gets the License Usage by bundle id",
"description" : "Retrieves the License Usage by bundle id",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "licenseType",
"in" : "path",
"description" : "CognitiveService",
"required" : true,
"type" : "string"
}, {
"name" : "operation",
"in" : "path",
"description" : "chat, classify, search",
"required" : true,
"type" : "string"
}, {
"name" : "bundleId",
"in" : "path",
"description" : "The bundle Id",
"required" : true,
"type" : "string"
}, {
"name" : "countType",
"in" : "query",
"description" : "The count type string",
"required" : true,
"type" : "string"
}, {
"name" : "startDate",
"in" : "query",
"description" : "The start date string in UTC",
"required" : true,
"type" : "string"
}, {
"name" : "endDate",
"in" : "query",
"description" : "The end date string in UTC",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of License Usage",
"schema" : {
"$ref" : "#/definitions/LicenseUsage"
}
}
}
}
},
"/rx/application/licensemanagement/licenseReport/{tenantId}" : {
"get" : {
"tags" : [ "LicenseManagementResource for managing application licenses" ],
"summary" : "Gets the application report",
"description" : "Retrieves the application report provided tenant Id",
"operationId" : "getApplicationReport",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "tenantId",
"in" : "path",
"description" : "The tenant Id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of application report"
}
}
}
},
"/rx/application/licensemanagement/licenseReport/{tenantId}/{application}" : {
"get" : {
"tags" : [ "LicenseManagementResource for managing application licenses" ],
"summary" : "Gets the license management service report",
"description" : "Retrieves the license management service report provided application name and tenant id",
"operationId" : "getReport",
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "application",
"in" : "path",
"description" : "The application name",
"required" : true,
"type" : "string"
}, {
"name" : "tenantId",
"in" : "path",
"description" : "The tenant Id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of application report"
}
}
}
},
"/rx/application/licensemanagement/{application}" : {
"get" : {
"tags" : [ "LicenseManagementResource for managing application licenses" ],
"summary" : "Gets the Application License Descriptor",
"description" : "Retrieves the Application License Descriptor provided application name",
"operationId" : "getApplicationLicenseDescriptor",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "application",
"in" : "path",
"description" : "The application name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of Application License Descriptor",
"schema" : {
"$ref" : "#/definitions/ApplicationLicenseDescriptor"
}
}
}
}
},
"/rx/application/licensemanagement/{tenantID}/servicelicenses" : {
"get" : {
"tags" : [ "LicenseManagementResource for managing application licenses" ],
"summary" : "Get the list of service license descriptor.",
"description" : "Get the list of service license descriptor",
"operationId" : "getServiceLicenses",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "tenantID",
"in" : "path",
"description" : "The tenant ID",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful \"retrieval of service licenses",
"schema" : {
"type" : "array",
"items" : {
"type" : "object"
}
}
}
}
},
"put" : {
"tags" : [ "LicenseManagementResource for managing application licenses" ],
"summary" : "updates the list of service license descriptor.",
"description" : "updates the list of service license descriptor",
"operationId" : "updateServiceLicense",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "tenantID",
"in" : "path",
"description" : "The tenant ID",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The tenant service license descriptors",
"required" : true,
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ServiceLicenseDescriptor"
}
}
} ],
"responses" : {
"200" : {
"description" : "OK: Successful "
}
}
}
},
"/rx/application/licensemanagement/{tenantID}/servicelicenses/{licenseName}" : {
"put" : {
"tags" : [ "LicenseManagementResource for managing application licenses" ],
"summary" : "updates the service license descriptor.",
"description" : "updates the service license descriptor.",
"operationId" : "updateServiceLicense",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "tenantID",
"in" : "path",
"description" : "The tenant ID",
"required" : true,
"type" : "string"
}, {
"name" : "licenseName",
"in" : "path",
"description" : "The service license name",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The tenant service license descriptor",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ServiceLicenseDescriptor"
}
} ],
"responses" : {
"200" : {
"description" : "OK: Successful "
}
}
}
},
"/rx/application/licensemanagement/{tenantID}/{application}" : {
"get" : {
"tags" : [ "LicenseManagementResource for managing application licenses" ],
"summary" : "Gets the Application License Descriptor",
"description" : "Retrieves the Application License Descriptor provided application name and tenant Id",
"operationId" : "getApplicationLicenseDescriptor",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "application",
"in" : "path",
"description" : "The application name",
"required" : true,
"type" : "string"
}, {
"name" : "tenantID",
"in" : "path",
"description" : "The tenant id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of Application License Descriptor",
"schema" : {
"$ref" : "#/definitions/ApplicationLicenseDescriptor"
}
}
}
},
"put" : {
"tags" : [ "LicenseManagementResource for managing application licenses" ],
"summary" : "Updates the Application License Descriptor",
"description" : "Updates the Application License Descriptor",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "application",
"in" : "path",
"description" : "The application name",
"required" : true,
"type" : "string"
}, {
"name" : "tenantID",
"in" : "path",
"description" : "The tenant ID",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The tenant license descriptor",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ApplicationLicenseDescriptor"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of Application License Descriptor"
}
}
}
},
"/rx/application/licensemanagement/{tenantID}/{application}/{applicationUserLicense}" : {
"get" : {
"tags" : [ "LicenseManagementResource for managing application licenses" ],
"summary" : "Gets the Application License Descriptor",
"description" : "Retrieves the Application License Descriptor provided application name and tenant Id",
"operationId" : "getApplicationUserLicenseDescriptor",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "tenantID",
"in" : "path",
"description" : "The tenant id",
"required" : true,
"type" : "string"
}, {
"name" : "application",
"in" : "path",
"description" : "The application name",
"required" : true,
"type" : "string"
}, {
"name" : "applicationUserLicense",
"in" : "path",
"description" : "The application user license name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of Application License Descriptor",
"schema" : {
"$ref" : "#/definitions/ApplicationLicenseDescriptor"
}
}
}
},
"put" : {
"tags" : [ "LicenseManagementResource for managing application licenses" ],
"summary" : "Updates the Application License Descriptor",
"description" : "Updates the Application License Descriptor",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "tenantID",
"in" : "path",
"description" : "The tenant ID",
"required" : true,
"type" : "string"
}, {
"name" : "application",
"in" : "path",
"description" : "The application name",
"required" : true,
"type" : "string"
}, {
"name" : "applicationUserLicense",
"in" : "path",
"description" : "The application user license",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The tenant license descriptor",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ApplicationLicenseDescriptor"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of Application License Descriptor"
}
}
}
},
"/rx/application/localizedstrings" : {
"get" : {
"tags" : [ "LocalizedStringsResource for managing localized strings" ],
"summary" : "Gets all client side localized strings",
"description" : "Retrieves all client side localized strings",
"operationId" : "getAll",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "locale",
"in" : "query",
"description" : "The locale",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of client side localized strings",
"schema" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
}
}
}
},
"/rx/application/localizedstrings/rttcleanup/{bundleId}/{locale}" : {
"delete" : {
"tags" : [ "LocalizedStringsResource for managing localized strings" ],
"summary" : "Clean up RTT localized string from cache",
"description" : "Clean up RTT localized string cache provided bundle Id",
"operationId" : "cleanUpRttCache",
"parameters" : [ {
"name" : "bundleId",
"in" : "path",
"description" : "The bundle-id",
"required" : true,
"type" : "string"
}, {
"name" : "locale",
"in" : "path",
"description" : "The locale",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful clean up RTT cache"
}
}
}
},
"/rx/application/localizedstrings/{bundleId}" : {
"get" : {
"tags" : [ "LocalizedStringsResource for managing localized strings" ],
"summary" : "Gets the client side localized strings",
"description" : "Retrieves the client side localized strings provided bundle Id",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "bundleId",
"in" : "path",
"description" : "The bundle-id",
"required" : true,
"type" : "string"
}, {
"name" : "locale",
"in" : "query",
"description" : "The locale",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of client side localized strings",
"schema" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
}
}
},
"post" : {
"tags" : [ "LocalizedStringsResource for managing localized strings" ],
"summary" : "Gets client side localized strings for specified owner type.",
"description" : "Gets client side localized strings for specified owner type.",
"operationId" : "post",
"parameters" : [ {
"name" : "bundleId",
"in" : "path",
"description" : "The bundle-id",
"required" : true,
"type" : "string"
}, {
"name" : "locale",
"in" : "query",
"description" : "The locale",
"required" : true,
"type" : "string"
}, {
"name" : "ownerType",
"in" : "query",
"required" : false,
"type" : "string"
}, {
"name" : "deleteExtraStrings",
"in" : "query",
"description" : "Whether to delete extra strings",
"required" : true,
"type" : "boolean"
}, {
"in" : "body",
"name" : "body",
"description" : "The entries to be created/updated",
"required" : true,
"schema" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/rx/application/localizedstrings/{bundleId}/{key}/{locale}" : {
"delete" : {
"tags" : [ "LocalizedStringsResource for managing localized strings" ],
"summary" : "Deletes the localized string",
"description" : "Deletes the localized string provided bundle Id, key and locale",
"operationId" : "delete",
"parameters" : [ {
"name" : "bundleId",
"in" : "path",
"description" : "The bundle Id",
"required" : true,
"type" : "string"
}, {
"name" : "key",
"in" : "path",
"description" : "The key of the string",
"required" : true,
"type" : "string"
}, {
"name" : "locale",
"in" : "path",
"description" : "The locale",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion"
}
}
}
},
"/rx/application/logincontent/appicon.ico" : {
"get" : {
"tags" : [ "LoginContentResource for managing various login contents" ],
"summary" : "Gets the configured or default favicon content",
"description" : "Retrieves configured or default favicon content",
"operationId" : "getAppFavicon",
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of application favicon content"
}
}
}
},
"/rx/application/logincontent/favicon.ico" : {
"get" : {
"tags" : [ "LoginContentResource for managing various login contents" ],
"summary" : "Gets the loginFavicon content",
"description" : "Retrieves the loginFavicon content",
"operationId" : "getLoginFavicon",
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of loginFavicon content"
}
},
"deprecated" : true
},
"put" : {
"tags" : [ "LoginContentResource for managing various login contents" ],
"summary" : "Updates the LoginFavicon",
"description" : "Updates the LoginFavicon provided form data multi part",
"operationId" : "putLoginFavicon",
"consumes" : [ "multipart/form-data" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The form data multipart",
"required" : true,
"schema" : {
"$ref" : "#/definitions/FormDataMultiPart"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of LoginFavicon"
}
}
}
},
"/rx/application/logincontent/login.css" : {
"get" : {
"tags" : [ "LoginContentResource for managing various login contents" ],
"summary" : "Gets the loginCss content",
"description" : "Retrieves the loginCss content",
"operationId" : "getLoginCss",
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of loginCss content"
}
}
},
"put" : {
"tags" : [ "LoginContentResource for managing various login contents" ],
"summary" : "Updates the loginCss",
"description" : "Updates the loginCss provided form data multipart",
"operationId" : "putLoginCss",
"consumes" : [ "multipart/form-data" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The form data multipart",
"required" : true,
"schema" : {
"$ref" : "#/definitions/FormDataMultiPart"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of loginCss "
}
}
}
},
"/rx/application/logincontent/login.json" : {
"get" : {
"tags" : [ "LoginContentResource for managing various login contents" ],
"summary" : "Gets the json response",
"description" : "Retrieves the json response",
"operationId" : "getJsonResponse",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of json response"
}
}
}
},
"/rx/application/logincontent/login.json/jsonp" : {
"get" : {
"tags" : [ "LoginContentResource for managing various login contents" ],
"summary" : "Gets the jsonp response",
"description" : "Retrieves the jsonp response",
"operationId" : "getJsonpResponse",
"produces" : [ "application/javascript", "application/x-javascript" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of jsonp response",
"schema" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
}
},
"deprecated" : true
}
},
"/rx/application/namedlist/namedlistdefinition" : {
"post" : {
"tags" : [ "NamedListDefinitionResource for managing named list definitions" ],
"summary" : "Creates the named list",
"description" : "Creates the named list provided named list definition specifications",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The named list definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/NamedListDefinition"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of named list definition."
}
}
}
},
"/rx/application/namedlist/namedlistdefinition/{name}" : {
"get" : {
"tags" : [ "NamedListDefinitionResource for managing named list definitions" ],
"summary" : "Gets the NamedList",
"description" : "Retrieves the NamedList provides name of the NamedList name",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name of NamedList",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of NamedList",
"schema" : {
"$ref" : "#/definitions/NamedListDefinition"
}
}
}
},
"put" : {
"tags" : [ "NamedListDefinitionResource for managing named list definitions" ],
"summary" : "Updates the NamedList",
"description" : "Updates the NamedList provided name and named list definition specifications",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name of NamedList",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The named list definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/NamedListDefinition"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of NamedList"
}
}
},
"delete" : {
"tags" : [ "NamedListDefinitionResource for managing named list definitions" ],
"summary" : "Deletes the NamedList",
"description" : "Deletes the NamedList provided the name",
"operationId" : "delete",
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name of NamedList",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of NamedList"
}
}
}
},
"/rx/application/oauth/accesstoken/{configName}" : {
"get" : {
"tags" : [ "OAuthResource for managing auth tokens for configurations" ],
"summary" : "Gets the access token for given configuration name",
"description" : "Retrieves the access token for given configuration name provided the configuration name",
"operationId" : "getAccessToken",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "configName",
"in" : "path",
"description" : "The configuration name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of access token for given configuration name"
}
}
}
},
"/rx/application/oauth/callback" : {
"get" : {
"tags" : [ "OAuthResource for managing auth tokens for configurations" ],
"summary" : "Gets the callback response",
"description" : "Retrieves the callback response provided auth code and state",
"operationId" : "getCallbackResponse",
"produces" : [ "text/html" ],
"parameters" : [ {
"name" : "code",
"in" : "query",
"description" : "The code",
"required" : true,
"type" : "string"
}, {
"name" : "state",
"in" : "query",
"description" : "The state",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of callback response"
}
}
}
},
"/rx/application/oauth/token/{configName}" : {
"get" : {
"tags" : [ "OAuthResource for managing auth tokens for configurations" ],
"summary" : "Gets the auth url for given configuration name",
"description" : "Retrieves the auth url for given configuration name provided the configuration name",
"operationId" : "getOAuthToken",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "configName",
"in" : "path",
"description" : "The configuration name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of auth url for given configuration name"
}
}
}
},
"/rx/application/pii/jobs" : {
"get" : {
"tags" : [ "PiiResource for managing GDPR operations" ],
"summary" : "Gets the GDPR Search operation",
"description" : "Retrieves theGDPR Search operation",
"operationId" : "searchAllJobs",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "startIndex",
"in" : "query",
"description" : "The start index",
"required" : true,
"type" : "integer",
"format" : "int32"
}, {
"name" : "pageSize",
"in" : "query",
"description" : "The pagesize",
"required" : true,
"type" : "integer",
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of GDPR Search operation"
}
}
}
},
"/rx/application/pii/jobs/forget" : {
"post" : {
"tags" : [ "PiiResource for managing GDPR operations" ],
"summary" : "Creates the GDPR forget 2-step operation. First operation is search, next forget",
"description" : "",
"operationId" : "searchAndForget",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The pii job info",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PiiJobInfo"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation"
}
}
}
},
"/rx/application/pii/jobs/search" : {
"post" : {
"tags" : [ "PiiResource for managing GDPR operations" ],
"summary" : "Posts a GDPR Search operation",
"description" : "Posts a GDPR Search operation provided piiJobInfo",
"operationId" : "search",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The pii job info containing details for search operation",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PiiJobInfo"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/rx/application/pii/jobs/{jobId}" : {
"get" : {
"tags" : [ "PiiResource for managing GDPR operations" ],
"summary" : "Gets the GDPR Search operation",
"description" : "Retrieves the GDPR Search operation provided job Id",
"operationId" : "searchJobById",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobId",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of GDPR Search operation"
}
}
},
"post" : {
"tags" : [ "PiiResource for managing GDPR operations" ],
"summary" : "Gets a GDPR forget job. Updates the approve forget flag to true when anonymize is called.",
"description" : "",
"operationId" : "searchByJobIdAndForget",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobId",
"in" : "path",
"description" : "The job id",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The PiiJobOperationAction",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PiiJobOperationAction"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/rx/application/pii/jobs/{jobId}/searchRecords" : {
"get" : {
"tags" : [ "PiiResource for managing GDPR operations" ],
"summary" : "GDPR Search operation for records by job id",
"description" : "GDPR Search operation for records by job id provided start index and page size",
"operationId" : "searchRecordsByJobId",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobId",
"in" : "path",
"description" : "The pii job id",
"required" : true,
"type" : "string"
}, {
"name" : "startIndex",
"in" : "query",
"description" : "The start index",
"required" : true,
"type" : "integer",
"format" : "int32"
}, {
"name" : "pageSize",
"in" : "query",
"description" : "The pagesize",
"required" : true,
"type" : "integer",
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of GDPR Search operation for records by job id"
}
}
}
},
"/rx/application/pii/jobs/{jobId}/searchRecords/ignore" : {
"post" : {
"tags" : [ "PiiResource for managing GDPR operations" ],
"summary" : "Sets ignore flag for GDPR Search result record",
"description" : "Sets ignore flag for GDPR Search result record provided job id and pii ignore record info",
"operationId" : "updateIgnoreFlag",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobId",
"in" : "path",
"description" : "The pii job id",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The pii ignore record info",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PiiIgnoreRecordInfo"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/rx/application/pii/jobs/{jobId}/searchRecords/{searchRecordId}" : {
"get" : {
"tags" : [ "PiiResource for managing GDPR operations" ],
"summary" : "GDPR Search operation for records by job id and record id",
"description" : "GDPR Search operation for records by job id and record id",
"operationId" : "searchRecordsByJobIdAndRecordId",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobId",
"in" : "path",
"description" : "The pii job id",
"required" : true,
"type" : "string"
}, {
"name" : "searchRecordId",
"in" : "path",
"description" : "The search record id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of GDPR Search operation for records by job id and record id"
}
}
}
},
"/rx/application/pinrequest/verifypin" : {
"post" : {
"tags" : [ "PinResource for managing pin services" ],
"summary" : "Verifies the pin",
"description" : "Verifies the pin for given pin request",
"operationId" : "verifyPin",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The pin request",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PinRequest"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/rx/application/process/processdefinition" : {
"post" : {
"tags" : [ "ProcessDefinitionResource for managing process definitions" ],
"summary" : "Creates a new ProcessDefinition",
"description" : "See the documentation for the service method ProcessService.createProcessDefinition for additional details.",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The ProcesDefinition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ProcessDefinition"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of ProcessDefinition"
}
}
}
},
"/rx/application/process/processdefinition/{processName}" : {
"get" : {
"tags" : [ "ProcessDefinitionResource for managing process definitions" ],
"summary" : "Gets the ProcessDefinition",
"description" : "See the documentation for the service method ProcessService.getProcessDefinition for additional details.",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "processName",
"in" : "path",
"description" : "The process name",
"required" : true,
"type" : "string"
}, {
"name" : "processDefinitionVersion",
"in" : "query",
"description" : "The process definition version",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of ProcessDefinition",
"schema" : {
"$ref" : "#/definitions/ProcessDefinition"
}
}
}
},
"put" : {
"tags" : [ "ProcessDefinitionResource for managing process definitions" ],
"summary" : "Updates the ProcessDefinition",
"description" : "See the documentation for the service method ProcessService.updateProcessDefinition for additional details.",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "processName",
"in" : "path",
"description" : "The Process Name",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The ProcessDefinition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ProcessDefinition"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of ProcessDefinition"
},
"400" : {
"description" : "BAD REQUEST: Process Name is blank or if the ProcessDefinition is not found"
}
}
},
"delete" : {
"tags" : [ "ProcessDefinitionResource for managing process definitions" ],
"summary" : "Deletes the Process Definition",
"description" : "See the documentation for the service method ProcessService.deleteProcessDefinition for additional details.",
"operationId" : "delete",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "processName",
"in" : "path",
"description" : "The process name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of process definition"
}
}
}
},
"/rx/application/process/processdefinition/{processName}/inputParams" : {
"get" : {
"tags" : [ "ProcessDefinitionResource for managing process definitions" ],
"summary" : "Gets the input parameters of a Process",
"description" : "See the documentation for the service method ProcessService.getProcessParameters for additional details.",
"operationId" : "getInputParams",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "processName",
"in" : "path",
"description" : "The process name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of input parameters of a Process"
}
}
}
},
"/rx/application/process/processdefinition/{processName}/outputParams" : {
"get" : {
"tags" : [ "ProcessDefinitionResource for managing process definitions" ],
"summary" : "Gets the output parameters of a Process",
"description" : "See the documentation for the service method ProcessService.getProcessParameters for additional details.",
"operationId" : "getOutputParams",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "processName",
"in" : "path",
"description" : "The process name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of output parameters of a Process"
}
}
}
},
"/rx/application/process/processinstance/attachment/{processDefinitionName}/{processInstanceId}/{paramterId}" : {
"get" : {
"tags" : [ "ProcessInstanceResource for managing process instances" ],
"summary" : "Gets the process instance parameter attachment",
"description" : "Retrieves the process instance parameter attachment provided process name, process instance id and parameter id",
"operationId" : "get",
"produces" : [ "application/octet-stream" ],
"parameters" : [ {
"name" : "processDefinitionName",
"in" : "path",
"description" : "The process definition name",
"required" : true,
"type" : "string"
}, {
"name" : "processInstanceId",
"in" : "path",
"description" : "The process instance Id",
"required" : true,
"type" : "string"
}, {
"name" : "paramterId",
"in" : "path",
"description" : "The parameter Id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of process instance parameter attachment"
}
}
}
},
"/rx/application/process/processinstance/attachment/{processDefinitionName}/{processInstanceId}/{paramterId}/{index}" : {
"get" : {
"tags" : [ "ProcessInstanceResource for managing process instances" ],
"summary" : "Gets the process instance parameter attachment via index",
"description" : "Retrieves the process instance parameter attachment provided process name, process instance id,parameter id and index. This is generally used to fetch attachment for list of attachment type of variable.",
"operationId" : "getAttachmentByIndex",
"produces" : [ "application/octet-stream" ],
"parameters" : [ {
"name" : "processDefinitionName",
"in" : "path",
"description" : "The process definition name",
"required" : true,
"type" : "string"
}, {
"name" : "processInstanceId",
"in" : "path",
"description" : "The process instance Id",
"required" : true,
"type" : "string"
}, {
"name" : "paramterId",
"in" : "path",
"description" : "The parameter Id",
"required" : true,
"type" : "string"
}, {
"name" : "index",
"in" : "path",
"description" : "The index",
"required" : true,
"type" : "integer",
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of process instance parameter attachment"
}
}
}
},
"/rx/application/process/processinstance/log/{processDefinitionName}/{processInstanceId}/download" : {
"get" : {
"tags" : [ "ProcessInstanceResource for managing process instances" ],
"summary" : "Gets the process instance log",
"description" : "Retrieves the process instance log provided process name, process instance id.",
"operationId" : "getLogAttachment",
"produces" : [ "application/octet-stream" ],
"parameters" : [ {
"name" : "processDefinitionName",
"in" : "path",
"description" : "The process definition name",
"required" : true,
"type" : "string"
}, {
"name" : "processInstanceId",
"in" : "path",
"description" : "The process instance Id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of process instance log"
}
}
}
},
"/rx/application/process/processinstance/log/{processDefinitionName}/{processInstanceId}/view" : {
"get" : {
"tags" : [ "ProcessInstanceResource for managing process instances" ],
"summary" : "Gets the process instance log to view",
"description" : "Retrieves the process instance log provided process name, process instance id.",
"operationId" : "getLogView",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "processDefinitionName",
"in" : "path",
"description" : "The process definition name",
"required" : true,
"type" : "string"
}, {
"name" : "processInstanceId",
"in" : "path",
"description" : "The process instance Id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of process instance log",
"schema" : {
"$ref" : "#/definitions/ProcessInstanceLog"
}
}
}
}
},
"/rx/application/process/processinstance/{processDefinitionName}/{processInstanceId}" : {
"get" : {
"tags" : [ "ProcessInstanceResource for managing process instances" ],
"summary" : "Gets the process instance",
"description" : "See the documentation for the service method ProcessService.getProcessInstance for additional details.",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "processDefinitionName",
"in" : "path",
"description" : "The process definition name",
"required" : true,
"type" : "string"
}, {
"name" : "processInstanceId",
"in" : "path",
"description" : "The process instance Id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of process instance",
"schema" : {
"$ref" : "#/definitions/ProcessInstance"
}
}
}
}
},
"/rx/application/process/processinstance/{processDefinitionName}/{processInstanceId}/processOutputVariables" : {
"get" : {
"tags" : [ "ProcessInstanceResource for managing process instances" ],
"summary" : "Gets the process output",
"description" : "Retrieves the process output provided process name and process instance id",
"operationId" : "getProcessOutput",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "processDefinitionName",
"in" : "path",
"description" : "The process definition name",
"required" : true,
"type" : "string"
}, {
"name" : "processInstanceId",
"in" : "path",
"description" : "The process instance Id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of process output",
"schema" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
}
}
}
},
"/rx/application/record/attachment/{recordDefinitionName}/{recordInstanceId}" : {
"post" : {
"tags" : [ "AttachmentResource for managing attachemnts" ],
"summary" : "Updates attachment for record definition",
"description" : "Updates attachment for given record definition and record instance id",
"operationId" : "post",
"consumes" : [ "multipart/form-data" ],
"parameters" : [ {
"name" : "recordDefinitionName",
"in" : "path",
"description" : "The record definition name",
"required" : true,
"type" : "string"
}, {
"name" : "recordInstanceId",
"in" : "path",
"description" : "The record instance id",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The form data multi part",
"required" : true,
"schema" : {
"$ref" : "#/definitions/FormDataMultiPart"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/rx/application/record/attachment/{recordDefinitionName}/{recordInstanceId}/{attachmentFieldId}" : {
"get" : {
"tags" : [ "AttachmentResource for managing attachemnts" ],
"summary" : "Gets the attachment",
"description" : "Retrieves the attachment provided attachmentFieldId and Record details",
"operationId" : "get",
"produces" : [ "application/octet-stream" ],
"parameters" : [ {
"name" : "recordDefinitionName",
"in" : "path",
"description" : "The record definition name",
"required" : true,
"type" : "string"
}, {
"name" : "recordInstanceId",
"in" : "path",
"description" : "The record instance id",
"required" : true,
"type" : "string"
}, {
"name" : "attachmentFieldId",
"in" : "path",
"description" : "The attachment field id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval"
},
"404" : {
"description" : "NOT FOUND: No attachment available for specified details."
}
}
},
"delete" : {
"tags" : [ "AttachmentResource for managing attachemnts" ],
"summary" : "Deletes an attachment",
"description" : "Delete an attachment provided attachmentFieldId and Record details",
"operationId" : "delete",
"parameters" : [ {
"name" : "recordDefinitionName",
"in" : "path",
"description" : "The record definition name",
"required" : true,
"type" : "string"
}, {
"name" : "recordInstanceId",
"in" : "path",
"description" : "The record instance id",
"required" : true,
"type" : "string"
}, {
"name" : "attachmentFieldId",
"in" : "path",
"description" : "The attachment field id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion"
}
}
}
},
"/rx/application/record/recorddefinition" : {
"post" : {
"tags" : [ "RecordDefinitionResource for managing record definitions" ],
"summary" : "Creates a RecordDefinition.",
"description" : "Creates a RecordDefinition asynchronously.",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The RecordDefinition.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/RecordDefinition"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of RecordDefinition"
}
}
}
},
"/rx/application/record/recorddefinition/convertfieldtype/{name}/{fieldId}/{newStorageType}" : {
"put" : {
"tags" : [ "RecordDefinitionResource for managing record definitions" ],
"summary" : "Updates record definition with converted field type",
"description" : "Updates record definition asynchronously with new storage type",
"operationId" : "convertfieldtype",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "the name of record",
"required" : true,
"type" : "string"
}, {
"name" : "fieldId",
"in" : "path",
"description" : "the field id",
"required" : true,
"type" : "integer",
"format" : "int32"
}, {
"name" : "newStorageType",
"in" : "path",
"description" : "the new storage type",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/rx/application/record/recorddefinition/{name}" : {
"get" : {
"tags" : [ "RecordDefinitionResource for managing record definitions" ],
"summary" : "Retrieve a record definition",
"description" : "Gets a record definition from record name and the copyfrom query",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name of the RecordDefinition",
"required" : true,
"type" : "string"
}, {
"name" : "copyFrom",
"in" : "query",
"description" : "The copyFrom",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of record definition",
"schema" : {
"$ref" : "#/definitions/RecordDefinition"
}
}
}
},
"put" : {
"tags" : [ "RecordDefinitionResource for managing record definitions" ],
"summary" : "Updates a RecordDefinition",
"description" : "Update record definition asynchronously",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name of the RecordDefinition",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The RecordDefinition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/RecordDefinition"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of record definition"
}
}
}
},
"/rx/application/record/recorddefinition/{recordDefinitionName}" : {
"delete" : {
"tags" : [ "RecordDefinitionResource for managing record definitions" ],
"summary" : "Deletes a RecordDefinition",
"description" : "Deletes a RecordDefinition by name",
"operationId" : "delete",
"parameters" : [ {
"name" : "recordDefinitionName",
"in" : "path",
"description" : "The name of the RecordDefinition",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion"
}
}
}
},
"/rx/application/record/recordinstance" : {
"post" : {
"tags" : [ "RecordInstanceResource for managing record instances" ],
"summary" : "Creates a RecordInstance",
"description" : "See the documentation for the service method RecordService.createRecordInstance for additional details.",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The RecordInstance",
"required" : true,
"schema" : {
"$ref" : "#/definitions/RecordInstance"
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/RecordInstance"
}
},
"201" : {
"description" : "CREATED: Successful creation of regular record instance"
},
"204" : {
"description" : "NO CONTENT: Successful creation of join record instance"
}
}
}
},
"/rx/application/record/recordinstance/export" : {
"get" : {
"tags" : [ "RecordInstanceResource for managing record instances" ],
"summary" : "DataPageQuery for exporting record instances.",
"description" : "Returns DataPage",
"operationId" : "export",
"produces" : [ "application/octet-stream" ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/DataPage"
}
}
}
}
},
"/rx/application/record/recordinstance/import" : {
"post" : {
"tags" : [ "RecordInstanceResource for managing record instances" ],
"summary" : "Import of record instances with localized text contents.",
"description" : "",
"operationId" : "importFile",
"consumes" : [ "multipart/form-data" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The form data multi part",
"required" : true,
"schema" : {
"$ref" : "#/definitions/FormDataMultiPart"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful import"
}
}
}
},
"/rx/application/record/recordinstance/{recordDefinitionName}/{recordInstanceId}" : {
"get" : {
"tags" : [ "RecordInstanceResource for managing record instances" ],
"summary" : "Gets a RecordInstance",
"description" : "Retrieves a record instance provided record definition name and record instance Id",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "recordDefinitionName",
"in" : "path",
"description" : "The RecordDefinition name the RecordInstance is based on",
"required" : true,
"type" : "string"
}, {
"name" : "recordInstanceId",
"in" : "path",
"description" : "The ID of the RecordInstance",
"required" : true,
"type" : "string",
"pattern" : ".+"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful recordInstance retrieval",
"schema" : {
"$ref" : "#/definitions/RecordInstance"
}
}
}
},
"put" : {
"tags" : [ "RecordInstanceResource for managing record instances" ],
"summary" : "Updates record instance with given details",
"description" : "Updates the given RecordDefinition for provided record instance id and multipart form data",
"operationId" : "put",
"consumes" : [ "multipart/form-data" ],
"parameters" : [ {
"name" : "recordDefinitionName",
"in" : "path",
"description" : "The RecordDefinition name",
"required" : true,
"type" : "string"
}, {
"name" : "recordInstanceId",
"in" : "path",
"description" : "The record instance id",
"required" : true,
"type" : "string",
"pattern" : ".+"
}, {
"in" : "body",
"name" : "body",
"description" : "The form data multi part",
"required" : true,
"schema" : {
"$ref" : "#/definitions/FormDataMultiPart"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"delete" : {
"tags" : [ "RecordInstanceResource for managing record instances" ],
"summary" : "Deletes a record instance",
"description" : "See the documentation for the service method RecordService.deleteRecordInstance for additional details.",
"operationId" : "delete",
"parameters" : [ {
"name" : "recordDefinitionName",
"in" : "path",
"description" : "The name of the RecordDefinition",
"required" : true,
"type" : "string"
}, {
"name" : "recordInstanceId",
"in" : "path",
"description" : "The ID of the RecordInstance",
"required" : true,
"type" : "string",
"pattern" : ".+"
} ],
"responses" : {
"200" : {
"description" : "OK: The delete operation is successful"
}
}
}
},
"/rx/application/remoteserver" : {
"get" : {
"tags" : [ "RemoteServerResource for managing remote servers" ],
"summary" : "Gets the remote servers",
"description" : "Retrieves the remote servers",
"operationId" : "get",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of remote servers",
"schema" : {
"$ref" : "#/definitions/RemoteServer"
}
}
}
},
"post" : {
"tags" : [ "RemoteServerResource for managing remote servers" ],
"summary" : "Gets remoting server descriptor",
"description" : "Gets remoting server descriptor",
"operationId" : "post",
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The remote server",
"required" : true,
"schema" : {
"$ref" : "#/definitions/RemoteServer"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation"
}
}
}
},
"/rx/application/remoteserver/{remoteServerId}" : {
"put" : {
"tags" : [ "RemoteServerResource for managing remote servers" ],
"summary" : "Updates/reloads the remote connectors",
"description" : "Updates/reloads the remote connectors provided remote server and it's id",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "remoteServerId",
"in" : "path",
"description" : "The remote server id",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The remote server",
"required" : true,
"schema" : {
"$ref" : "#/definitions/RemoteServer"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of remote connectors"
}
}
},
"delete" : {
"tags" : [ "RemoteServerResource for managing remote servers" ],
"summary" : "Unregisters the remote server",
"description" : "Unregisters the remote server provided remote server id.",
"operationId" : "delete",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "remoteServerId",
"in" : "path",
"description" : "The remote server id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion"
}
}
}
},
"/rx/application/remoteserver/{remoteServerId}/connectors" : {
"get" : {
"tags" : [ "RemoteServerResource for managing remote servers" ],
"summary" : "Gets the remote servers connectors",
"description" : "Retrieves the remote servers connectors provided remote server id",
"operationId" : "getConnectors",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "remoteServerId",
"in" : "path",
"description" : "The remote server id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of remote servers connectors",
"schema" : {
"$ref" : "#/definitions/ConnectorDescriptor"
}
}
}
}
},
"/rx/application/role" : {
"post" : {
"tags" : [ "RoleResource for managing role definitions" ],
"summary" : "Creates the given role",
"description" : "Creates the given role",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The role",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Role"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of given role"
}
}
}
},
"/rx/application/role/users/{applicationName}/{roleName}" : {
"get" : {
"tags" : [ "RoleResource for managing role definitions" ],
"summary" : "Gets the users",
"description" : "Retrieves the users by role provided application name and role name",
"operationId" : "getUsers",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "applicationName",
"in" : "path",
"description" : "The application name",
"required" : true,
"type" : "string"
}, {
"name" : "roleName",
"in" : "path",
"description" : "The role name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of list of users",
"schema" : {
"type" : "array",
"items" : {
"type" : "array",
"items" : {
"type" : "object"
}
}
}
}
}
}
},
"/rx/application/role/{applicationName}/{roleName}" : {
"get" : {
"tags" : [ "RoleResource for managing role definitions" ],
"summary" : "Gets the requested role",
"description" : "Retrieves the requested role provided application name and role name",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "applicationName",
"in" : "path",
"description" : "The application name",
"required" : true,
"type" : "string"
}, {
"name" : "roleName",
"in" : "path",
"description" : "The role name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of requested role",
"schema" : {
"$ref" : "#/definitions/Role"
}
}
}
},
"put" : {
"tags" : [ "RoleResource for managing role definitions" ],
"summary" : "Updates the given role",
"description" : "Updates the given role provided application name, role and it's name",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "applicationName",
"in" : "path",
"description" : "The application name",
"required" : true,
"type" : "string"
}, {
"name" : "roleName",
"in" : "path",
"description" : "The role name",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The role",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Role"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of given role"
}
}
},
"delete" : {
"tags" : [ "RoleResource for managing role definitions" ],
"summary" : "Deletes the given role",
"description" : "Deletes the given role provides application name and role name",
"operationId" : "delete",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "applicationName",
"in" : "path",
"description" : "The application name",
"required" : true,
"type" : "string"
}, {
"name" : "roleName",
"in" : "path",
"description" : "The role name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of given role"
}
}
}
},
"/rx/application/rule/ruledefinition" : {
"post" : {
"tags" : [ "RuleDefinitionResource for managing rule definitions" ],
"summary" : "Creates the rule definition",
"description" : "Creates the rule definition",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The rule definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/RuleDefinition"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of rule definition"
}
}
}
},
"/rx/application/rule/ruledefinition/{name}" : {
"get" : {
"tags" : [ "RuleDefinitionResource for managing rule definitions" ],
"summary" : "Gets the rule definition",
"description" : "Retrieves the rule definition",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The rule name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of rule definition",
"schema" : {
"$ref" : "#/definitions/RuleDefinition"
}
}
}
},
"put" : {
"tags" : [ "RuleDefinitionResource for managing rule definitions" ],
"summary" : "Updates the rule definition",
"description" : "Updates the rule definition",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name of rule definition",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The rule definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/RuleDefinition"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation rule definition"
}
}
},
"delete" : {
"tags" : [ "RuleDefinitionResource for managing rule definitions" ],
"summary" : "Deletes the rule definition",
"description" : "Deletes the rule definition provided rule name",
"operationId" : "delete",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The rule definition name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of rule definition"
}
}
}
},
"/rx/application/skype/ucwa/{action}/{chatbotConfigurationId}" : {
"post" : {
"tags" : [ "UCWAChatResource for managing UCWA skype chat resources" ],
"summary" : "Register/UnRegister Chat Application for configuration",
"description" : "Register/UnRegister Chat Application for configuration",
"operationId" : "post",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "action",
"in" : "path",
"description" : "The register value as register/unregister",
"required" : true,
"type" : "string"
}, {
"name" : "chatbotConfigurationId",
"in" : "path",
"description" : "The chatbot config id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/UCWAChatApplicationDetail"
}
}
}
}
},
"/rx/application/skype/ucwa/{status}/{chatbotConfigurationId}" : {
"get" : {
"tags" : [ "UCWAChatResource for managing UCWA skype chat resources" ],
"summary" : "Gets the status for chat application for given configuration",
"description" : "Retrieves the Status for Chat Application for given configuration",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "status",
"in" : "path",
"description" : "The register value as status",
"required" : true,
"type" : "string"
}, {
"name" : "chatbotConfigurationId",
"in" : "path",
"description" : "The chatbot config id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of status for chat application for given configuration",
"schema" : {
"$ref" : "#/definitions/UCWAChatApplicationDetail"
}
}
}
}
},
"/rx/application/smartreporting/url" : {
"get" : {
"tags" : [ "SmartReportingUrlResource for managing smart reporting url service" ],
"summary" : "Gets the smart reporting url",
"description" : "Retrieves the smart reporting url",
"operationId" : "get",
"produces" : [ "text/plain" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of smart reporting url",
"schema" : {
"type" : "string"
}
}
}
}
},
"/rx/application/systemconfiguration/cumulative/{name}" : {
"get" : {
"tags" : [ "SystemConfigurationResource for managing system configurations" ],
"summary" : "Gets the system configuration value",
"description" : "Gets the system configuration value provided name of the configuration",
"operationId" : "getCumulativeConfiguration",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of system configuration value",
"schema" : {
"$ref" : "#/definitions/SystemConfigurationOption"
}
}
}
},
"post" : {
"tags" : [ "SystemConfigurationResource for managing system configurations" ],
"summary" : "set the system configuration",
"description" : "set the system configuration provided configuration and name",
"operationId" : "setCumulativeConfiguration",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The configuration",
"required" : true,
"schema" : {
"$ref" : "#/definitions/SystemConfiguration"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of system configuration"
}
}
},
"put" : {
"tags" : [ "SystemConfigurationResource for managing system configurations" ],
"summary" : "Updates the system configuration",
"description" : "Updates the system configuration provided configuration and name",
"operationId" : "updateCumulativeConfiguration",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The configuration",
"required" : true,
"schema" : {
"$ref" : "#/definitions/SystemConfiguration"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of system configuration"
}
}
}
},
"/rx/application/systemconfiguration/logging/application" : {
"put" : {
"tags" : [ "SystemConfigurationResource for managing system configurations" ],
"summary" : "Update the Log Level for an Application",
"description" : "Update the Log Level for an Application",
"operationId" : "updateApplicationLogSettings",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The ApplicationLogSetting",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ApplicationLogSetting"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of Application Log Level"
}
}
}
},
"/rx/application/systemconfiguration/logging/server" : {
"get" : {
"tags" : [ "SystemConfigurationResource for managing system configurations" ],
"summary" : "Gets server log settings",
"description" : "Retrieves system configuration for enabled/disabled server logs",
"operationId" : "get",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval",
"schema" : {
"$ref" : "#/definitions/ServerLogSetting"
}
}
}
},
"post" : {
"tags" : [ "SystemConfigurationResource for managing system configurations" ],
"summary" : "Turns the server log on for given Log types.",
"description" : "Turns the server log on for given Log types",
"operationId" : "updateServerLogSettings",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The server log configuration",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ServerLogSetting"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful Turns the server log on for given Log types."
}
}
}
},
"/rx/application/systemconfiguration/logging/server/download" : {
"post" : {
"tags" : [ "SystemConfigurationResource for managing system configurations" ],
"summary" : "Download server logs",
"description" : "Download server logs",
"operationId" : "getLogs",
"consumes" : [ "application/json" ],
"produces" : [ "application/octet-stream" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "Names of files to download",
"required" : true,
"schema" : {
"$ref" : "#/definitions/LogFiles"
}
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval",
"schema" : {
"$ref" : "#/definitions/ByteArrayOutputStream"
}
}
}
}
},
"/rx/application/systemconfiguration/options" : {
"get" : {
"tags" : [ "SystemConfigurationResource for managing system configurations" ],
"summary" : "Gets the available options that can be get/set",
"description" : "Retrieves the available options that can be get/set provided component name, type and configuration",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "componentname",
"in" : "query",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"name" : "componenttype",
"in" : "query",
"description" : "The component type",
"required" : true,
"type" : "string"
}, {
"name" : "configuration",
"in" : "query",
"description" : "The configuration",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of available options that can be get/set",
"schema" : {
"$ref" : "#/definitions/SystemConfigurationOption"
}
}
}
}
},
"/rx/application/systemconfiguration/options/{name}" : {
"get" : {
"tags" : [ "SystemConfigurationResource for managing system configurations" ],
"summary" : "Gets system configuration option",
"description" : "Retrieves system configuration option provided name, component name, type and configuration",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name",
"required" : true,
"type" : "string"
}, {
"name" : "componentname",
"in" : "query",
"description" : "The component name",
"required" : true,
"type" : "string"
}, {
"name" : "componenttype",
"in" : "query",
"description" : "The component type",
"required" : true,
"type" : "string"
}, {
"name" : "configuration",
"in" : "query",
"description" : "The configuration",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval",
"schema" : {
"$ref" : "#/definitions/SystemConfigurationOption"
}
}
}
}
},
"/rx/application/systemconfiguration/query" : {
"get" : {
"tags" : [ "SystemConfigurationResource for managing system configurations" ],
"summary" : "Gets the Configuration value of provided settings",
"description" : "Gets the Configuration value of provided settings for given identifiers ids or tags",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "identifier",
"in" : "query",
"description" : "The name or ids",
"required" : true,
"type" : "array",
"items" : {
"type" : "string"
},
"collectionFormat" : "multi"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of value of provided configuration setting",
"schema" : {
"$ref" : "#/definitions/SystemConfiguration"
}
}
}
}
},
"/rx/application/systemconfiguration/rulepool/numberofavailablepools" : {
"get" : {
"tags" : [ "SystemConfigurationResource for managing system configurations" ],
"summary" : "Get the number of available rule pools.",
"description" : "Retrieves the number of available rule pools from Escalation owning server",
"operationId" : "getNumberOfAvailablePools",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval the number of available rule pools"
}
}
}
},
"/rx/application/systemconfiguration/{name}" : {
"get" : {
"tags" : [ "SystemConfigurationResource for managing system configurations" ],
"summary" : "Gets the system configuration value",
"description" : "Gets the system configuration value provided name of the configuration",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of system configuration value",
"schema" : {
"$ref" : "#/definitions/SystemConfigurationOption"
}
}
}
},
"post" : {
"tags" : [ "SystemConfigurationResource for managing system configurations" ],
"summary" : "Updates the system configuration",
"description" : "Same behavior as Put but just saves the callers from doing a GET and then PUT when using restangular",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The configuration",
"required" : true,
"schema" : {
"$ref" : "#/definitions/SystemConfiguration"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of system configuration"
}
}
},
"put" : {
"tags" : [ "SystemConfigurationResource for managing system configurations" ],
"summary" : "Updates the system configuration",
"description" : "Updates the system configuration provided configuration and name",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The configuration",
"required" : true,
"schema" : {
"$ref" : "#/definitions/SystemConfiguration"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of system configuration"
}
}
}
},
"/rx/application/telemetry/configuration/{bundleId}" : {
"get" : {
"tags" : [ "Gainsight resource for managing Gainsight telemetry configuration and user preferences" ],
"summary" : "Gets Gainsight telemetry configuration for the given bundle",
"description" : "",
"operationId" : "getConfiguration",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "bundleId",
"in" : "path",
"description" : "Bundle ID",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of Gainsight telemetry configuration for given bundle"
}
}
}
},
"/rx/application/telemetry/notification/config" : {
"get" : {
"tags" : [ "The resource class for CRU operations on notification config details" ],
"summary" : "Gets the notification configuration details",
"description" : "Fetch notification configuration details for given domain and action",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "domain",
"in" : "query",
"description" : "The namespace under which action is grouped namespace under which action is grouped",
"required" : true,
"type" : "string"
}, {
"name" : "action",
"in" : "query",
"description" : "The action",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of notification configuration details"
}
}
},
"post" : {
"tags" : [ "The resource class for CRU operations on notification config details" ],
"summary" : "Creates a new notification configuration for given action type",
"description" : "Creates a new notification configuration for given action type",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The Notification Configuration Object",
"required" : true,
"schema" : {
"$ref" : "#/definitions/NotificationConfiguration"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of a new notification configuration for given action type"
}
}
},
"put" : {
"tags" : [ "The resource class for CRU operations on notification config details" ],
"summary" : "Updates the notification configuration",
"description" : "Updates the notification configuration for given action type",
"operationId" : "put",
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The Notification Configuration Object",
"required" : true,
"schema" : {
"$ref" : "#/definitions/NotificationConfiguration"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of notification configuration for given action type"
}
}
}
},
"/rx/application/telemetry/notification/config/sku/{skuName}" : {
"get" : {
"tags" : [ "The resource class for CRU operations on notification config details" ],
"summary" : "Gets the notification configuration details",
"description" : "Fetch notification configuration details for given SKU",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "skuName",
"in" : "path",
"description" : "The sku name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of notification configuration details"
}
}
},
"post" : {
"tags" : [ "The resource class for CRU operations on notification config details" ],
"summary" : "Creates a new notification configuration for given action type and sku",
"description" : "Creates a new notification configuration for given action type and sku",
"operationId" : "post",
"parameters" : [ {
"name" : "skuName",
"in" : "path",
"description" : "The SKU name",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The Notification Configuration Object",
"required" : true,
"schema" : {
"$ref" : "#/definitions/NotificationConfiguration"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of a new notification configuration for given action type and sku"
}
}
},
"put" : {
"tags" : [ "The resource class for CRU operations on notification config details" ],
"summary" : "Updates the notification configuration",
"description" : "Updates the notification configuration for given SKU",
"operationId" : "put",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "skuName",
"in" : "path",
"description" : "The SKU name",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The Notification Configuration Object",
"required" : true,
"schema" : {
"$ref" : "#/definitions/NotificationConfiguration"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of notification configuration for given SKU"
}
}
}
},
"/rx/application/telemetry/notification/history" : {
"get" : {
"tags" : [ "NotificationHistoryResource to fetch notification history records" ],
"summary" : "Gets the notification history records",
"description" : "Retrieves the notification history records for given domain and action",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "domain",
"in" : "query",
"description" : "The namespace under which action is grouped",
"required" : true,
"type" : "string"
}, {
"name" : "action",
"in" : "query",
"description" : "The action",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of notification history records for given domain and action"
}
}
}
},
"/rx/application/telemetry/user" : {
"get" : {
"tags" : [ "Gainsight resource for managing Gainsight telemetry configuration and user preferences" ],
"summary" : "Gets hashed Gainsight user id",
"description" : "",
"operationId" : "getUser",
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of Gainsight telemetry user"
}
}
}
},
"/rx/application/telemetry/user/preferences" : {
"get" : {
"tags" : [ "Gainsight resource for managing Gainsight telemetry configuration and user preferences" ],
"summary" : "Gets Gainsight telemetry user preferences for the logged in user",
"description" : "",
"operationId" : "getUserPreferences",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of Gainsight telemetry user preferences"
},
"404" : {
"description" : "NOT FOUND: user preferences not found"
}
}
},
"put" : {
"tags" : [ "Gainsight resource for managing Gainsight telemetry configuration and user preferences" ],
"summary" : "Sets Gainsight telemetry user preferences for the logged in user",
"description" : "",
"operationId" : "setUserPreferences",
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful update of Gainsight telemetry user preferences"
},
"404" : {
"description" : "NOT FOUND: user preferences not found"
}
}
}
},
"/rx/application/tenant" : {
"post" : {
"tags" : [ "TenantResource for managing tenants" ],
"summary" : "Creates the tenant",
"description" : "Creates the tenant provided tenant data",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The tenant",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Tenant"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of tenant"
}
}
}
},
"/rx/application/tenant/tenant-info" : {
"get" : {
"tags" : [ "TenantResource for managing tenants" ],
"summary" : "Gets the tenancy information for the current logged in user",
"description" : "Retrieves the tenancy information for the current logged in user",
"operationId" : "get",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of tenancy information for the current logged in user",
"schema" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
}
}
}
},
"/rx/application/tenant/{name}" : {
"get" : {
"tags" : [ "TenantResource for managing tenants" ],
"summary" : "Gets the tenant",
"description" : "Retrieves the tenant provided tenant name",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of tenant",
"schema" : {
"$ref" : "#/definitions/Tenant"
}
}
}
},
"put" : {
"tags" : [ "TenantResource for managing tenants" ],
"summary" : "Updates the tenant",
"description" : "Updates the tenant provided tenant name and tenant data",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The tenant name",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The tenant",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Tenant"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of tenant"
}
}
},
"delete" : {
"tags" : [ "TenantResource for managing tenants" ],
"summary" : "Deletes the tenant",
"description" : "Deletes the tenant provided tenant name",
"operationId" : "delete",
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The tenant name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of tenant"
}
}
}
},
"/rx/application/tenant/{name}/errordetails" : {
"get" : {
"tags" : [ "TenantResource for managing tenants" ],
"summary" : "Gets the error details",
"description" : "Retrieves the error details provided tenant name",
"operationId" : "getErrorDetails",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The tenant name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of tenant error details",
"schema" : {
"$ref" : "#/definitions/TenantErrorDetails"
}
}
}
}
},
"/rx/application/texttemplate" : {
"post" : {
"tags" : [ "TextTemplateResource for managing text templates" ],
"summary" : "Creates the text template",
"description" : "Creates the text template provided text template data",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The text template data",
"required" : true,
"schema" : {
"$ref" : "#/definitions/TextTemplate"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of text template"
}
}
}
},
"/rx/application/texttemplate/{templateName}" : {
"get" : {
"tags" : [ "TextTemplateResource for managing text templates" ],
"summary" : "Gets the Text template",
"description" : "Retrieves the Text template provided template name",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "templateName",
"in" : "path",
"description" : "The name of text template",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of Text template",
"schema" : {
"$ref" : "#/definitions/TextTemplate"
}
}
}
},
"delete" : {
"tags" : [ "TextTemplateResource for managing text templates" ],
"summary" : "Deletes the text template",
"description" : "Deletes the text template provided text template name",
"operationId" : "delete",
"parameters" : [ {
"name" : "templateName",
"in" : "path",
"description" : "The text template name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of text template"
}
}
}
},
"/rx/application/theme/theme.css" : {
"get" : {
"tags" : [ "ThemeResource for managing themeCss" ],
"summary" : "Gets the themeCss content",
"description" : "Retrieves the themeCss content",
"operationId" : "get",
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of themeCss content"
}
}
},
"put" : {
"tags" : [ "ThemeResource for managing themeCss" ],
"summary" : "Updates the themeCss content",
"description" : "Updates the themeCss content provided form data multipart",
"operationId" : "put",
"consumes" : [ "multipart/form-data" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The form data multipart",
"required" : true,
"schema" : {
"$ref" : "#/definitions/FormDataMultiPart"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of themeCss content"
}
}
}
},
"/rx/application/theme/{name}" : {
"get" : {
"tags" : [ "ThemeResource for managing themeCss" ],
"summary" : "Gets the theme css file content",
"description" : "Retrieves the theme css file content",
"operationId" : "get",
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name of the css file",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of theme css file content"
}
}
},
"put" : {
"tags" : [ "ThemeResource for managing themeCss" ],
"summary" : "Updates the theme css file content",
"description" : "Updates the theme css file content provided form data multipart",
"operationId" : "put",
"consumes" : [ "multipart/form-data" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name of the css file",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The form data multipart",
"required" : true,
"schema" : {
"$ref" : "#/definitions/FormDataMultiPart"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of theme css file content"
}
}
}
},
"/rx/application/user" : {
"post" : {
"tags" : [ "User resource for managing users" ],
"summary" : "Creates given user",
"description" : "Creating a User account should be performed using the RecordInstance resource against the foundation person record definition. When the appropriate account information is provided in the person record definition, a User account will be created automatically. Foundation Person should always be the source of truth for people within the system (for those who may and may not require login accounts)",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "User object which needs to be created",
"required" : true,
"schema" : {
"$ref" : "#/definitions/User"
}
} ],
"responses" : {
"201" : {
"description" : "User creation successful"
}
}
}
},
"/rx/application/user/modify-all" : {
"post" : {
"tags" : [ "User resource for managing users" ],
"summary" : "Gets user service",
"description" : "Gets user service provided user modify all parameters",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The user modify all parameters",
"required" : true,
"schema" : {
"$ref" : "#/definitions/UserModifyAllParameters"
}
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of user service"
}
}
}
},
"/rx/application/user/{loginName}" : {
"get" : {
"tags" : [ "User resource for managing users" ],
"summary" : "Gets the user details",
"description" : "Retrieves the User details based on loginName of the user",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "loginName",
"in" : "path",
"description" : "The login name",
"required" : true,
"type" : "string",
"pattern" : ".+"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of user details"
}
}
},
"put" : {
"tags" : [ "User resource for managing users" ],
"summary" : "Updates the given user",
"description" : "Updating a User account should be performed using the RecordInstance resource against the foundation Person record definition When the appropriate account information is updated in the person record definition, a User account will be updated automatically Foundation Person should always be the source of truth for people within the system (for those who may and may not require login accounts)",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "loginName",
"in" : "path",
"description" : "The login name",
"required" : true,
"type" : "string",
"pattern" : ".+"
}, {
"in" : "body",
"name" : "body",
"description" : "The user",
"required" : true,
"schema" : {
"$ref" : "#/definitions/User"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of given user"
}
}
},
"delete" : {
"tags" : [ "User resource for managing users" ],
"summary" : "Deletes the given user",
"description" : "Deleting a User account should be performed using the RecordInstance resource against the foundation Person record definition When the appropriate person account information is deleted (that has a corresponding User account), the User account will be deleted automatically Foundation Person should always be the source of truth for people within the system (for those who may and may not require login accounts)",
"operationId" : "delete",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "loginName",
"in" : "path",
"description" : "The login name",
"required" : true,
"type" : "string",
"pattern" : ".+"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of given user"
}
}
}
},
"/rx/application/view/viewdefinition" : {
"post" : {
"tags" : [ "ViewDefinitionResource for managing view definitions" ],
"summary" : "Creates the ViewDefinition",
"description" : "Creates the ViewDefinition",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The ViewDefinition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ViewDefinition"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of view definition"
}
}
}
},
"/rx/application/view/viewdefinition/{name}" : {
"get" : {
"tags" : [ "ViewDefinitionResource for managing view definitions" ],
"summary" : "Gets the ViewDefinition",
"description" : "Retrieves the ViewDefinition provided it's name, locale and copyFrom",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name of the ViewDefinition",
"required" : true,
"type" : "string"
}, {
"name" : "locale",
"in" : "query",
"description" : "The locale passed as a query param",
"required" : true,
"type" : "string"
}, {
"name" : "copyFrom",
"in" : "query",
"description" : "The copyFrom query param for copying a view definition",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of ViewDefinition",
"schema" : {
"$ref" : "#/definitions/ViewDefinition"
}
}
}
},
"put" : {
"tags" : [ "ViewDefinitionResource for managing view definitions" ],
"summary" : "Updates the ViewDefinition",
"description" : "Updates the ViewDefinition provided it's name and definition",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name of the ViewDefinition",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The ViewDefinition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ViewDefinition"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of ViewDefinition"
}
}
},
"delete" : {
"tags" : [ "ViewDefinitionResource for managing view definitions" ],
"summary" : "Deletes the ViewDefinition",
"description" : "Deletes the ViewDefinition provided name of the ViewDefinition",
"operationId" : "delete",
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name of the ViewDefinition",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of ViewDefinition"
}
}
}
},
"/rx/application/webapi/connection" : {
"post" : {
"tags" : [ "WebApiConnectionResource for managing web API connections" ],
"summary" : "Creates the web API connection",
"description" : "Creates the web API connection provided web api connection data",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The ",
"required" : true,
"schema" : {
"$ref" : "#/definitions/WebApiConnection"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of web API connection"
}
}
}
},
"/rx/application/webapi/connection/{guid}" : {
"get" : {
"tags" : [ "WebApiConnectionResource for managing web API connections" ],
"summary" : "Gets the web api connection",
"description" : "Retrieves the web api connection provided guid",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "guid",
"in" : "path",
"description" : "The guid",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of web api connection"
}
}
},
"put" : {
"tags" : [ "WebApiConnectionResource for managing web API connections" ],
"summary" : "Updates the web API connection",
"description" : "Updates the web API connection provided web api connection data and config guid",
"operationId" : "put",
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The web api connection",
"required" : true,
"schema" : {
"$ref" : "#/definitions/WebApiConnection"
}
}, {
"name" : "guid",
"in" : "path",
"description" : "The config guid",
"required" : true,
"type" : "string"
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of web API connection"
}
}
},
"delete" : {
"tags" : [ "WebApiConnectionResource for managing web API connections" ],
"summary" : "Deletes the web api connection",
"description" : "Deletes the web api connection provided guid",
"operationId" : "delete",
"parameters" : [ {
"name" : "guid",
"in" : "path",
"description" : "The guid",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of web api connection"
}
}
}
},
"/rx/application/webapi/webapidefinition" : {
"post" : {
"tags" : [ "WebApiDefinitionResource for managing Web Api definitions" ],
"summary" : "Creates the web api definition",
"description" : "Creates the web api definition provided web api definition data",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The web api definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/WebApiDefinition"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of web api definition"
}
}
}
},
"/rx/application/webapi/webapidefinition/{name}" : {
"get" : {
"tags" : [ "WebApiDefinitionResource for managing Web Api definitions" ],
"summary" : "Gets the web api definition",
"description" : "Retrieves the web api definition provided it's name",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name of web api definition",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of web api definition",
"schema" : {
"$ref" : "#/definitions/WebApiDefinition"
}
}
}
},
"put" : {
"tags" : [ "WebApiDefinitionResource for managing Web Api definitions" ],
"summary" : "Updates the web api definition",
"description" : "Updates the web api definition provided it's name and web api definition data",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name of web api definition",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The web api definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/WebApiDefinition"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of web api definition"
}
}
},
"delete" : {
"tags" : [ "WebApiDefinitionResource for managing Web Api definitions" ],
"summary" : "Deletes the web api definition",
"description" : "Deletes the web api definition provided it's name",
"operationId" : "delete",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name of web api definition",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of web api definition"
}
}
}
},
"/rx/application/webhook/processorsmetadata" : {
"get" : {
"tags" : [ "WebhookCallbackProcessorMetadataResource for webhook processor metadata" ],
"summary" : "Gets the webhook processor metadata",
"description" : "Retrieves the webhook processor metadata",
"operationId" : "get",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of webhook processor metadata",
"schema" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
}
}
}
},
"/rx/application/webhook/webhookdefinition" : {
"post" : {
"tags" : [ "WebhookDefinitionResource for managing webhook definitions" ],
"summary" : "Creates the webhook definition",
"description" : "Creates the webhook definition provided webhook definition data",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The webhook definition",
"required" : true,
"schema" : {
"$ref" : "#/definitions/WebhookDefinition"
}
} ],
"responses" : {
"201" : {
"description" : "CREATED: Successful creation of webhook definition"
}
}
}
},
"/rx/application/webhook/webhookdefinition/{name}" : {
"get" : {
"tags" : [ "WebhookDefinitionResource for managing webhook definitions" ],
"summary" : "Gets the webhook definition",
"description" : "Retrieves the webhook definition provided it's name",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name of webhook definition",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval of webhook definition",
"schema" : {
"$ref" : "#/definitions/WebhookDefinition"
}
}
}
},
"put" : {
"tags" : [ "WebhookDefinitionResource for managing webhook definitions" ],
"summary" : "Updates the webhook definition",
"description" : "Updates the webhook definition provided it's name and update json",
"operationId" : "put",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name of webhook definition",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The update json",
"required" : true,
"schema" : {
"$ref" : "#/definitions/JsonNode"
}
} ],
"responses" : {
"204" : {
"description" : "NO CONTENT: Successful updation of webhook definition"
}
}
},
"delete" : {
"tags" : [ "WebhookDefinitionResource for managing webhook definitions" ],
"summary" : "Deletes the webhook definition",
"description" : "Deletes the webhook definition provided it's name",
"operationId" : "delete",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name of webhook definition",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful deletion of webhook definition"
}
}
}
},
"/rx/application/webhook_callback/{configProcessorGuid}/{tenantId}" : {
"get" : {
"tags" : [ "WebhookCallbackProcessorResource" ],
"summary" : "Processes Webhook Callback GET call",
"description" : "",
"operationId" : "get",
"parameters" : [ {
"name" : "configProcessorGuid",
"in" : "path",
"description" : "The Webhook callback processor guid",
"required" : true,
"type" : "string"
}, {
"name" : "tenantId",
"in" : "path",
"description" : "The TenantId",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful processing of message"
}
}
},
"post" : {
"tags" : [ "WebhookCallbackProcessorResource" ],
"summary" : "Processes Webhook Callback POST call",
"description" : "",
"operationId" : "post",
"consumes" : [ "application/json", "text/xml" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "request body",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "configProcessorGuid",
"in" : "path",
"description" : "Webhook callback processor guid",
"required" : true,
"type" : "string"
}, {
"name" : "tenantId",
"in" : "path",
"description" : "The TenantId",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful processing of message"
}
}
}
},
"/rx/authentication/loginrequest" : {
"post" : {
"tags" : [ "LoginRequestResource to manage login requests" ],
"summary" : "Login request",
"description" : "",
"operationId" : "post",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The login request",
"required" : true,
"schema" : {
"$ref" : "#/definitions/LoginRequest"
}
} ],
"responses" : {
"200" : {
"description" : "OK: Successful login"
}
}
}
},
"/rx/authentication/logoutrequest" : {
"post" : {
"tags" : [ "LogoutRequestResource to manage logout requests" ],
"summary" : "Logout request",
"description" : "",
"operationId" : "post",
"responses" : {
"200" : {
"description" : "OK: Successful logout"
}
}
}
},
"/rx/authentication/token/{tokenType}" : {
"get" : {
"tags" : [ "AuthTokenResource to get authentication tokens" ],
"summary" : "Gets the authetication token",
"description" : "Gets the authetication token.",
"operationId" : "getToken",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "tokenType",
"in" : "path",
"description" : "The token type",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful get the authetication token"
}
}
}
},
"/rx/connectoraction" : {
"get" : {
"tags" : [ "ConnectorResource for managing connector services" ],
"summary" : "Gets the connector action descriptor",
"description" : "",
"operationId" : "getConnectorActionDescriptor",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "aliasName",
"in" : "query",
"description" : "The alias name",
"required" : true,
"type" : "string"
}, {
"name" : "aliasType",
"in" : "query",
"description" : "The alias type",
"required" : true,
"type" : "string"
}, {
"name" : "actionName",
"in" : "query",
"description" : "The action name",
"required" : true,
"type" : "string"
}, {
"name" : "bundleId",
"in" : "query",
"description" : "The bundle id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK: Successful retrieval",
"schema" : {
"$ref" : "#/definitions/ConnectorActionDescriptor"
}
}
}
}
}
},
"definitions" : {
"ActionDescriptor" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"path" : {
"type" : "string"
},
"inputs" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/InputDescriptor"
}
},
"outputs" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/OutputDescriptor"
}
}
}
},
"AdminComponentDefinition" : {
"type" : "object",
"properties" : {
"componentName" : {
"type" : "string"
},
"parentComponentName" : {
"type" : "string"
},
"supportsMultiple" : {
"type" : "boolean",
"default" : false
},
"impactRowVisibility" : {
"type" : "string"
},
"viewToOpen" : {
"type" : "string"
},
"status" : {
"type" : "string"
},
"showInNAVBar" : {
"type" : "boolean",
"default" : false
},
"linkType" : {
"type" : "string"
},
"viewComponent" : {
"type" : "boolean",
"default" : false
},
"externalLink" : {
"type" : "string"
},
"registeredModuleName" : {
"type" : "string"
},
"showInLocation" : {
"type" : "string"
},
"localeList" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AdminComponentLocale"
}
},
"settingMetaData" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/SettingControlMetaData"
}
},
"permissions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Permission"
}
}
}
},
"AdminComponentGridData" : {
"type" : "object",
"properties" : {
"totalSize" : {
"type" : "integer",
"format" : "int32"
},
"header" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/SettingControlMetaData"
}
},
"rows" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
}
}
},
"AdminComponentLocale" : {
"type" : "object",
"properties" : {
"locale" : {
"type" : "string"
},
"firstMenu" : {
"type" : "string"
},
"secondMenu" : {
"type" : "string"
},
"componentLabel" : {
"type" : "string"
}
}
},
"AdminComponentSettingLocale" : {
"type" : "object",
"properties" : {
"locale" : {
"type" : "string"
},
"fieldGrouping" : {
"type" : "string"
},
"settingLabel" : {
"type" : "string"
}
}
},
"AdminNavigation" : {
"type" : "object",
"properties" : {
"AdminNavigationMenu" : {
"$ref" : "#/definitions/AdminNavigationComponent"
}
}
},
"AdminNavigationComponent" : {
"type" : "object",
"properties" : {
"label" : {
"type" : "string"
},
"defaultBundleScope" : {
"type" : "string"
},
"viewComponent" : {
"type" : "boolean",
"default" : false
},
"guid" : {
"type" : "string"
},
"compName" : {
"type" : "string"
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AdminNavigationComponent"
}
},
"isCustom" : {
"type" : "boolean",
"default" : false
},
"linkType" : {
"type" : "string"
},
"externalLink" : {
"type" : "string"
},
"registeredModuleName" : {
"type" : "string"
}
}
},
"AdminSettingData" : {
"type" : "object",
"properties" : {
"settingId" : {
"type" : "string"
},
"componentName" : {
"type" : "string"
},
"parentComponentName" : {
"type" : "string"
},
"settingName" : {
"type" : "string"
},
"settingValue" : {
"type" : "string"
},
"ownerKeyValue1" : {
"type" : "string"
},
"ownerKeyValue2" : {
"type" : "string"
},
"fileName" : {
"type" : "string"
},
"fileType" : {
"type" : "string"
},
"assigneeGroupPermission" : {
"type" : "string"
}
}
},
"AdminSettingDataContainer" : {
"type" : "object",
"properties" : {
"values" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AdminSettingData"
}
}
}
},
"AdminSettingMetaData" : {
"type" : "object",
"properties" : {
"compName" : {
"type" : "string"
},
"header" : {
"type" : "string"
},
"supportsMultiple" : {
"type" : "boolean",
"default" : false
},
"parentComponent" : {
"type" : "string"
},
"groups" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/SettingGroup"
}
},
"createPermission" : {
"type" : "boolean",
"default" : false
},
"impactRowVisibility" : {
"type" : "string"
}
}
},
"ApplicationLicenseDescriptor" : {
"type" : "object",
"properties" : {
"friendlyName" : {
"type" : "string"
},
"applicationName" : {
"type" : "string"
},
"applicationType" : {
"type" : "string",
"enum" : [ "BMC", "Partner", "Custom" ]
},
"enforceEndUserLicenses" : {
"type" : "boolean",
"default" : false
},
"applicationLicenseName" : {
"type" : "string"
},
"applicationLicenseCount" : {
"type" : "integer",
"format" : "int32"
},
"helixPlatformNamedLicenses" : {
"type" : "integer",
"format" : "int32"
},
"helixPlatformAssignedLicenses" : {
"type" : "integer",
"format" : "int32"
},
"developerName" : {
"type" : "string"
}
}
},
"ApplicationLogSetting" : {
"type" : "object",
"properties" : {
"applicationId" : {
"type" : "string"
},
"fileName" : {
"type" : "string"
},
"logLevel" : {
"type" : "integer",
"format" : "int32"
}
}
},
"ArticleFeedback" : {
"type" : "object",
"properties" : {
"articleId" : {
"type" : "string"
},
"locale" : {
"type" : "string"
},
"isHelpful" : {
"type" : "boolean",
"default" : false
},
"email" : {
"type" : "string"
},
"reason" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"providerSourceName" : {
"type" : "string"
}
}
},
"Artifact" : {
"type" : "object",
"properties" : {
"guid" : {
"type" : "string"
}
}
},
"AssignmentExpression" : {
"type" : "object",
"properties" : {
"assignTarget" : {
"type" : "string"
},
"expression" : {
"type" : "string"
}
}
},
"AssociatedAuditField" : {
"type" : "object",
"properties" : {
"sourceFieldId" : {
"type" : "integer",
"format" : "int32"
},
"fieldId" : {
"type" : "integer",
"format" : "int32"
},
"fieldName" : {
"type" : "string"
},
"sourceNode" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "string",
"format" : "date-time"
},
"mappedFieldIds" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int32"
}
}
}
},
"AssociationDefinition" : {
"type" : "object",
"required" : [ "cardinality", "shouldCascadeDelete" ],
"properties" : {
"version" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "string",
"format" : "date-time"
},
"lastChangedBy" : {
"type" : "string"
},
"owner" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"description" : {
"type" : "string"
},
"overlayGroupId" : {
"type" : "string"
},
"scope" : {
"type" : "string",
"enum" : [ "PUBLIC", "BUNDLE", "PLATFORM_ONLY", "SERVICE_ONLY" ]
},
"internal" : {
"type" : "boolean",
"default" : false
},
"guid" : {
"type" : "string"
},
"nodeAId" : {
"type" : "string"
},
"nodeBId" : {
"type" : "string"
},
"nodeAName" : {
"type" : "string"
},
"nodeBName" : {
"type" : "string"
},
"shouldCascadeDelete" : {
"type" : "boolean",
"default" : false
},
"cardinality" : {
"type" : "string",
"enum" : [ "ONE_TO_ONE", "ONE_TO_MANY", "MANY_TO_MANY" ]
},
"nodeAKeys" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int32"
}
},
"nodeBKeys" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int32"
}
},
"isEnabled" : {
"type" : "boolean",
"default" : false
},
"overlayDescriptor" : {
"$ref" : "#/definitions/AssociationDefinitionOverlayDescriptor"
},
"allowOverlay" : {
"type" : "boolean",
"default" : false
},
"nodeAModality" : {
"type" : "string",
"enum" : [ "REQUIRED", "OPTIONAL" ]
}
}
},
"AssociationDefinitionOverlayDescriptor" : {
"type" : "object",
"properties" : {
"parentOverlayGroupId" : {
"type" : "string"
}
}
},
"Attachment" : {
"type" : "object",
"properties" : {
"content" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"AuthenticationType" : {
"type" : "object"
},
"BodyPart" : {
"type" : "object",
"properties" : {
"contentDisposition" : {
"$ref" : "#/definitions/ContentDisposition"
},
"entity" : {
"type" : "object"
},
"headers" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"mediaType" : {
"$ref" : "#/definitions/MediaType"
},
"messageBodyWorkers" : {
"$ref" : "#/definitions/MessageBodyWorkers"
},
"parent" : {
"$ref" : "#/definitions/MultiPart"
},
"providers" : {
"$ref" : "#/definitions/Providers"
},
"parameterizedHeaders" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ParameterizedHeader"
}
}
}
}
},
"BundleDescriptor" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"friendlyName" : {
"type" : "string"
},
"version" : {
"type" : "string"
},
"displayVersion" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"developerId" : {
"type" : "string"
},
"developerName" : {
"type" : "string"
},
"lastDeployedTime" : {
"type" : "string",
"format" : "date-time"
},
"dependentBundles" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/BundleDescriptor"
}
},
"otherBundles" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/BundleDescriptor"
}
},
"isApplication" : {
"type" : "boolean",
"default" : false
},
"containsJavaScript" : {
"type" : "boolean",
"default" : false
},
"containsAngular" : {
"type" : "boolean",
"default" : false
},
"overlayGroupId" : {
"type" : "string"
},
"hasCustomEntryPoint" : {
"type" : "boolean",
"default" : false
},
"userRequestedDependentBundles" : {
"type" : "string"
},
"status" : {
"type" : "string"
},
"customizationPerspective" : {
"type" : "string"
},
"isLicensed" : {
"type" : "boolean",
"default" : false
},
"platformBundle" : {
"type" : "boolean",
"default" : false
},
"uiOptions" : {
"type" : "string"
},
"localizedDisplayName" : {
"type" : "string"
},
"showInAppLauncher" : {
"type" : "boolean",
"default" : false
}
}
},
"ByteArrayOutputStream" : {
"type" : "object"
},
"CharacterChatVariableDefinition" : {
"type" : "object",
"properties" : {
"lastUpdateTime" : {
"type" : "string",
"format" : "date-time"
},
"lastChangedBy" : {
"type" : "string"
},
"owner" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"description" : {
"type" : "string"
},
"overlayGroupId" : {
"type" : "string"
},
"internal" : {
"type" : "boolean",
"default" : false
},
"id" : {
"type" : "integer",
"format" : "int32"
},
"fieldOption" : {
"type" : "string",
"enum" : [ "REQUIRED", "OPTIONAL", "SYSTEM" ]
},
"permissions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/FieldDefinitionPermission"
}
},
"fieldTypeName" : {
"type" : "string"
},
"isInherited" : {
"type" : "boolean",
"default" : false
},
"explicitPermissions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/FieldDefinitionPermission"
}
},
"overlayDescriptor" : {
"$ref" : "#/definitions/FieldDefinitionOverlayDescriptor"
},
"fieldMapping" : {
"$ref" : "#/definitions/RecordDefinitionFieldMapping"
},
"allowPermissionsOverlay" : {
"type" : "boolean",
"default" : false
},
"allowOtherPropertiesOverlay" : {
"type" : "boolean",
"default" : false
},
"auditOption" : {
"type" : "string",
"enum" : [ "NONE", "AUDIT", "COPY", "AUDIT_AND_COPY" ]
},
"allowPermissionsEdit" : {
"type" : "boolean",
"default" : false
},
"guid" : {
"type" : "string"
},
"anyUserAllowedToSubmit" : {
"type" : "boolean",
"default" : false
},
"identityField" : {
"type" : "boolean",
"default" : false
}
}
},
"ChatDefaultValue" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "CUSTOM", "SERVICE_BROKER_CONTEXT_VARIABLE" ]
},
"value" : {
"type" : "string"
},
"values" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"ChatDefinition" : {
"type" : "object",
"properties" : {
"version" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "string",
"format" : "date-time"
},
"lastChangedBy" : {
"type" : "string"
},
"owner" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"description" : {
"type" : "string"
},
"overlayGroupId" : {
"type" : "string"
},
"scope" : {
"type" : "string",
"enum" : [ "PUBLIC", "BUNDLE", "PLATFORM_ONLY", "SERVICE_ONLY" ]
},
"internal" : {
"type" : "boolean",
"default" : false
},
"guid" : {
"type" : "string"
},
"intentDefinitions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/IntentDefinition"
}
},
"entityDefinitions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/EntityDefinition"
}
},
"dialogNodeDefinitions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/DialogNodeDefinition"
}
},
"status" : {
"type" : "string",
"enum" : [ "UNTRAINED", "TRAINING", "TRAINED", "FAILED", "PENDING_RETRAINING" ]
},
"lastTrainTime" : {
"type" : "string",
"format" : "date-time"
},
"isEnabled" : {
"type" : "boolean",
"default" : false
},
"chatVariableDefinitions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CharacterChatVariableDefinition"
}
},
"allowOverlay" : {
"type" : "boolean",
"default" : false
},
"serviceType" : {
"type" : "string",
"enum" : [ "SERVICE", "DAY_2_ACTION" ]
},
"disambiguationSettings" : {
"$ref" : "#/definitions/ChatDisambiguationSettings"
},
"isDisambiguationSupported" : {
"type" : "boolean",
"default" : false
},
"isHelixGptProvider" : {
"type" : "boolean",
"default" : false
},
"versionGuid" : {
"type" : "string"
},
"serviceRevisionId" : {
"type" : "string"
},
"chatbotId" : {
"type" : "string"
},
"isSummaryIncluded" : {
"type" : "boolean",
"default" : false
},
"machineLearningProviderWorkspaceId" : {
"type" : "string"
},
"language" : {
"type" : "string"
}
}
},
"ChatDisambiguationSettings" : {
"type" : "object",
"properties" : {
"prompt" : {
"type" : "string"
},
"noneOfTheAbovePrompt" : {
"type" : "string"
},
"enabled" : {
"type" : "boolean",
"default" : false
}
}
},
"ChatbotConfiguration" : {
"type" : "object",
"properties" : {
"chatbotLocale" : {
"$ref" : "#/definitions/ChatbotLocale"
},
"bundleId" : {
"type" : "string"
},
"chatbotConfigurationId" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"chatBubbleColor" : {
"type" : "string"
},
"chatbotAvatar" : {
"$ref" : "#/definitions/Attachment"
},
"agentAvatar" : {
"$ref" : "#/definitions/Attachment"
},
"maxNumberOfStatusRequests" : {
"type" : "integer",
"format" : "int32"
},
"maxNumberOfKnowledgeArticles" : {
"type" : "integer",
"format" : "int32"
},
"maxNumberOfMyStuffItems" : {
"type" : "integer",
"format" : "int32"
},
"maxPassagesCharacters" : {
"type" : "integer",
"format" : "int32"
},
"brandLogo" : {
"$ref" : "#/definitions/Attachment"
},
"headerColor" : {
"type" : "string"
},
"footerColor" : {
"type" : "string"
},
"brandName" : {
"type" : "string"
},
"headerBorderColor" : {
"type" : "string"
},
"headerTextColor" : {
"type" : "string"
},
"enableChatbotAnimation" : {
"type" : "boolean",
"default" : false
},
"numberOfButtonsToDisplay" : {
"type" : "integer",
"format" : "int32"
},
"numberOfDynamicButtonsToDisplay" : {
"type" : "integer",
"format" : "int32"
},
"selectedTheme" : {
"type" : "integer",
"format" : "int32"
},
"trustedWebsites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"enableSummarizationService" : {
"type" : "boolean",
"default" : false
},
"summarySentencePercent" : {
"type" : "integer",
"format" : "int32"
},
"enableTranslation" : {
"type" : "boolean",
"default" : false
},
"translationSkillLocale" : {
"type" : "string"
},
"userNamePresentation" : {
"type" : "integer",
"format" : "int32"
},
"minimumSentencesForSummary" : {
"type" : "integer",
"format" : "int32"
},
"minimumSentencesForToneAnalysis" : {
"type" : "integer",
"format" : "int32"
},
"shareToneAnalysis" : {
"type" : "boolean",
"default" : false
},
"maxNumberOfServicesOrResourcePools" : {
"type" : "integer",
"format" : "int32"
},
"maxNumberOfResourcesOrVmsInRecommendation" : {
"type" : "integer",
"format" : "int32"
},
"liveAgentMetadata" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"chatbotAnimation" : {
"$ref" : "#/definitions/Attachment"
},
"agentNotificationSound" : {
"$ref" : "#/definitions/Attachment"
},
"enableLookupTranslation" : {
"type" : "boolean",
"default" : false
},
"firebaseWebApiKey" : {
"type" : "string"
},
"firebaseDomain" : {
"type" : "string"
},
"enableNotifications" : {
"type" : "boolean",
"default" : false
},
"primaryColor" : {
"type" : "string"
},
"secondaryColor" : {
"type" : "string"
},
"activeColor" : {
"type" : "string"
},
"assistantServiceProvider" : {
"type" : "integer",
"format" : "int32"
},
"isTileClickTrain" : {
"type" : "boolean",
"default" : false
},
"highlightOn" : {
"type" : "boolean",
"default" : false
},
"lastCommentShown" : {
"type" : "boolean",
"default" : false
},
"ratingScalePresentationDefaultOrder" : {
"type" : "boolean",
"default" : false
}
}
},
"ChatbotLocale" : {
"type" : "object",
"properties" : {
"welcomeMessage" : {
"type" : "string"
},
"footerMessage" : {
"type" : "string"
},
"chatbotName" : {
"type" : "string"
},
"workspaceId" : {
"type" : "string"
},
"chatLocale" : {
"type" : "string"
},
"chatbotConfigurationId" : {
"type" : "string"
},
"credentialType" : {
"type" : "string"
},
"secret" : {
"type" : "string"
},
"userName" : {
"type" : "string"
},
"chatbotLocaleId" : {
"type" : "string"
},
"synonymsByTopics" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"optionButtons" : {
"$ref" : "#/definitions/OptionsText"
},
"initialIntent" : {
"type" : "string"
},
"searchProvider" : {
"type" : "integer",
"format" : "int32"
},
"searchFilterId" : {
"type" : "string"
},
"searchDatasetNames" : {
"type" : "string"
},
"customPassages" : {
"type" : "string"
}
}
},
"ComponentDefinition" : {
"type" : "object",
"properties" : {
"lastUpdateTime" : {
"type" : "string",
"format" : "date-time"
},
"lastChangedBy" : {
"type" : "string"
},
"owner" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"description" : {
"type" : "string"
},
"overlayGroupId" : {
"type" : "string"
},
"internal" : {
"type" : "boolean",
"default" : false
},
"guid" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"propertiesByName" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"permissions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ComponentDefinitionPermission"
}
}
}
},
"ComponentDefinitionPermission" : {
"type" : "object",
"properties" : {
"ownerId" : {
"$ref" : "#/definitions/PermissionOwnerId"
},
"type" : {
"type" : "string",
"enum" : [ "VISIBLE", "HIDDEN" ]
}
}
},
"ConfidentialDataDescriptor" : {
"type" : "object",
"properties" : {
"confidential" : {
"type" : "boolean",
"default" : false
},
"functionalRoleIdPermissions" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"ConnectionInstance" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"properties" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
}
},
"ConnectorActionDescriptor" : {
"type" : "object",
"properties" : {
"operationType" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"inputParams" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ConnectorOperationParameter"
}
},
"outputParams" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ConnectorOperationParameter"
}
}
}
},
"ConnectorConfiguration" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"ConnectorDescriptor" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"version" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"path" : {
"type" : "string"
},
"capabilities" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"actions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ActionDescriptor"
}
},
"remoteServerId" : {
"type" : "string"
},
"activeConnectionInstances" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ConnectorConfiguration"
}
}
}
},
"ConnectorOperationDescriptor" : {
"type" : "object",
"properties" : {
"operationType" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"inputParams" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ConnectorOperationParameter"
}
},
"outputParams" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ConnectorOperationParameter"
}
}
}
},
"ConnectorOperationParameter" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"systemName" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"required" : {
"type" : "boolean",
"default" : false
}
}
},
"ContentDisposition" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string"
},
"parameters" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"fileName" : {
"type" : "string"
},
"creationDate" : {
"type" : "string",
"format" : "date-time"
},
"modificationDate" : {
"type" : "string",
"format" : "date-time"
},
"readDate" : {
"type" : "string",
"format" : "date-time"
},
"size" : {
"type" : "integer",
"format" : "int64"
}
}
},
"CreatePackageStatus" : {
"type" : "object",
"properties" : {
"packageExportStatus" : {
"type" : "string"
},
"packageName" : {
"type" : "string"
},
"packageId" : {
"type" : "string"
},
"packageType" : {
"type" : "string"
},
"packageVersion" : {
"type" : "string"
},
"deploymentParsedStatus" : {
"$ref" : "#/definitions/DeploymentParsedStatus"
},
"packageExportUrl" : {
"type" : "string"
},
"lastExportedDate" : {
"type" : "string"
},
"lastExportedBy" : {
"type" : "string"
}
}
},
"DataPage" : {
"type" : "object",
"properties" : {
"totalSize" : {
"type" : "integer",
"format" : "int32"
},
"data" : {
"type" : "array",
"items" : {
"type" : "object"
}
},
"token" : {
"type" : "string"
},
"cursor" : {
"type" : "string"
}
}
},
"DataPageRequest" : {
"type" : "object",
"properties" : {
"values" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
}
},
"DataSourceConfiguration" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"dataSourceName" : {
"type" : "string"
}
}
},
"DeploymentParsedStatus" : {
"type" : "object",
"properties" : {
"importingServer" : {
"type" : "string"
},
"definitionsOverallImportStatus" : {
"type" : "string"
},
"dataOverallImportStatus" : {
"type" : "string"
},
"errorMessages" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"definitionsStatusContent" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"tenantDataStatusContent" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"overallImportSummary" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "object"
}
}
}
}
},
"DeploymentStatus" : {
"type" : "object",
"properties" : {
"packageDeployStatus" : {
"type" : "string"
},
"packageId" : {
"type" : "string"
},
"packageName" : {
"type" : "string"
},
"packageVersion" : {
"type" : "string"
},
"serverDeploymentStatus" : {
"type" : "object",
"additionalProperties" : {
"type" : "string",
"enum" : [ "PendingDeploy", "ReadyDeploy", "Deploying", "Deployed", "PendingUndeploy", "ReadyUndeploy", "Undeploying", "Undeployed", "Error", "DeployedWithImportError", "DeployedWithImportWarning", "PendingPackageCreate", "PackageCreated" ]
}
},
"currentServersInSync" : {
"type" : "boolean",
"default" : false
},
"newlyAddedServers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"deploymentParsedStatus" : {
"$ref" : "#/definitions/DeploymentParsedStatus"
}
}
},
"DialogNodeChatAction" : {
"type" : "object",
"properties" : {
"inputMap" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AssignmentExpression"
}
},
"outputMap" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AssignmentExpression"
}
},
"isWaitForActionExecution" : {
"type" : "boolean",
"default" : false
}
}
},
"DialogNodeDefinition" : {
"type" : "object",
"properties" : {
"version" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "string",
"format" : "date-time"
},
"lastChangedBy" : {
"type" : "string"
},
"owner" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"description" : {
"type" : "string"
},
"overlayGroupId" : {
"type" : "string"
},
"scope" : {
"type" : "string",
"enum" : [ "PUBLIC", "BUNDLE", "PLATFORM_ONLY", "SERVICE_ONLY" ]
},
"internal" : {
"type" : "boolean",
"default" : false
},
"guid" : {
"type" : "string"
},
"condition" : {
"type" : "string"
},
"slots" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/DialogNodeSlot"
}
},
"responses" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/DialogNodeResponse"
}
},
"nextStep" : {
"$ref" : "#/definitions/DialogNodeNextStep"
},
"context" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
},
"requestClarificationPhrase" : {
"type" : "string"
},
"digressionSettings" : {
"$ref" : "#/definitions/DialogNodeDigressionSettings"
},
"childDialogNodeDefinitions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/DialogNodeDefinition"
}
}
}
},
"DialogNodeDigressionSettings" : {
"type" : "object",
"properties" : {
"digressIn" : {
"type" : "string"
},
"digressOut" : {
"type" : "string"
},
"digressOutSlots" : {
"type" : "string"
}
}
},
"DialogNodeNextStep" : {
"type" : "object",
"properties" : {
"nextStepOption" : {
"type" : "string",
"enum" : [ "WAIT_FOR_USER_INPUT", "SKIP_USER_INPUT", "GOTO_CONDITION", "GOTO_RESPONSE", "REPROMPT", "SKIP_CURRENT_SLOT", "MOVE_ON" ]
},
"gotoDialogNodeGuid" : {
"type" : "string"
}
}
},
"DialogNodeOutputText" : {
"type" : "object",
"properties" : {
"values" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"selectionPolicy" : {
"type" : "string",
"enum" : [ "SEQUENTIAL", "RANDOM", "MULTILINE" ]
}
}
},
"DialogNodeResponse" : {
"type" : "object",
"properties" : {
"condition" : {
"type" : "string"
},
"text" : {
"$ref" : "#/definitions/DialogNodeOutputText"
},
"action" : {
"$ref" : "#/definitions/DialogNodeChatAction"
},
"context" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
}
},
"DialogNodeSlot" : {
"type" : "object",
"properties" : {
"slotId" : {
"type" : "string"
},
"condition" : {
"type" : "string"
},
"saveAsVariable" : {
"type" : "string"
},
"prompt" : {
"type" : "string"
},
"isRequired" : {
"type" : "boolean",
"default" : false
},
"promptOptions" : {
"$ref" : "#/definitions/PromptOptions"
},
"context" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
},
"subContext" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
},
"responseType" : {
"type" : "string"
},
"slotVisibilityCondition" : {
"$ref" : "#/definitions/SlotVisibilityCondition"
},
"slotHandlers" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/DialogNodeSlotHandler"
}
},
"integerFieldSlot" : {
"$ref" : "#/definitions/IntegerFieldSlot"
},
"defaultCatalogAnswer" : {
"$ref" : "#/definitions/ChatDefaultValue"
},
"defaultChatAnswer" : {
"$ref" : "#/definitions/ChatDefaultValue"
},
"doesNeedDefaultValueConfirmation" : {
"type" : "boolean",
"default" : false
},
"dependentSlots" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "string"
}
},
"confirmationText" : {
"type" : "string"
},
"visibleCondition" : {
"type" : "string"
},
"responses" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/DialogNodeResponse"
}
},
"doesIncludeQuestion" : {
"type" : "boolean",
"default" : false
},
"doesDisplayPromptOptions" : {
"type" : "boolean",
"default" : false
},
"visibilityConditionText" : {
"type" : "string"
},
"dateConditionText" : {
"type" : "string"
},
"doesIncludeToSummary" : {
"type" : "boolean",
"default" : false
}
}
},
"DialogNodeSlotHandler" : {
"type" : "object",
"properties" : {
"condition" : {
"type" : "string"
},
"responses" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/DialogNodeResponse"
}
},
"nextStep" : {
"$ref" : "#/definitions/DialogNodeNextStep"
},
"context" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
},
"isFoundHandler" : {
"type" : "boolean",
"default" : false
}
}
},
"DocumentDefinition" : {
"type" : "object",
"properties" : {
"version" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "string",
"format" : "date-time"
},
"lastChangedBy" : {
"type" : "string"
},
"owner" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"description" : {
"type" : "string"
},
"overlayGroupId" : {
"type" : "string"
},
"scope" : {
"type" : "string",
"enum" : [ "PUBLIC", "BUNDLE", "PLATFORM_ONLY", "SERVICE_ONLY" ]
},
"internal" : {
"type" : "boolean",
"default" : false
},
"guid" : {
"type" : "string"
},
"allowOverlay" : {
"type" : "boolean",
"default" : false
},
"overlayDescriptor" : {
"$ref" : "#/definitions/DocumentDefinitionOverlayDescriptor"
},
"documentSchema" : {
"type" : "string"
}
}
},
"DocumentDefinitionOverlayDescriptor" : {
"type" : "object",
"properties" : {
"parentOverlayGroupId" : {
"type" : "string"
}
}
},
"EntityDefinition" : {
"type" : "object",
"properties" : {
"version" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "string",
"format" : "date-time"
},
"lastChangedBy" : {
"type" : "string"
},
"owner" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"description" : {
"type" : "string"
},
"overlayGroupId" : {
"type" : "string"
},
"scope" : {
"type" : "string",
"enum" : [ "PUBLIC", "BUNDLE", "PLATFORM_ONLY", "SERVICE_ONLY" ]
},
"internal" : {
"type" : "boolean",
"default" : false
},
"guid" : {
"type" : "string"
},
"values" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/EntityValue"
}
},
"type" : {
"type" : "string"
},
"isDynamicField" : {
"type" : "boolean",
"default" : false
}
}
},
"EntityMention" : {
"type" : "object",
"properties" : {
"entity" : {
"type" : "string"
},
"location" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int64"
}
}
}
},
"EntityValue" : {
"type" : "object",
"properties" : {
"alternativeType" : {
"type" : "string",
"enum" : [ "SYNONYMS", "PATTERNS" ]
},
"value" : {
"type" : "string"
},
"label" : {
"type" : "string"
},
"alternativeValues" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"EventAttributeDefinition" : {
"type" : "object",
"properties" : {
"guid" : {
"type" : "string"
},
"dataType" : {
"type" : "string",
"enum" : [ "INTEGER", "TEXT", "DATETIME", "DECIMAL", "BOOLEAN" ]
},
"isRequired" : {
"type" : "boolean",
"default" : false
},
"defaultValue" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
}
}
},
"EventDefinition" : {
"type" : "object",
"properties" : {
"version" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "string",
"format" : "date-time"
},
"lastChangedBy" : {
"type" : "string"
},
"owner" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"description" : {
"type" : "string"
},
"overlayGroupId" : {
"type" : "string"
},
"scope" : {
"type" : "string",
"enum" : [ "PUBLIC", "BUNDLE", "PLATFORM_ONLY", "SERVICE_ONLY" ]
},
"internal" : {
"type" : "boolean",
"default" : false
},
"guid" : {
"type" : "string"
},
"allowOverlay" : {
"type" : "boolean",
"default" : false
},
"isEnabled" : {
"type" : "boolean",
"default" : false
},
"overlayDescriptor" : {
"$ref" : "#/definitions/EventDefinitionOverlayDescriptor"
},
"eventAttributes" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/EventAttributeDefinition"
}
}
}
},
"EventDefinitionOverlayDescriptor" : {
"type" : "object",
"properties" : {
"parentOverlayGroupId" : {
"type" : "string"
}
}
},
"EventStatisticsDefinition" : {
"type" : "object",
"properties" : {
"version" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "string",
"format" : "date-time"
},
"lastChangedBy" : {
"type" : "string"
},
"owner" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"description" : {
"type" : "string"
},
"overlayGroupId" : {
"type" : "string"
},
"scope" : {
"type" : "string",
"enum" : [ "PUBLIC", "BUNDLE", "PLATFORM_ONLY", "SERVICE_ONLY" ]
},
"internal" : {
"type" : "boolean",
"default" : false
},
"guid" : {
"type" : "string"
},
"allowOverlay" : {
"type" : "boolean",
"default" : false
},
"isEnabled" : {
"type" : "boolean",
"default" : false
},
"eventName" : {
"type" : "string"
},
"groupByKeys" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"eventStatisticsOperations" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/EventStatisticsOperation"
}
},
"frequencies" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "YEARLY" ]
}
},
"shouldGetCount" : {
"type" : "boolean",
"default" : false
},
"overlayDescriptor" : {
"$ref" : "#/definitions/EventStatisticsDefinitionOverlayDescriptor"
}
}
},
"EventStatisticsDefinitionOverlayDescriptor" : {
"type" : "object",
"properties" : {
"parentOverlayGroupId" : {
"type" : "string"
}
}
},
"EventStatisticsOperation" : {
"type" : "object",
"properties" : {
"guid" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"operations" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "AVG", "MIN", "MAX", "SUM" ]
}
},
"operandExpression" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"FieldDefinitionOverlayDescriptor" : {
"type" : "object",
"properties" : {
"parentOverlayGroupId" : {
"type" : "string"
},
"permissionsOverlayType" : {
"type" : "string",
"enum" : [ "UNMODIFIED", "OVERWRITE", "ADDITIVE" ]
},
"otherPropertiesOverlayType" : {
"type" : "string",
"enum" : [ "UNMODIFIED", "OVERWRITE", "ADDITIVE" ]
}
}
},
"FieldDefinitionPermission" : {
"type" : "object",
"properties" : {
"ownerId" : {
"$ref" : "#/definitions/PermissionOwnerId"
},
"type" : {
"type" : "string",
"enum" : [ "VIEW", "CHANGE" ]
}
}
},
"FieldDefinitionStorageType" : {
"type" : "object",
"properties" : {
"lastUpdateTime" : {
"type" : "string",
"format" : "date-time"
},
"lastChangedBy" : {
"type" : "string"
},
"owner" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"description" : {
"type" : "string"
},
"overlayGroupId" : {
"type" : "string"
},
"internal" : {
"type" : "boolean",
"default" : false
},
"id" : {
"type" : "integer",
"format" : "int32"
},
"fieldOption" : {
"type" : "string",
"enum" : [ "REQUIRED", "OPTIONAL", "SYSTEM" ]
},
"permissions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/FieldDefinitionPermission"
}
},
"fieldTypeName" : {
"type" : "string"
},
"isInherited" : {
"type" : "boolean",
"default" : false
},
"explicitPermissions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/FieldDefinitionPermission"
}
},
"overlayDescriptor" : {
"$ref" : "#/definitions/FieldDefinitionOverlayDescriptor"
},
"fieldMapping" : {
"$ref" : "#/definitions/RecordDefinitionFieldMapping"
},
"allowPermissionsOverlay" : {
"type" : "boolean",
"default" : false
},
"allowOtherPropertiesOverlay" : {
"type" : "boolean",
"default" : false
},
"auditOption" : {
"type" : "string",
"enum" : [ "NONE", "AUDIT", "COPY", "AUDIT_AND_COPY" ]
},
"allowPermissionsEdit" : {
"type" : "boolean",
"default" : false
},
"anyUserAllowedToSubmit" : {
"type" : "boolean",
"default" : false
},
"identityField" : {
"type" : "boolean",
"default" : false
}
}
},
"FieldDescriptor" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32"
},
"searchable" : {
"type" : "boolean",
"default" : false
},
"visible" : {
"type" : "boolean",
"default" : false
}
}
},
"FieldInstance" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32"
},
"value" : {
"type" : "string"
},
"permissionType" : {
"type" : "string"
}
}
},
"FormDataBodyPart" : {
"type" : "object",
"properties" : {
"contentDisposition" : {
"$ref" : "#/definitions/ContentDisposition"
},
"entity" : {
"type" : "object"
},
"headers" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"mediaType" : {
"$ref" : "#/definitions/MediaType"
},
"messageBodyWorkers" : {
"$ref" : "#/definitions/MessageBodyWorkers"
},
"parent" : {
"$ref" : "#/definitions/MultiPart"
},
"providers" : {
"$ref" : "#/definitions/Providers"
},
"name" : {
"type" : "string"
},
"value" : {
"type" : "string"
},
"formDataContentDisposition" : {
"$ref" : "#/definitions/FormDataContentDisposition"
},
"simple" : {
"type" : "boolean",
"default" : false
},
"parameterizedHeaders" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ParameterizedHeader"
}
}
}
}
},
"FormDataContentDisposition" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string"
},
"parameters" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"fileName" : {
"type" : "string"
},
"creationDate" : {
"type" : "string",
"format" : "date-time"
},
"modificationDate" : {
"type" : "string",
"format" : "date-time"
},
"readDate" : {
"type" : "string",
"format" : "date-time"
},
"size" : {
"type" : "integer",
"format" : "int64"
},
"name" : {
"type" : "string"
}
}
},
"FormDataMultiPart" : {
"type" : "object",
"properties" : {
"contentDisposition" : {
"$ref" : "#/definitions/ContentDisposition"
},
"entity" : {
"type" : "object"
},
"headers" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"mediaType" : {
"$ref" : "#/definitions/MediaType"
},
"messageBodyWorkers" : {
"$ref" : "#/definitions/MessageBodyWorkers"
},
"parent" : {
"$ref" : "#/definitions/MultiPart"
},
"providers" : {
"$ref" : "#/definitions/Providers"
},
"bodyParts" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/BodyPart"
}
},
"fields" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/FormDataBodyPart"
}
}
},
"parameterizedHeaders" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ParameterizedHeader"
}
}
}
}
},
"FunctionalRole" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"applicationName" : {
"type" : "string"
},
"applicationRoles" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"createDate" : {
"type" : "string",
"format" : "date-time"
},
"modifiedDate" : {
"type" : "string",
"format" : "date-time"
}
}
},
"Group" : {
"type" : "object",
"properties" : {
"groupName" : {
"type" : "string"
},
"groupId" : {
"type" : "integer",
"format" : "int32"
},
"longGroupName" : {
"type" : "string"
},
"groupType" : {
"type" : "string"
},
"parentGroup" : {
"type" : "string"
},
"status" : {
"type" : "string"
},
"comments" : {
"type" : "string"
},
"createdBy" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"permittedGroupsBySecurityLabels" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"permittedUsersBySecurityLabels" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"floatingLicenses" : {
"type" : "integer",
"format" : "int32"
},
"applicationFloatingLicenses" : {
"type" : "string"
}
}
},
"HelixGPTMessageInfo" : {
"type" : "object",
"properties" : {
"role" : {
"type" : "string"
},
"content" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"references" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Reference"
}
},
"validation" : {
"$ref" : "#/definitions/Validation"
}
}
},
"HelixGPTMessageRequest" : {
"type" : "object",
"required" : [ "id", "message", "skill_id", "user" ],
"properties" : {
"debug" : {
"type" : "boolean",
"default" : false
},
"skill_id" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"message" : {
"$ref" : "#/definitions/HelixGPTMessageInfo"
},
"user" : {
"$ref" : "#/definitions/UserInfo"
},
"is_debug" : {
"type" : "boolean",
"default" : false
},
"debug_data" : {
"type" : "string"
},
"debug_level" : {
"type" : "string"
},
"variables" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
},
"state_info" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
}
},
"InputDescriptor" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "STRING", "INTEGER", "DATE", "TIME", "DATETIME", "DOUBLE", "BOOLEAN", "OBJECT" ]
},
"name" : {
"type" : "string"
},
"required" : {
"type" : "boolean",
"default" : false
},
"localizable" : {
"type" : "boolean",
"default" : false
}
}
},
"InputStream" : {
"type" : "object"
},
"IntegerFieldSlot" : {
"type" : "object",
"properties" : {
"minValue" : {
"type" : "integer",
"format" : "int32"
},
"maxValue" : {
"type" : "integer",
"format" : "int32"
},
"stepValue" : {
"type" : "integer",
"format" : "int32"
}
}
},
"IntentDefinition" : {
"type" : "object",
"properties" : {
"version" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "string",
"format" : "date-time"
},
"lastChangedBy" : {
"type" : "string"
},
"owner" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"description" : {
"type" : "string"
},
"overlayGroupId" : {
"type" : "string"
},
"scope" : {
"type" : "string",
"enum" : [ "PUBLIC", "BUNDLE", "PLATFORM_ONLY", "SERVICE_ONLY" ]
},
"internal" : {
"type" : "boolean",
"default" : false
},
"guid" : {
"type" : "string"
},
"examples" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/IntentExample"
}
}
}
},
"IntentExample" : {
"type" : "object",
"properties" : {
"text" : {
"type" : "string"
},
"mentions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/EntityMention"
}
}
}
},
"JsonNode" : {
"type" : "object",
"properties" : {
"array" : {
"type" : "boolean",
"default" : false
},
"null" : {
"type" : "boolean",
"default" : false
},
"float" : {
"type" : "boolean",
"default" : false
},
"nodeType" : {
"type" : "string",
"enum" : [ "ARRAY", "BINARY", "BOOLEAN", "MISSING", "NULL", "NUMBER", "OBJECT", "POJO", "STRING" ]
},
"number" : {
"type" : "boolean",
"default" : false
},
"short" : {
"type" : "boolean",
"default" : false
},
"containerNode" : {
"type" : "boolean",
"default" : false
},
"long" : {
"type" : "boolean",
"default" : false
},
"integralNumber" : {
"type" : "boolean",
"default" : false
},
"pojo" : {
"type" : "boolean",
"default" : false
},
"double" : {
"type" : "boolean",
"default" : false
},
"object" : {
"type" : "boolean",
"default" : false
},
"valueNode" : {
"type" : "boolean",
"default" : false
},
"int" : {
"type" : "boolean",
"default" : false
},
"missingNode" : {
"type" : "boolean",
"default" : false
},
"boolean" : {
"type" : "boolean",
"default" : false
},
"textual" : {
"type" : "boolean",
"default" : false
},
"binary" : {
"type" : "boolean",
"default" : false
},
"bigInteger" : {
"type" : "boolean",
"default" : false
},
"bigDecimal" : {
"type" : "boolean",
"default" : false
},
"floatingPointNumber" : {
"type" : "boolean",
"default" : false
}
}
},
"LabelValuePair" : {
"type" : "object",
"properties" : {
"label" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
},
"LicenseUsage" : {
"type" : "object",
"properties" : {
"operation" : {
"type" : "string"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"licenseUsageCount" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/LicenseUsageCount"
}
}
}
},
"LicenseUsageCount" : {
"type" : "object",
"properties" : {
"bundleId" : {
"type" : "string"
},
"countType" : {
"type" : "string",
"enum" : [ "BY_MONTH" ]
},
"count" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer",
"format" : "int64"
}
},
"capacity" : {
"type" : "integer",
"format" : "int64"
},
"total" : {
"type" : "integer",
"format" : "int64"
}
}
},
"LogFiles" : {
"type" : "object",
"properties" : {
"fileNames" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "string"
}
}
}
},
"LoginRequest" : {
"type" : "object",
"properties" : {
"userName" : {
"type" : "string"
},
"password" : {
"type" : "string"
},
"authString" : {
"type" : "string"
},
"impersonatedUser" : {
"type" : "string"
},
"locale" : {
"type" : "string"
}
}
},
"MediaType" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string"
},
"subtype" : {
"type" : "string"
},
"parameters" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"wildcardType" : {
"type" : "boolean",
"default" : false
},
"wildcardSubtype" : {
"type" : "boolean",
"default" : false
}
}
},
"MessageBodyWorkers" : {
"type" : "object"
},
"MultiPart" : {
"type" : "object",
"properties" : {
"contentDisposition" : {
"$ref" : "#/definitions/ContentDisposition"
},
"entity" : {
"type" : "object"
},
"headers" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"mediaType" : {
"$ref" : "#/definitions/MediaType"
},
"messageBodyWorkers" : {
"$ref" : "#/definitions/MessageBodyWorkers"
},
"parent" : {
"$ref" : "#/definitions/MultiPart"
},
"providers" : {
"$ref" : "#/definitions/Providers"
},
"bodyParts" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/BodyPart"
}
},
"parameterizedHeaders" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ParameterizedHeader"
}
}
}
}
},
"NamedListDefinition" : {
"type" : "object",
"required" : [ "labelFieldId", "valueFieldId" ],
"properties" : {
"version" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "string",
"format" : "date-time"
},
"lastChangedBy" : {
"type" : "string"
},
"owner" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"description" : {
"type" : "string"
},
"overlayGroupId" : {
"type" : "string"
},
"scope" : {
"type" : "string",
"enum" : [ "PUBLIC", "BUNDLE", "PLATFORM_ONLY", "SERVICE_ONLY" ]
},
"internal" : {
"type" : "boolean",
"default" : false
},
"guid" : {
"type" : "string"
},
"recordDefinitionName" : {
"type" : "string"
},
"queryCriteria" : {
"type" : "string"
},
"qualificationFields" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "integer",
"format" : "int32"
}
},
"qualificationKeywords" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "string"
}
},
"labelFieldId" : {
"type" : "integer",
"format" : "int32"
},
"valueFieldId" : {
"type" : "integer",
"format" : "int32"
},
"fields" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/FieldDescriptor"
}
},
"shouldSortOnLabel" : {
"type" : "boolean",
"default" : false
},
"overlayDescriptor" : {
"$ref" : "#/definitions/NamedListDefinitionOverlayDescriptor"
},
"allowOverlay" : {
"type" : "boolean",
"default" : false
},
"searchBehavior" : {
"type" : "string"
}
}
},
"NamedListDefinitionOverlayDescriptor" : {
"type" : "object",
"properties" : {
"parentOverlayGroupId" : {
"type" : "string"
}
}
},
"NotificationConfiguration" : {
"type" : "object",
"properties" : {
"domain" : {
"type" : "string"
},
"action" : {
"type" : "string"
},
"capacity" : {
"type" : "integer",
"format" : "int32"
},
"thresholds" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "integer",
"format" : "int32"
}
},
"emailIds" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"period" : {
"type" : "string",
"enum" : [ "UNLIMITED", "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "HALFYEARLY", "YEARLY" ]
},
"operation" : {
"type" : "string",
"enum" : [ "COUNT", "DISTINCT" ]
},
"eventStatisticsGuid" : {
"type" : "string"
},
"disabled" : {
"type" : "boolean",
"default" : false
}
}
},
"OptionsText" : {
"type" : "object",
"properties" : {
"options" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/LabelValuePair"
}
}
}
},
"OutputDescriptor" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "STRING", "INTEGER", "DATE", "TIME", "DATETIME", "DOUBLE", "BOOLEAN", "OBJECT" ]
},
"name" : {
"type" : "string"
}
}
},
"PackageDescriptor" : {
"type" : "object",
"properties" : {
"packageBytes" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "byte"
}
},
"version" : {
"type" : "string"
},
"packageName" : {
"type" : "string"
},
"packageType" : {
"type" : "string",
"enum" : [ "INSTALL", "UPDATE", "EXPORT", "CONTENT" ]
},
"updateFromVersion" : {
"type" : "string"
},
"customPackageName" : {
"type" : "string"
}
}
},
"ParameterizedHeader" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "string"
},
"parameters" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
}
},
"PeoplePermissions" : {
"type" : "object",
"properties" : {
"loginName" : {
"type" : "string"
},
"personas" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"bundles" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"Permission" : {
"type" : "object",
"properties" : {
"ownerId" : {
"$ref" : "#/definitions/PermissionDetail"
},
"type" : {
"type" : "string"
}
}
},
"PermissionDetail" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "integer",
"format" : "int32"
},
"type" : {
"type" : "string"
},
"roleApplicationName" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"PermissionOwnerId" : {
"type" : "object",
"required" : [ "type" ],
"properties" : {
"value" : {
"type" : "integer",
"format" : "int32"
},
"type" : {
"type" : "string",
"enum" : [ "GROUP", "ROLE", "USER" ]
},
"name" : {
"type" : "string"
}
}
},
"PiiIgnoreRecordInfo" : {
"type" : "object",
"properties" : {
"checkedIds" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "string"
}
},
"uncheckedIds" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "string"
}
}
}
},
"PiiInfo" : {
"type" : "object",
"properties" : {
"operationType" : {
"type" : "string",
"enum" : [ "SEARCH", "FORGET" ]
},
"jobId" : {
"type" : "string"
},
"status" : {
"type" : "string",
"enum" : [ "CREATED", "INPROGRESS", "SEARCH_COMPLETED", "FORGET_INPROGRESS", "FORGET_COMPLETED", "FORGET_COMPLETED_WITH_ERROR", "SEARCH_FAILURE", "FORGET_FAILURE", "RUNNING" ]
},
"label" : {
"type" : "string"
},
"piiString" : {
"type" : "string"
},
"replaceString" : {
"type" : "string"
}
}
},
"PiiJobInfo" : {
"type" : "object",
"properties" : {
"jobType" : {
"type" : "string",
"enum" : [ "SEARCH", "FORGET" ]
},
"jobId" : {
"type" : "string"
},
"submitter" : {
"type" : "string"
},
"comments" : {
"type" : "string"
},
"status" : {
"type" : "string",
"enum" : [ "CREATED", "INPROGRESS", "SEARCH_COMPLETED", "FORGET_INPROGRESS", "FORGET_COMPLETED", "FORGET_COMPLETED_WITH_ERROR", "SEARCH_FAILURE", "FORGET_FAILURE", "RUNNING" ]
},
"createdTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"modifiedTimestamp" : {
"type" : "integer",
"format" : "int64"
},
"approveForgetFlag" : {
"type" : "boolean",
"default" : false
},
"piiInfos" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"$ref" : "#/definitions/PiiInfo"
}
},
"formsToInclude" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "string"
}
},
"formsToExclude" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "string"
}
}
}
},
"PiiJobOperationAction" : {
"type" : "object",
"properties" : {
"action" : {
"type" : "string",
"enum" : [ "FORGET" ]
}
}
},
"PinRequest" : {
"type" : "object",
"properties" : {
"recordDefinitionName" : {
"type" : "string"
},
"fieldId" : {
"type" : "integer",
"format" : "int32"
},
"recordId" : {
"type" : "string"
},
"pin" : {
"type" : "string"
}
}
},
"ProcessActivityInstance" : {
"type" : "object",
"properties" : {
"activityId" : {
"type" : "string"
},
"startTime" : {
"type" : "string",
"format" : "date-time"
},
"endTime" : {
"type" : "string",
"format" : "date-time"
},
"activities" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ProcessActivityInstance"
}
},
"executionId" : {
"type" : "string"
}
}
},
"ProcessDefinition" : {
"type" : "object",
"properties" : {
"version" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "string",
"format" : "date-time"
},
"lastChangedBy" : {
"type" : "string"
},
"owner" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"description" : {
"type" : "string"
},
"overlayGroupId" : {
"type" : "string"
},
"scope" : {
"type" : "string",
"enum" : [ "PUBLIC", "BUNDLE", "PLATFORM_ONLY", "SERVICE_ONLY" ]
},
"internal" : {
"type" : "boolean",
"default" : false
},
"guid" : {
"type" : "string"
},
"flowElements" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ProcessFlowElementDefinition"
}
},
"inputParams" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/FieldDefinitionStorageType"
}
},
"outputParams" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/FieldDefinitionStorageType"
}
},
"localVariables" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/FieldDefinitionStorageType"
}
},
"contextKeyParam" : {
"type" : "string"
},
"isEnabled" : {
"type" : "boolean",
"default" : false
},
"permissions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ProcessDefinitionPermission"
}
},
"layout" : {
"type" : "string"
},
"artifacts" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Artifact"
}
},
"runAsUser" : {
"type" : "boolean",
"default" : false
},
"synchronous" : {
"type" : "boolean",
"default" : false
},
"overlayDescriptor" : {
"$ref" : "#/definitions/ProcessDefinitionOverlayDescriptor"
},
"allowOverlay" : {
"type" : "boolean",
"default" : false
},
"localizableStrings" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
}
},
"ProcessDefinitionOverlayDescriptor" : {
"type" : "object",
"properties" : {
"parentOverlayGroupId" : {
"type" : "string"
},
"permissionsOverlayType" : {
"type" : "string",
"enum" : [ "UNMODIFIED", "OVERWRITE", "ADDITIVE" ]
},
"otherPropertiesOverlayType" : {
"type" : "string",
"enum" : [ "UNMODIFIED", "OVERWRITE", "ADDITIVE" ]
}
}
},
"ProcessDefinitionPermission" : {
"type" : "object",
"required" : [ "ownerId", "type" ],
"properties" : {
"ownerId" : {
"$ref" : "#/definitions/PermissionOwnerId"
},
"type" : {
"type" : "string",
"enum" : [ "EXECUTE", "READ" ]
}
}
},
"ProcessFlowElementDefinition" : {
"type" : "object",
"properties" : {
"lastUpdateTime" : {
"type" : "string",
"format" : "date-time"
},
"lastChangedBy" : {
"type" : "string"
},
"owner" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"description" : {
"type" : "string"
},
"overlayGroupId" : {
"type" : "string"
},
"internal" : {
"type" : "boolean",
"default" : false
},
"guid" : {
"type" : "string"
}
}
},
"ProcessInstance" : {
"type" : "object",
"properties" : {
"processDefinitionName" : {
"type" : "string"
},
"processDefinitionId" : {
"type" : "string"
},
"processDefinitionVersion" : {
"type" : "string"
},
"processDefinitionOverlayGroup" : {
"type" : "string"
},
"instanceId" : {
"type" : "string"
},
"parentInstanceId" : {
"type" : "string"
},
"contextId" : {
"type" : "string"
},
"contextKey" : {
"type" : "string"
},
"owner" : {
"type" : "string"
},
"status" : {
"type" : "string",
"enum" : [ "ACTIVE", "SUSPENDED", "ERRORED", "COMPLETED" ]
},
"startTime" : {
"type" : "string",
"format" : "date-time"
},
"endTime" : {
"type" : "string",
"format" : "date-time"
},
"exceptionMessage" : {
"type" : "string"
},
"cancelReason" : {
"type" : "string"
},
"processVariables" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"activities" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ProcessActivityInstance"
}
},
"isStartInstanceError" : {
"type" : "boolean",
"default" : false
}
}
},
"ProcessInstanceLog" : {
"type" : "object",
"properties" : {
"processDefinitionName" : {
"type" : "string"
},
"instanceId" : {
"type" : "string"
},
"logContent" : {
"type" : "string"
}
}
},
"PromptOptions" : {
"type" : "object",
"properties" : {
"optionSource" : {
"type" : "string",
"enum" : [ "ENTITIES", "CUSTOM" ]
},
"entities" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"labelValuePairs" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/LabelValuePair"
}
}
}
},
"Providers" : {
"type" : "object"
},
"QualificationExpression" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"expression" : {
"type" : "string"
}
}
},
"RecordDefinition" : {
"type" : "object",
"properties" : {
"version" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "string",
"format" : "date-time"
},
"lastChangedBy" : {
"type" : "string"
},
"owner" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"description" : {
"type" : "string"
},
"overlayGroupId" : {
"type" : "string"
},
"scope" : {
"type" : "string",
"enum" : [ "PUBLIC", "BUNDLE", "PLATFORM_ONLY", "SERVICE_ONLY" ]
},
"internal" : {
"type" : "boolean",
"default" : false
},
"guid" : {
"type" : "string"
},
"fieldDefinitions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/FieldDefinitionStorageType"
}
},
"recordInstancePrefix" : {
"type" : "string"
},
"permissions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/RecordDefinitionPermission"
}
},
"securityLabels" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/SecurityLabel"
}
},
"rowSecurityPropagations" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"recordTypeName" : {
"type" : "string"
},
"weightedRelevancyFields" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer",
"format" : "int32"
}
},
"shouldExportData" : {
"type" : "boolean",
"default" : false
},
"fullPermissions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/RecordDefinitionPermission"
}
},
"overlayDescriptor" : {
"$ref" : "#/definitions/RecordDefinitionOverlayDescriptor"
},
"allowPermissionsOverlay" : {
"type" : "boolean",
"default" : false
},
"allowOtherPropertiesOverlay" : {
"type" : "boolean",
"default" : false
},
"allowIndexesOverlay" : {
"type" : "boolean",
"default" : false
},
"allowFieldsOverlay" : {
"type" : "boolean",
"default" : false
},
"allowNonAdminToDeleteRecordInstances" : {
"type" : "boolean",
"default" : false
},
"auditSourceRecordDefinitionName" : {
"type" : "string"
},
"auditDescriptor" : {
"$ref" : "#/definitions/RecordDefinitionAuditDescriptor"
},
"isAuditRecordDefinition" : {
"type" : "boolean",
"default" : false
},
"archiveSourceRecordDefinitionName" : {
"type" : "string"
},
"archiveDescriptor" : {
"$ref" : "#/definitions/RecordDefinitionArchiveDescriptor"
},
"associationsToFollowForArchive" : {
"$ref" : "#/definitions/RecordDefinitionAssociationsToFollow"
},
"enableCognitiveSearch" : {
"type" : "boolean",
"default" : false
},
"localizableStringsByFieldId" : {
"type" : "object",
"additionalProperties" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
},
"upgradeVersion" : {
"type" : "integer",
"format" : "int32"
},
"displayFieldIdInAssociation" : {
"type" : "integer",
"format" : "int32"
},
"globalScope" : {
"type" : "boolean",
"default" : false
},
"sortInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/RxSortInfo"
}
},
"confidentialDataDescriptor" : {
"$ref" : "#/definitions/ConfidentialDataDescriptor"
},
"rlsAlgorithm" : {
"type" : "integer",
"format" : "int32"
}
}
},
"RecordDefinitionArchiveDescriptor" : {
"type" : "object",
"properties" : {
"ageQualifierFieldId" : {
"type" : "integer",
"format" : "int32"
},
"ageQualifierInDays" : {
"type" : "integer",
"format" : "int32"
},
"archiveRecordDefinitionName" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"archiveType" : {
"type" : "string",
"enum" : [ "NONE", "DELETE_FROM_SOURCE", "COPY_TO_ARCHIVE_AND_DELETE_FROM_SOURCE", "ALL" ]
},
"includeAttachments" : {
"type" : "boolean",
"default" : false
},
"archiveDataCriteria" : {
"type" : "string"
},
"isEnabled" : {
"type" : "boolean",
"default" : false
}
}
},
"RecordDefinitionAssociationsToFollow" : {
"type" : "object",
"properties" : {
"selectionType" : {
"type" : "string",
"enum" : [ "FOLLOW_PARENT", "SPECIFIC_ONLY", "ALL_ENFORCED", "ALL" ]
},
"specificAssociationNames" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "string"
}
}
}
},
"RecordDefinitionAuditDescriptor" : {
"type" : "object",
"properties" : {
"auditRecordDefinitionName" : {
"type" : "string"
},
"auditDataCriteria" : {
"type" : "string"
},
"isEnabled" : {
"type" : "boolean",
"default" : false
},
"associatedAuditFieldsByAssociationName" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"$ref" : "#/definitions/AssociatedAuditField"
}
}
}
}
},
"RecordDefinitionFieldMapping" : {
"type" : "object"
},
"RecordDefinitionOverlayDescriptor" : {
"type" : "object",
"properties" : {
"parentOverlayGroupId" : {
"type" : "string"
},
"permissionsOverlayType" : {
"type" : "string",
"enum" : [ "UNMODIFIED", "OVERWRITE", "ADDITIVE" ]
},
"otherPropertiesOverlayType" : {
"type" : "string",
"enum" : [ "UNMODIFIED", "OVERWRITE", "ADDITIVE" ]
},
"indexesOverlayType" : {
"type" : "string",
"enum" : [ "UNMODIFIED", "OVERWRITE", "ADDITIVE" ]
}
}
},
"RecordDefinitionPermission" : {
"type" : "object",
"properties" : {
"ownerId" : {
"$ref" : "#/definitions/PermissionOwnerId"
},
"type" : {
"type" : "string",
"enum" : [ "VISIBLE", "HIDDEN" ]
}
}
},
"RecordInstance" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"displayId" : {
"type" : "string"
},
"recordDefinitionName" : {
"type" : "string"
},
"permittedGroupsBySecurityLabels" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"permittedUsersBySecurityLabels" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"permittedRolesBySecurityLabels" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"fieldInstances" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/FieldInstance"
}
}
}
},
"Reference" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"datasource" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"web_url" : {
"type" : "string"
}
}
},
"RemoteServer" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"username" : {
"type" : "string"
},
"password" : {
"type" : "string"
},
"baseUrl" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"trustAllSSLKeys" : {
"type" : "boolean",
"default" : false
},
"status" : {
"$ref" : "#/definitions/RemoteServerStatusDescriptor"
}
}
},
"RemoteServerStatusDescriptor" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "integer",
"format" : "int32"
},
"statusMessage" : {
"type" : "string"
}
}
},
"Role" : {
"type" : "object",
"properties" : {
"applicationName" : {
"type" : "string"
},
"roleName" : {
"type" : "string"
},
"roleID" : {
"type" : "integer",
"format" : "int32"
},
"test" : {
"type" : "string"
},
"production" : {
"type" : "string"
},
"datatag" : {
"type" : "string"
}
}
},
"RuleAction" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
}
}
},
"RuleDefinition" : {
"type" : "object",
"required" : [ "triggerEvent" ],
"properties" : {
"version" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "string",
"format" : "date-time"
},
"lastChangedBy" : {
"type" : "string"
},
"owner" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"description" : {
"type" : "string"
},
"overlayGroupId" : {
"type" : "string"
},
"scope" : {
"type" : "string",
"enum" : [ "PUBLIC", "BUNDLE", "PLATFORM_ONLY", "SERVICE_ONLY" ]
},
"internal" : {
"type" : "boolean",
"default" : false
},
"guid" : {
"type" : "string"
},
"triggerEvent" : {
"$ref" : "#/definitions/TriggerEvent"
},
"isEnabled" : {
"type" : "boolean",
"default" : false
},
"recordDefinitionNames" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"qualification" : {
"$ref" : "#/definitions/QualificationExpression"
},
"actions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/RuleAction"
}
},
"overlayDescriptor" : {
"$ref" : "#/definitions/RuleDefinitionOverlayDescriptor"
},
"allowOverlay" : {
"type" : "boolean",
"default" : false
},
"localizableStrings" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"numberOfAvailablePools" : {
"type" : "integer",
"format" : "int32"
},
"saaSAdminOnly" : {
"type" : "boolean",
"default" : false
}
}
},
"RuleDefinitionOverlayDescriptor" : {
"type" : "object",
"properties" : {
"parentOverlayGroupId" : {
"type" : "string"
},
"permissionsOverlayType" : {
"type" : "string",
"enum" : [ "UNMODIFIED", "OVERWRITE", "ADDITIVE" ]
},
"otherPropertiesOverlayType" : {
"type" : "string",
"enum" : [ "UNMODIFIED", "OVERWRITE", "ADDITIVE" ]
}
}
},
"RxSortInfo" : {
"type" : "object",
"properties" : {
"sortOrder" : {
"type" : "string",
"enum" : [ "ASCENDING", "DESCENDING" ]
},
"fieldId" : {
"type" : "integer",
"format" : "int32"
},
"addToSelectList" : {
"type" : "boolean",
"default" : false
}
}
},
"SecurityLabel" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"id" : {
"type" : "integer",
"format" : "int32"
},
"parent" : {
"type" : "string"
},
"child" : {
"type" : "string"
},
"securityLabelMapping" : {
"$ref" : "#/definitions/SecurityLabelMapping"
},
"inherited" : {
"type" : "boolean",
"default" : false
}
}
},
"SecurityLabelMapping" : {
"type" : "object"
},
"ServerLogSetting" : {
"type" : "object",
"properties" : {
"processLogOn" : {
"type" : "boolean",
"default" : false
},
"ruleLogOn" : {
"type" : "boolean",
"default" : false
},
"timedRuleLogOn" : {
"type" : "boolean",
"default" : false
},
"sqlLogOn" : {
"type" : "boolean",
"default" : false
},
"apiLogOn" : {
"type" : "boolean",
"default" : false
},
"autoTurnOffDuration" : {
"type" : "integer",
"format" : "int32"
}
}
},
"ServiceLicenseDescriptor" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"services" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "CHAT", "SUMMARIZATION", "TONE_ANALYZER", "CLASSIFICATION", "SEARCH", "SEARCH_DOCUMENT_USAGE", "TRANSLATION" ]
}
},
"licensed" : {
"type" : "boolean",
"default" : false
}
}
},
"SettingControlMetaData" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"label" : {
"type" : "string"
},
"dataType" : {
"type" : "string"
},
"minValue" : {
"type" : "string"
},
"maxValue" : {
"type" : "string"
},
"defaultValue" : {
"type" : "string"
},
"options" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"optionNamesById" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"optionLabelsById" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"required" : {
"type" : "boolean",
"default" : false
},
"fieldOrder" : {
"type" : "integer",
"format" : "int32"
},
"keySetting" : {
"type" : "boolean",
"default" : false
},
"localeList" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AdminComponentSettingLocale"
}
},
"changePermission" : {
"type" : "boolean",
"default" : false
},
"permissions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Permission"
}
}
}
},
"SettingGroup" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"label" : {
"type" : "string"
},
"supportsMultiple" : {
"type" : "boolean",
"default" : false
},
"controls" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/SettingControlMetaData"
}
},
"component" : {
"type" : "boolean",
"default" : false
}
}
},
"SharedViewPreset" : {
"type" : "object",
"required" : [ "presetInformation", "submitter", "viewName", "viewPresetGuid", "viewPresetName" ],
"properties" : {
"viewPresetName" : {
"type" : "string"
},
"viewName" : {
"type" : "string"
},
"viewPresetGuid" : {
"type" : "string"
},
"submitter" : {
"type" : "string"
},
"sharedUsers" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/SharedViewPresetUser"
}
},
"presetInformation" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"message" : {
"type" : "string"
}
}
},
"SharedViewPresetUser" : {
"type" : "object",
"properties" : {
"fullName" : {
"type" : "string"
},
"loginId" : {
"type" : "string"
},
"emailAddress" : {
"type" : "string"
}
}
},
"SlotVisibilityCondition" : {
"type" : "object",
"properties" : {
"dependOnSlotId" : {
"type" : "string"
},
"values" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"matchCriteria" : {
"type" : "string",
"enum" : [ "ANY_ONE_MATCH", "ALL_MATCH", "EVALUATE_EXPRESSION" ]
},
"expression" : {
"type" : "string"
}
}
},
"SystemConfiguration" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"value" : {
"type" : "object"
},
"id" : {
"type" : "string"
}
}
},
"SystemConfigurationOption" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "integer",
"format" : "int32"
},
"enumString" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"defaultValue" : {
"type" : "string"
},
"configDataType" : {
"type" : "string"
},
"configType" : {
"type" : "string"
},
"isMultiple" : {
"type" : "boolean",
"default" : false
},
"isPresent" : {
"type" : "boolean",
"default" : false
}
}
},
"Tenant" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"domainIdentifier" : {
"type" : "string"
},
"tenantId" : {
"type" : "string"
},
"databaseName" : {
"type" : "string"
},
"status" : {
"type" : "string"
},
"overlayGroupId" : {
"type" : "string"
},
"activationStatus" : {
"type" : "string"
},
"directoryPath" : {
"type" : "string"
},
"virtualHostname" : {
"type" : "string"
},
"databaseAdminName" : {
"type" : "string"
},
"databaseAdminPassword" : {
"type" : "string"
},
"dataTablesPresent" : {
"type" : "string"
},
"pod" : {
"type" : "string"
},
"digitalWorkplaceGatewayUrl" : {
"type" : "string"
},
"rssoGatewayUrl" : {
"type" : "string"
},
"virtualChatGatewayUrl" : {
"type" : "string"
},
"digitalWorkplaceServiceCatalogGatewayUrl" : {
"type" : "string"
},
"arServerGatewayUrl" : {
"type" : "string"
},
"tenantAlias" : {
"type" : "string"
}
}
},
"TenantErrorDetails" : {
"type" : "object",
"properties" : {
"errorDetails" : {
"type" : "string"
}
}
},
"TextTemplate" : {
"type" : "object",
"properties" : {
"templateName" : {
"type" : "string"
},
"text" : {
"type" : "string"
},
"id" : {
"type" : "string"
}
}
},
"TriggerEvent" : {
"type" : "object"
},
"UCWAChatApplicationDetail" : {
"type" : "object",
"properties" : {
"result" : {
"type" : "boolean",
"default" : false
}
}
},
"User" : {
"type" : "object",
"properties" : {
"fullName" : {
"type" : "string"
},
"loginName" : {
"type" : "string"
},
"password" : {
"type" : "string"
},
"userId" : {
"type" : "string"
},
"recordId" : {
"type" : "string"
},
"emailAddress" : {
"type" : "string"
},
"createdDate" : {
"type" : "string",
"format" : "date-time"
},
"modifiedDate" : {
"type" : "string",
"format" : "date-time"
},
"groups" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"computedGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"functionalRoles" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"functionalRolesGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"licenseType" : {
"type" : "string"
},
"defaultNotifyMechanism" : {
"type" : "string"
},
"forcePasswordChangeOnLogin" : {
"type" : "boolean",
"default" : false
},
"createdBy" : {
"type" : "string"
},
"permittedGroupsBySecurityLabels" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"permittedUsersBySecurityLabels" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"allowedClientTypes" : {
"type" : "string"
},
"applicationLicense" : {
"type" : "string"
},
"disablePasswordManagementForUser" : {
"type" : "boolean",
"default" : false
},
"numDaysBeforeExpiration" : {
"type" : "integer",
"format" : "int32"
},
"numWarningDays" : {
"type" : "integer",
"format" : "int32"
},
"daysAfterExpirationUntilDisablement" : {
"type" : "integer",
"format" : "int32"
},
"lastPasswordChange" : {
"type" : "string",
"format" : "date-time"
},
"acctountDisabledDate" : {
"type" : "string",
"format" : "date-time"
},
"defaultOverlayGroupId" : {
"type" : "string"
},
"userOverlayGroupDescriptors" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/UserOverlayGroupDescriptor"
}
},
"personInstanceId" : {
"type" : "string"
},
"editableBundles" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"personFullName" : {
"type" : "string"
},
"personFirstName" : {
"type" : "string"
},
"personLastName" : {
"type" : "string"
},
"personPreferredName" : {
"type" : "string"
},
"personPrimaryEmail" : {
"type" : "string"
},
"preferredLocale" : {
"type" : "string"
},
"preferredUserLocale" : {
"type" : "string"
},
"supportStaff" : {
"type" : "boolean",
"default" : false
},
"assignmentAvailable" : {
"type" : "boolean",
"default" : false
},
"isBusinessAnalyst" : {
"type" : "boolean",
"default" : false
},
"isAdministrator" : {
"type" : "boolean",
"default" : false
}
}
},
"UserInfo" : {
"type" : "object",
"properties" : {
"timezone" : {
"type" : "string"
},
"id" : {
"type" : "string"
}
}
},
"UserModifyAllParameters" : {
"type" : "object",
"properties" : {
"userNames" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"sampleUser" : {
"$ref" : "#/definitions/User"
}
}
},
"UserOverlayGroupDescriptor" : {
"type" : "object",
"properties" : {
"overlayGroupId" : {
"type" : "string"
},
"overlayGroupName" : {
"type" : "string"
},
"tenantId" : {
"type" : "string"
},
"tenantName" : {
"type" : "string"
},
"userOverlayGroupDescriptorChildren" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/UserOverlayGroupDescriptor"
}
},
"isWritable" : {
"type" : "boolean",
"default" : false
},
"isShared" : {
"type" : "boolean",
"default" : false
}
}
},
"Validation" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"options" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/LabelValuePair"
}
},
"label" : {
"type" : "string"
},
"min" : {
"type" : "object"
},
"max" : {
"type" : "object"
},
"lookupThreshold" : {
"type" : "object"
},
"isRequired" : {
"type" : "boolean",
"default" : false
}
}
},
"ViewDefinition" : {
"type" : "object",
"properties" : {
"version" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "string",
"format" : "date-time"
},
"lastChangedBy" : {
"type" : "string"
},
"owner" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"description" : {
"type" : "string"
},
"overlayGroupId" : {
"type" : "string"
},
"scope" : {
"type" : "string",
"enum" : [ "PUBLIC", "BUNDLE", "PLATFORM_ONLY", "SERVICE_ONLY" ]
},
"internal" : {
"type" : "boolean",
"default" : false
},
"guid" : {
"type" : "string"
},
"layout" : {
"type" : "string"
},
"inputParams" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ViewInputParameter"
}
},
"outputParams" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ViewOutputParameter"
}
},
"componentDefinitions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ComponentDefinition"
}
},
"permissions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ViewDefinitionPermission"
}
},
"localizableStringsByComponentId" : {
"type" : "object",
"additionalProperties" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
},
"overlayDescriptor" : {
"$ref" : "#/definitions/ViewDefinitionOverlayDescriptor"
},
"allowOverlay" : {
"type" : "boolean",
"default" : false
},
"type" : {
"type" : "string"
},
"styles" : {
"type" : "string"
},
"targetViewDefinitionName" : {
"type" : "string"
},
"targetExtensionContainerGuid" : {
"type" : "string"
}
}
},
"ViewDefinitionOverlayDescriptor" : {
"type" : "object",
"properties" : {
"parentOverlayGroupId" : {
"type" : "string"
}
}
},
"ViewDefinitionPermission" : {
"type" : "object",
"properties" : {
"ownerId" : {
"$ref" : "#/definitions/PermissionOwnerId"
},
"type" : {
"type" : "string",
"enum" : [ "VISIBLE", "HIDDEN" ]
}
}
},
"ViewInputParameter" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
}
}
},
"ViewOutputParameter" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"source" : {
"type" : "string"
}
}
},
"WebApiConnection" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"hostname" : {
"type" : "string"
},
"port" : {
"type" : "integer",
"format" : "int32"
},
"secure" : {
"type" : "integer",
"format" : "int32"
},
"authTypeCode" : {
"type" : "integer",
"format" : "int32"
},
"authTypeDetails" : {
"$ref" : "#/definitions/JsonNode"
}
}
},
"WebApiDefinition" : {
"type" : "object",
"properties" : {
"version" : {
"type" : "string"
},
"lastUpdateTime" : {
"type" : "string",
"format" : "date-time"
},
"lastChangedBy" : {
"type" : "string"
},
"owner" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"description" : {
"type" : "string"
},
"overlayGroupId" : {
"type" : "string"
},
"scope" : {
"type" : "string",
"enum" : [ "PUBLIC", "BUNDLE", "PLATFORM_ONLY", "SERVICE_ONLY" ]
},
"internal" : {
"type" : "boolean",
"default" : false
},
"guid" : {
"type" : "string"
},
"requestDefinitions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/WebApiRequestDefinition"
}
},
"overlayDescriptor" : {
"$ref" : "#/definitions/WebApiDefinitionOverlayDescriptor"
},
"allowOverlay" : {
"type" : "boolean",
"default" : false
}
}
},
"WebApiDefinitionOverlayDescriptor" : {
"type" : "object",
"properties" : {
"parentOverlayGroupId" : {
"type" : "string"
},
"permissionsOverlayType" : {
"type" : "string",
"enum" : [ "UNMODIFIED", "OVERWRITE", "ADDITIVE" ]
},
"otherPropertiesOverlayType" : {
"type" : "string",
"enum" : [ "UNMODIFIED", "OVERWRITE", "ADDITIVE" ]
}
}
},
"WebApiRequestDefinition" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"guid" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"desc" : {
"type" : "string"
},
"method" : {
"type" : "string"
},
"path" : {
"type" : "string"
},
"queryParams" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"pathParams" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"headers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"body" : {
"type" : "string"
},
"output" : {
"type" : "string"
},
"multiPartRequest" : {
"type" : "boolean",
"default" : false
},
"failOnUnsuccessfulResponse" : {
"type" : "boolean",
"default" : false
},
"encodeParams" : {
"type" : "boolean",
"default" : false
},
"partNames" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"WebhookCallBackDefinition" : {
"type" : "object",
"properties" : {
"url" : {
"type" : "string"
},
"headers" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"payloadFieldIds" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int32"
}
},
"authentication" : {
"$ref" : "#/definitions/AuthenticationType"
}
}
},
"WebhookDefinition" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"guid" : {
"type" : "string"
},
"enabled" : {
"type" : "boolean",
"default" : false
},
"event" : {
"$ref" : "#/definitions/WebhookEvent"
},
"callback" : {
"$ref" : "#/definitions/WebhookCallBackDefinition"
},
"includeAllFields" : {
"type" : "boolean",
"default" : false
}
}
},
"WebhookEvent" : {
"type" : "object"
}
}
}
Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*