-
-
Save rdiehl/6969b15f682387438662 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "swagger": "2.0", | |
| "info": { | |
| "description": "DocFinity ECM and BPM", | |
| "version": "0.0.0.0", | |
| "title": "DocFinity" | |
| }, | |
| "basePath": "/docfinity/webservices/rest", | |
| "tags": [], | |
| "paths": {}, | |
| "definitions": { | |
| "DocumentTypeScanSettingDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The unique identifier of the document type to scan setting relationshiop." | |
| }, | |
| "documentTypeId": { | |
| "type": "string", | |
| "description": "The unique identifier of the document type." | |
| }, | |
| "documentTypeName": { | |
| "type": "string", | |
| "description": "The name of the document type." | |
| }, | |
| "scanSettingId": { | |
| "type": "string", | |
| "description": "The unique identifier of the scan setting." | |
| }, | |
| "scanSettingName": { | |
| "type": "string", | |
| "description": "The name of the scan setting." | |
| } | |
| }, | |
| "description": "The representation of the relationship between a document type and a set of scan settings." | |
| }, | |
| "ReportImporterMergeFieldDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the merge field." | |
| }, | |
| "field": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The position of the field to be merged." | |
| }, | |
| "direction": { | |
| "type": "string", | |
| "description": "The direction to followed for merge: PREV/NEXT." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal of the merge field." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Flag indicating the field is to be deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "Configuration information for report importer merge fields." | |
| }, | |
| "SynchronizationStatDTO": { | |
| "type": "object", | |
| "properties": { | |
| "usersAdded": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Number of users added." | |
| }, | |
| "usersModified": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Number of users modified." | |
| }, | |
| "usersDeleted": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Number of users deleted." | |
| }, | |
| "groupsAdded": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Number of groups added." | |
| }, | |
| "groupsModified": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Number of groups modified." | |
| }, | |
| "groupsDeleted": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Number of groups deleted." | |
| }, | |
| "details": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Number of details." | |
| }, | |
| "elapsed": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Time elapsed from sync start to sync end." | |
| }, | |
| "errorCount": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Number of errors." | |
| } | |
| }, | |
| "description": "Transfer class for details about a previous synchronziation attempt." | |
| }, | |
| "SearchStoredProcedure": { | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "search" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "search": { | |
| "$ref": "#/definitions/Search" | |
| }, | |
| "databaseConnection": { | |
| "$ref": "#/definitions/DatabaseConnection" | |
| }, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "searchStoredProcedureParameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchStoredProcedureParameter" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "PackageItemDTO": { | |
| "type": "object", | |
| "properties": { | |
| "packageItemName": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/VariableDTO" | |
| } | |
| } | |
| } | |
| }, | |
| "ExecuteMacroRequestDTO": { | |
| "type": "object", | |
| "properties": { | |
| "macro": { | |
| "type": "string", | |
| "description": "The macro to execute." | |
| }, | |
| "arguments": { | |
| "type": "array", | |
| "description": "The arguments to send while executing the macro.", | |
| "items": { | |
| "$ref": "#/definitions/DatasourceArgumentDTO" | |
| } | |
| } | |
| }, | |
| "description": "An object containing the information needed in order to execute a macro." | |
| }, | |
| "DashboardInputDatasourceInputDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "dashboardInputId": { | |
| "type": "string" | |
| }, | |
| "dashboardInputName": { | |
| "type": "string" | |
| }, | |
| "datasourceInputId": { | |
| "type": "string" | |
| }, | |
| "datasourceInputName": { | |
| "type": "string" | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "NONE", | |
| "STATIC", | |
| "MACRO", | |
| "PROMPT" | |
| ] | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "FormLibraryDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "xml": { | |
| "name": "result" | |
| }, | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/FormLibraryDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "PrintFaxDevice": { | |
| "type": "object", | |
| "required": [ | |
| "alias", | |
| "deviceType" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "alias": { | |
| "type": "string" | |
| }, | |
| "deviceType": { | |
| "type": "string", | |
| "enum": [ | |
| "PRINTER", | |
| "FAX" | |
| ] | |
| }, | |
| "assignedGroups": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DeviceGroup" | |
| } | |
| }, | |
| "deviceProperties": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DeviceProperty" | |
| } | |
| }, | |
| "server": { | |
| "$ref": "#/definitions/PrintFaxServer" | |
| }, | |
| "deviceIdentitifer": { | |
| "type": "string" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "DocumentPreviewDTO": { | |
| "type": "object", | |
| "properties": { | |
| "category": { | |
| "type": "string", | |
| "description": "Category name" | |
| }, | |
| "documentType": { | |
| "type": "string", | |
| "description": "Document type name" | |
| }, | |
| "displayName": { | |
| "type": "string", | |
| "description": "Display name" | |
| } | |
| }, | |
| "description": "Document preview from search results." | |
| }, | |
| "ResultSet": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "last": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "closed": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "beforeFirst": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "afterLast": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "first": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "row": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "concurrency": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "statement": { | |
| "$ref": "#/definitions/Statement" | |
| }, | |
| "metaData": { | |
| "$ref": "#/definitions/ResultSetMetaData" | |
| }, | |
| "holdability": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "fetchDirection": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "fetchSize": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "warnings": { | |
| "$ref": "#/definitions/SQLWarning" | |
| }, | |
| "cursorName": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "StoredProcedureDTO": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the stored procedure." | |
| }, | |
| "schema": { | |
| "type": "string", | |
| "description": "The schema name of the database where the stored procedure is saved." | |
| }, | |
| "parameters": { | |
| "type": "array", | |
| "description": "The parameter array of the stored procedure.", | |
| "items": { | |
| "$ref": "#/definitions/StoredProcedureParameterDTO" | |
| } | |
| } | |
| }, | |
| "description": "The definition of a stored procedure stored in a database." | |
| }, | |
| "ChartableDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "description": "The current page of charts.", | |
| "items": { | |
| "$ref": "#/definitions/ChartableDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged search result for charts" | |
| }, | |
| "RuleSetConditionDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the ruleset condition." | |
| }, | |
| "propertyName": { | |
| "type": "string", | |
| "description": "The property name that the condition applies to." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type of the property used for condition evaluation." | |
| }, | |
| "comparator": { | |
| "type": "string", | |
| "description": "The comparator type used for condition evaluation.", | |
| "enum": [ | |
| "EQUALS", | |
| "NOT_EQUALS", | |
| "GREATER_THAN", | |
| "GREATER_THAN_EQUAL_TO", | |
| "LESS_THAN", | |
| "LESS_THAN_EQUAL_TO", | |
| "CONTAINS", | |
| "NOT_CONTAINS", | |
| "CONTAINS_REG_EXP", | |
| "STARTS_WITH", | |
| "NOT_STARTS_WITH", | |
| "ENDS_WITH", | |
| "NOT_ENDS_WITH" | |
| ] | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "The value used for condition evaluation." | |
| }, | |
| "valueType": { | |
| "type": "string", | |
| "description": "The type of value used for the condition.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "VARIABLE", | |
| "MIXED" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal of the rule set condition." | |
| }, | |
| "ruleSetId": { | |
| "type": "string", | |
| "description": "The rule set id the rule set condition is associated with." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Flag indicating the rule set condition is to be deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The configuration for the rule set condition data." | |
| }, | |
| "ScanSetting": { | |
| "type": "object", | |
| "required": [ | |
| "deleteBackOfSeparator", | |
| "dpiResolution", | |
| "name", | |
| "scanSettingType", | |
| "simulateDuplex", | |
| "storageType" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "dpiResolution": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "duplex": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "multipage": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "docFinitySeparator": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "scanToExternalDir": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "externalDirPath": { | |
| "type": "string" | |
| }, | |
| "saveToServer": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "convertToPdf": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "deleteBackOfSeparator": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "simulateDuplex": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "storageType": { | |
| "$ref": "#/definitions/StorageType" | |
| }, | |
| "scanSettingType": { | |
| "type": "string", | |
| "enum": [ | |
| "INTERNAL", | |
| "ACTIVE" | |
| ] | |
| }, | |
| "scanSettingGroups": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ScanSettingGroup" | |
| } | |
| }, | |
| "documentTypeScanSettings": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeScanSetting" | |
| } | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "RoleDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the role." | |
| }, | |
| "roleName": { | |
| "type": "string", | |
| "description": "The name of the role." | |
| }, | |
| "roleHolder": { | |
| "type": "string", | |
| "description": "Username of the role holder (display only)." | |
| }, | |
| "roleHolderFirstName": { | |
| "type": "string", | |
| "description": "First name of the role holder (display only.)" | |
| }, | |
| "roleHolderLastName": { | |
| "type": "string", | |
| "description": "Last name of the role holder (display only)." | |
| }, | |
| "actors": { | |
| "type": "array", | |
| "description": "The users who are assigned to this role.", | |
| "items": { | |
| "$ref": "#/definitions/ActorDTO" | |
| } | |
| } | |
| }, | |
| "description": "A role used in business process management." | |
| }, | |
| "StorageType": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "pixelType": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "compression": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "DateFormatsDTO": { | |
| "type": "object", | |
| "properties": { | |
| "date": { | |
| "type": "string" | |
| }, | |
| "time": { | |
| "type": "string" | |
| }, | |
| "dateTime": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "SearchStoredProcedureDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the stored procedure." | |
| }, | |
| "databaseConnectionId": { | |
| "type": "string", | |
| "description": "The ID of the database connection used by this stored procedure." | |
| }, | |
| "schema": { | |
| "type": "string", | |
| "description": "The schema used by this stored procedure." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the stored procedure." | |
| }, | |
| "parameters": { | |
| "type": "array", | |
| "description": "The array of parameters used by the stored procedure.", | |
| "items": { | |
| "$ref": "#/definitions/SearchStoredProcedureParameterDTO" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The indication as to whether or not to delete this stored procedure from the search.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The representation of the stored procedure associated with the search." | |
| }, | |
| "DashboardGroupDTO": { | |
| "type": "object", | |
| "required": [ | |
| "dashboardId", | |
| "groupId" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DashboardGroup." | |
| }, | |
| "groupId": { | |
| "type": "string", | |
| "description": "The group ID" | |
| }, | |
| "groupName": { | |
| "type": "string", | |
| "description": "The group name." | |
| }, | |
| "dashboardId": { | |
| "type": "string", | |
| "description": "The dashboard ID." | |
| }, | |
| "dashboardName": { | |
| "type": "string", | |
| "description": "The dashboard name." | |
| } | |
| }, | |
| "description": "An object representing the assignment of a dashboard to a group." | |
| }, | |
| "AuditingTypeProcessModelDTO": { | |
| "type": "object", | |
| "required": [ | |
| "enabled" | |
| ], | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the process model." | |
| }, | |
| "enabled": { | |
| "type": "boolean", | |
| "description": "The boolean flag indicating if the auditing event type is configured to record an audit or not.", | |
| "default": false | |
| } | |
| }, | |
| "description": "Auditing data used to configure auditing levels for individual process models." | |
| }, | |
| "HsmActionPluginDTO": { | |
| "type": "object", | |
| "properties": { | |
| "label": { | |
| "type": "string", | |
| "description": "The label of the plugin." | |
| }, | |
| "iconName": { | |
| "type": "string", | |
| "description": "The icon associated with the plugin." | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of the plugin." | |
| }, | |
| "supportsKeys": { | |
| "type": "boolean", | |
| "description": "Boolean flag to indicate if the plugin supports key.", | |
| "default": false | |
| }, | |
| "processSupport": { | |
| "type": "string", | |
| "description": "Get the process support information.", | |
| "enum": [ | |
| "NOT_SUPPORTED", | |
| "ZERO_ITEM_PROCESS", | |
| "SINGLE_ITEM_PROCESS" | |
| ] | |
| }, | |
| "searchable": { | |
| "type": "boolean", | |
| "description": "Flag to indicate if preview is supported by the plugin using sorts and criteria.", | |
| "default": false | |
| }, | |
| "parameters": { | |
| "type": "array", | |
| "description": "Get the parameters used by the plugin.", | |
| "items": { | |
| "$ref": "#/definitions/ParameterPromptDTO" | |
| } | |
| } | |
| }, | |
| "description": "The HSM action plugin dto." | |
| }, | |
| "EmailSettingDTO": { | |
| "type": "object", | |
| "properties": { | |
| "host": { | |
| "type": "string", | |
| "description": "The email server host." | |
| }, | |
| "username": { | |
| "type": "string", | |
| "description": "The username of the configured email account." | |
| }, | |
| "password": { | |
| "type": "string", | |
| "description": "The password of the configured email account." | |
| }, | |
| "port": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The port of the configured email server." | |
| }, | |
| "authenticate": { | |
| "type": "boolean", | |
| "description": "The authentication setting of the configured email server.", | |
| "default": false | |
| }, | |
| "tls": { | |
| "type": "boolean", | |
| "description": "The flag indicating the configuration of the TLS setting.", | |
| "default": false | |
| }, | |
| "maxAttachmentSize": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "The maximum size of attachments allowed to be attached to outgoing emails." | |
| }, | |
| "forgotPasswordIntro": { | |
| "type": "string", | |
| "description": "The introduction to the forgot password email." | |
| }, | |
| "forgotPasswordEnd": { | |
| "type": "string", | |
| "description": "The ending text of the forgot password email." | |
| }, | |
| "generatePasswordSubject": { | |
| "type": "string", | |
| "description": "The subject line of the generate password email." | |
| }, | |
| "generatePasswordForceChangeFirst": { | |
| "type": "string", | |
| "description": "The introduction of the email that indicates the user is forced to change their password." | |
| }, | |
| "generatePasswordForceChangeNext": { | |
| "type": "string", | |
| "description": "The main text area of the email that indicates the user is forced to change their password." | |
| }, | |
| "generatePasswordIntroOne": { | |
| "type": "string", | |
| "description": "The introduction to the generate password email." | |
| }, | |
| "generatePasswordIntroTwo": { | |
| "type": "string", | |
| "description": "The second part of the text of the introduction to the generate password email." | |
| }, | |
| "generatePasswordOptionalFirst": { | |
| "type": "string", | |
| "description": "The first part of the optional generate password email." | |
| }, | |
| "generatePasswordOptionalNext": { | |
| "type": "string", | |
| "description": "The second portion of the optional generate password email." | |
| }, | |
| "passwordSubject": { | |
| "type": "string", | |
| "description": "The subject of the password email." | |
| }, | |
| "passwordUsername": { | |
| "type": "string", | |
| "description": "The username for the recipient of the password email." | |
| }, | |
| "passwordPassword": { | |
| "type": "string", | |
| "description": "The new password for the password email." | |
| } | |
| }, | |
| "description": "The email configuration settings for the system." | |
| }, | |
| "DateDashboardPromptDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/DatasourceRequiredDashboardPromptDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DashboardInput." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The input name, must be unique per dashboard." | |
| }, | |
| "value": { | |
| "type": "object" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of input.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "DASHBOARD_PROMPT" | |
| ] | |
| }, | |
| "dashboardId": { | |
| "type": "string", | |
| "description": "The ID of the dashboard that owns this input." | |
| }, | |
| "dashboardName": { | |
| "type": "string", | |
| "description": "The name of the dashboard that owns this input." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The ID of the datasource used by this input." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "The name of the datasource used by this input." | |
| }, | |
| "datasourceResults": { | |
| "type": "array", | |
| "description": "The results from executing the datasource.", | |
| "items": { | |
| "$ref": "#/definitions/DataValue" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "responsibilityMapping": { | |
| "type": "array", | |
| "description": "The responsibility mapping for executing dependent inputs.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "dashboardInputDatasourceInputs": { | |
| "type": "array", | |
| "description": "The inputs needed for the datasource for this input.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardInputDatasourceInputDTO" | |
| } | |
| }, | |
| "label": { | |
| "type": "string", | |
| "description": "The prompt label." | |
| }, | |
| "promptType": { | |
| "type": "string", | |
| "description": "The prompt type.", | |
| "enum": [ | |
| "SWITCH", | |
| "DATE", | |
| "TEXT", | |
| "DROP_DOWN_LIST" | |
| ] | |
| }, | |
| "required": { | |
| "type": "boolean", | |
| "description": "Whether the input is required.", | |
| "default": false | |
| }, | |
| "defaultValueType": { | |
| "type": "string", | |
| "description": "The default value type.", | |
| "enum": [ | |
| "STATIC", | |
| "MACRO", | |
| "DATASOURCE", | |
| "FIRST", | |
| "SPECIFIC", | |
| "PROMPT" | |
| ] | |
| }, | |
| "defaultDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "The default static date, used when defaultValueType is STATIC." | |
| }, | |
| "defaultMacro": { | |
| "type": "string", | |
| "description": "The default macro, used when defaultValueType is MACRO." | |
| } | |
| }, | |
| "description": "A date prompt." | |
| } | |
| ] | |
| }, | |
| "ParameterPromptDatasourceArgDTO": { | |
| "type": "object", | |
| "properties": { | |
| "datasourceArgumentName": { | |
| "type": "string" | |
| }, | |
| "argumentType": { | |
| "type": "string", | |
| "enum": [ | |
| "NONE", | |
| "STATIC", | |
| "MACRO", | |
| "PROMPT" | |
| ] | |
| }, | |
| "value": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "DeviceProperty": { | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "printFaxDevice" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "printFaxDevice": { | |
| "$ref": "#/definitions/PrintFaxDevice" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "GroupTotalDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The group ID." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The group name." | |
| }, | |
| "numberOfUsersInGroup": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The number of active users in the group." | |
| } | |
| }, | |
| "description": "An object representing a group containing the group id, group name and the number of active members in the group." | |
| }, | |
| "DocumentTypeOverlay": { | |
| "type": "object", | |
| "required": [ | |
| "defaultTo", | |
| "documentType", | |
| "offsetX", | |
| "offsetY", | |
| "overlay", | |
| "range" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "overlay": { | |
| "$ref": "#/definitions/Overlay" | |
| }, | |
| "documentType": { | |
| "$ref": "#/definitions/DocumentType" | |
| }, | |
| "offsetX": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "offsetY": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "range": { | |
| "type": "string" | |
| }, | |
| "defaultTo": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "LoginPropertiesDTO": { | |
| "type": "object", | |
| "properties": { | |
| "searchingDelimiterIn": { | |
| "type": "string" | |
| }, | |
| "dateFormat": { | |
| "type": "string" | |
| }, | |
| "showThumbnail": { | |
| "type": "string" | |
| }, | |
| "logoutURL": { | |
| "type": "string" | |
| }, | |
| "scanningPort": { | |
| "type": "string" | |
| }, | |
| "licenseDto": { | |
| "$ref": "#/definitions/LicenseDTO" | |
| }, | |
| "pageSize": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "allowChangePassword": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/UserDTO" | |
| }, | |
| "userSettings": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/UserSettingDTO" | |
| } | |
| }, | |
| "userFeatureRights": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/GroupFeatureRightDTO" | |
| } | |
| }, | |
| "searchLimit": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "searchCaseInsensitiveSorting": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "maxPageLength": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "serverLocale": { | |
| "type": "string" | |
| }, | |
| "currencyFormat": { | |
| "type": "string" | |
| }, | |
| "urlApiBase": { | |
| "type": "string" | |
| }, | |
| "dateFormats": { | |
| "$ref": "#/definitions/DateFormatsDTO" | |
| }, | |
| "loginURL": { | |
| "type": "string" | |
| }, | |
| "serverTimeZoneId": { | |
| "type": "string" | |
| }, | |
| "maxUploadSize": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "themeColor": { | |
| "type": "string" | |
| }, | |
| "themeLabel": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ChartDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/ChartableDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "INTERNAL", | |
| "STANDARD" | |
| ] | |
| }, | |
| "isLocked": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "lockOwner": { | |
| "type": "string" | |
| }, | |
| "lockOwnerFirstName": { | |
| "type": "string" | |
| }, | |
| "lockOwnerLastName": { | |
| "type": "string" | |
| }, | |
| "dateModified": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "properties": { | |
| "$ref": "#/definitions/ChartablePropertiesDTO" | |
| }, | |
| "datasourceId": { | |
| "type": "string" | |
| }, | |
| "datasourceName": { | |
| "type": "string" | |
| }, | |
| "datasourceParameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DatasourceArgumentDTO" | |
| } | |
| }, | |
| "refreshInterval": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "isValid": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "variables": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartVariableDTO" | |
| } | |
| }, | |
| "datasourceInputs": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartDatasourceInputDTO" | |
| } | |
| }, | |
| "dashboardCount": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "overrideErrorsOnSave": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "chartType": { | |
| "type": "string", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "labelColumn": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| }, | |
| "seriesColumn": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| }, | |
| "dataColumns": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| } | |
| } | |
| }, | |
| "description": "A parent class for all Kendo charts." | |
| } | |
| ] | |
| }, | |
| "SearchDocIndexingDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The unique identifier of the document indexing configuration of the search." | |
| }, | |
| "allowDocCreation": { | |
| "type": "boolean", | |
| "description": "The flag indicating if the search could be transformed into an indexed document.", | |
| "default": false | |
| }, | |
| "documentTypeId": { | |
| "type": "string", | |
| "description": "The unique identifier of the document type to index the document/search to." | |
| }, | |
| "documentTypeName": { | |
| "type": "string", | |
| "description": "The document type name to index the document/search to." | |
| }, | |
| "categoryId": { | |
| "type": "string", | |
| "description": "The unique identifier of the category to index the document/search to." | |
| }, | |
| "categoryName": { | |
| "type": "string", | |
| "description": "The category name to index the document/search to." | |
| }, | |
| "metadata": { | |
| "type": "array", | |
| "description": "The metadata associated with the document indexing configuration.", | |
| "items": { | |
| "$ref": "#/definitions/SearchDocIndexingMetadataDTO" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The indication of the intent to delete the search document indexing configuration.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The representation of the document indexing configuration of a search." | |
| }, | |
| "GroupMember": { | |
| "type": "object", | |
| "required": [ | |
| "group", | |
| "user" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "group": { | |
| "$ref": "#/definitions/Group" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/User" | |
| }, | |
| "groupAdmin": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "FormControlConfigDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "Gets the id attribute of the FormControlConfigDTO object." | |
| }, | |
| "andOr": { | |
| "type": "string", | |
| "description": "Gets the andOr attribute of the FormControlConfigDTO object." | |
| }, | |
| "firstOperandType": { | |
| "type": "string", | |
| "description": "Gets the firstOperandType attribute of the FormControlConfigDTO object." | |
| }, | |
| "firstOperand": { | |
| "type": "string", | |
| "description": "Gets the firstOperand attribute of the FormControlConfigDTO object." | |
| }, | |
| "secondOperandType": { | |
| "type": "string", | |
| "description": "Gets the secondOperandType attribute of the FormControlConfigDTO object." | |
| }, | |
| "macroName": { | |
| "type": "string", | |
| "description": "Gets the macroName attribute of the FormControlConfigDTO object." | |
| }, | |
| "secondOperand": { | |
| "type": "string", | |
| "description": "Gets the secondOperand attribute of the FormControlConfigDTO object." | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Gets the deleted attribute of the FormControlConfigDTO object.", | |
| "default": false | |
| } | |
| }, | |
| "description": "A DTO for complex data used in the macro builder for hidden, required, and disabled properties." | |
| }, | |
| "DashboardDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "description": "Representation of the pageable collection of dashboards.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged search result for dashboards." | |
| }, | |
| "ColdImporterDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/DirectoryImporterDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the importer." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the importer." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description to be used by the importer." | |
| }, | |
| "running": { | |
| "type": "boolean", | |
| "description": "Flag indicating that the importer is running.", | |
| "default": false | |
| }, | |
| "idle": { | |
| "type": "boolean", | |
| "description": "Flag indicating importer is running but not processing.", | |
| "default": false | |
| }, | |
| "server": { | |
| "type": "string", | |
| "description": "The server details where the importer will run." | |
| }, | |
| "processType": { | |
| "type": "string", | |
| "description": "Importer process type.Values allowed are EMAIL,REPORT,COLD,OBJECT,INDEX.", | |
| "enum": [ | |
| "EMAIL", | |
| "REPORT", | |
| "INDEX", | |
| "OBJECT", | |
| "COLD" | |
| ] | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "The importer status INTERNAL/EXTERNAL.", | |
| "enum": [ | |
| "INTERNAL", | |
| "ACTIVE" | |
| ] | |
| }, | |
| "preRender": { | |
| "type": "boolean", | |
| "description": "Flag indicating that files imported by the importer will be pre-rendered.", | |
| "default": false | |
| }, | |
| "pollingFrequency": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Numeric indicating how often the importer would poll for files in the monitored directory/email folder." | |
| }, | |
| "pollingUnits": { | |
| "type": "string", | |
| "description": "String indicating what units the polling frequency uses. Valid values are SECONDS,MINUTES,HOURS,DAYS.", | |
| "enum": [ | |
| "SECONDS", | |
| "MINUTES", | |
| "HOURS", | |
| "DAYS" | |
| ] | |
| }, | |
| "calculatedProperties": { | |
| "type": "array", | |
| "description": "The calculated properties to be used by the importer.", | |
| "items": { | |
| "$ref": "#/definitions/CalculatedPropertyDTO" | |
| } | |
| }, | |
| "ruleSets": { | |
| "type": "array", | |
| "description": "The rulesets to be used by the importer.", | |
| "items": { | |
| "$ref": "#/definitions/RuleSetDTO" | |
| } | |
| }, | |
| "importerPluginName": { | |
| "type": "string", | |
| "description": "The plugin to be used by the importer." | |
| }, | |
| "schedule": { | |
| "description": "The importer schedule.", | |
| "$ref": "#/definitions/GenericScheduleDTO" | |
| }, | |
| "lastErrorMessage": { | |
| "type": "string", | |
| "description": "The last error message associated with the importer." | |
| }, | |
| "pending": { | |
| "type": "boolean", | |
| "description": "Flag indicating that start/stop of importer is pending.", | |
| "default": false | |
| }, | |
| "get_class": { | |
| "type": "string" | |
| }, | |
| "importerSettings": { | |
| "type": "string" | |
| }, | |
| "directoryPath": { | |
| "type": "string", | |
| "description": "The directory path being monitored by the importer." | |
| }, | |
| "fileFilter": { | |
| "type": "string", | |
| "description": "The file filter to be used by the importer." | |
| }, | |
| "serial": { | |
| "type": "boolean", | |
| "description": "Flag indicating the files are to be processed serially.", | |
| "default": false | |
| }, | |
| "narratives": { | |
| "type": "array", | |
| "description": "The cold narrative associated with the importer.", | |
| "items": { | |
| "$ref": "#/definitions/ColdNarrativeDTO" | |
| } | |
| } | |
| }, | |
| "description": "A COLD importer." | |
| } | |
| ] | |
| }, | |
| "DataHandler": { | |
| "type": "object", | |
| "properties": { | |
| "dataSource": { | |
| "$ref": "#/definitions/DataSource" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "inputStream": { | |
| "$ref": "#/definitions/InputStream" | |
| }, | |
| "content": { | |
| "type": "object" | |
| }, | |
| "contentType": { | |
| "type": "string" | |
| }, | |
| "outputStream": { | |
| "$ref": "#/definitions/OutputStream" | |
| }, | |
| "transferDataFlavors": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DataFlavor" | |
| } | |
| }, | |
| "preferredCommands": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/CommandInfo" | |
| } | |
| }, | |
| "allCommands": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/CommandInfo" | |
| } | |
| } | |
| } | |
| }, | |
| "Diary": { | |
| "type": "object", | |
| "required": [ | |
| "entry" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "document": { | |
| "$ref": "#/definitions/Document" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/User" | |
| }, | |
| "dateCreated": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "entry": { | |
| "type": "string" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "entryId": { | |
| "type": "string" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "JobCompletionDTO": { | |
| "type": "object", | |
| "properties": { | |
| "successful": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "errorMessage": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "DatasourceDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "xml": { | |
| "name": "result" | |
| }, | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/DatasourceDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "RuleSetDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id associated with the ruleset." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the ruleset." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Flag indicating the ordinal of the ruleset." | |
| }, | |
| "categoryId": { | |
| "type": "string", | |
| "description": "The category id associated with the ruleset." | |
| }, | |
| "categoryName": { | |
| "type": "string", | |
| "description": "The category name associated with the ruleset." | |
| }, | |
| "documentTypeId": { | |
| "type": "string", | |
| "description": "The document type id associated with the ruleset." | |
| }, | |
| "documentTypeName": { | |
| "type": "string", | |
| "description": "The document type name associated with the ruleset." | |
| }, | |
| "actionType": { | |
| "type": "string", | |
| "description": "The type of action taken on imported documents.", | |
| "enum": [ | |
| "START_PROCESS", | |
| "ALL_DOCUMENTS", | |
| "ONLY_UNINDEXED_DOCUMENTS" | |
| ] | |
| }, | |
| "batchName": { | |
| "type": "string", | |
| "description": "The batch name associated with the ruleset." | |
| }, | |
| "batchNameType": { | |
| "type": "string", | |
| "description": "The type of value stored in batch name.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "VARIABLE", | |
| "MIXED" | |
| ] | |
| }, | |
| "batchDocuments": { | |
| "type": "string", | |
| "description": "The type of documents to associate in a batch ALL_DOCUMENTS or ONLY_UNINDEXED_DOCUMENTS.", | |
| "enum": [ | |
| "ALL_DOCUMENTS", | |
| "ONLY_UNINDEXED_DOCUMENTS" | |
| ] | |
| }, | |
| "batchDocumentCount": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The number of documents to include in the batch." | |
| }, | |
| "batchGroups": { | |
| "type": "array", | |
| "description": "The batch groups associated with the batch.", | |
| "items": { | |
| "$ref": "#/definitions/RuleSetBatchGroupDTO" | |
| } | |
| }, | |
| "startProcess": { | |
| "type": "boolean", | |
| "description": "Flag indicating the ruleset must start a process.", | |
| "default": false | |
| }, | |
| "processModelName": { | |
| "type": "string", | |
| "description": "The process model name associated with the rule set." | |
| }, | |
| "packageItemName": { | |
| "type": "string", | |
| "description": "The package item name associated with the rule set." | |
| }, | |
| "unmanagedDocument": { | |
| "type": "boolean", | |
| "description": "Flag indicating rule set will import the document as an unmanaged document.", | |
| "default": false | |
| }, | |
| "processInstanceVariables": { | |
| "type": "array", | |
| "description": "The process instnace variables associated with the rule set.", | |
| "items": { | |
| "$ref": "#/definitions/RuleSetProcessInstanceVariableDTO" | |
| } | |
| }, | |
| "conditions": { | |
| "type": "array", | |
| "description": "The conditions associated with the rule set.", | |
| "items": { | |
| "$ref": "#/definitions/RuleSetConditionDTO" | |
| } | |
| }, | |
| "assignments": { | |
| "type": "array", | |
| "description": "The assignments associated with the rule set.", | |
| "items": { | |
| "$ref": "#/definitions/RuleSetAssignmentDTO" | |
| } | |
| }, | |
| "importerId": { | |
| "type": "string", | |
| "description": "The importer id associated with the ruleset." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Flag indicating the ruleset is to be deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The rule set associated with the importer." | |
| }, | |
| "ServerNodeDTO": { | |
| "type": "object", | |
| "properties": { | |
| "nodeIdentifier": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "StaticDecimalDashboardInputDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/StaticDashboardInputDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DashboardInput." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The input name, must be unique per dashboard." | |
| }, | |
| "value": { | |
| "type": "object" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of input.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "DASHBOARD_PROMPT" | |
| ] | |
| }, | |
| "dashboardId": { | |
| "type": "string", | |
| "description": "The ID of the dashboard that owns this input." | |
| }, | |
| "dashboardName": { | |
| "type": "string", | |
| "description": "The name of the dashboard that owns this input." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The ID of the datasource used by this input." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "The name of the datasource used by this input." | |
| }, | |
| "datasourceResults": { | |
| "type": "array", | |
| "description": "The results from executing the datasource.", | |
| "items": { | |
| "$ref": "#/definitions/DataValue" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "responsibilityMapping": { | |
| "type": "array", | |
| "description": "The responsibility mapping for executing dependent inputs.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "dashboardInputDatasourceInputs": { | |
| "type": "array", | |
| "description": "The inputs needed for the datasource for this input.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardInputDatasourceInputDTO" | |
| } | |
| }, | |
| "staticType": { | |
| "type": "string", | |
| "description": "The type of static input.", | |
| "enum": [ | |
| "BOOLEAN", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "STRING" | |
| ] | |
| }, | |
| "decimalValue": { | |
| "type": "number", | |
| "format": "double", | |
| "description": "The static decimal value." | |
| } | |
| }, | |
| "description": "A static hidden decimal input." | |
| } | |
| ] | |
| }, | |
| "MetadataDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/MetadataDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "ValidateStatus": { | |
| "type": "object", | |
| "properties": { | |
| "validateStatusType": { | |
| "type": "string", | |
| "enum": [ | |
| "VALID", | |
| "ERROR", | |
| "WARNING" | |
| ] | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "DispositionQueueApproval": { | |
| "type": "object", | |
| "required": [ | |
| "item", | |
| "status", | |
| "user" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "item": { | |
| "$ref": "#/definitions/DispositionQueueItem" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/User" | |
| }, | |
| "approvalDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "APPROVED", | |
| "POSTPONED" | |
| ] | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "SearchGroup": { | |
| "type": "object", | |
| "required": [ | |
| "group", | |
| "search" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "search": { | |
| "$ref": "#/definitions/Search" | |
| }, | |
| "group": { | |
| "$ref": "#/definitions/Group" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "SearchSubSearchParameter": { | |
| "type": "object", | |
| "required": [ | |
| "attributeName", | |
| "attributeType", | |
| "comparatorType", | |
| "ordinal", | |
| "searchChecklistSubSearch", | |
| "sortOrder" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributeType": { | |
| "type": "string", | |
| "enum": [ | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "FULL_TEXT", | |
| "DIARY", | |
| "METADATA", | |
| "OTHER", | |
| "STORED_PROC_PARAM", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES", | |
| "FILE_TYPE", | |
| "HIDDEN", | |
| "HIDDEN_DATE", | |
| "HIDDEN_INTEGER", | |
| "HIDDEN_DECIMAL" | |
| ] | |
| }, | |
| "attributeName": { | |
| "type": "string" | |
| }, | |
| "searchChecklistSubSearch": { | |
| "$ref": "#/definitions/SearchChecklistSubSearch" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Metadata" | |
| }, | |
| "sortOrder": { | |
| "type": "string", | |
| "enum": [ | |
| "ASC", | |
| "DESC", | |
| "CUSTOM" | |
| ] | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "PROMPTED", | |
| "STATIC", | |
| "MACRO", | |
| "CUSTOM" | |
| ] | |
| }, | |
| "connectiveType": { | |
| "type": "string", | |
| "enum": [ | |
| "AND", | |
| "OR" | |
| ] | |
| }, | |
| "comparatorType": { | |
| "type": "string", | |
| "enum": [ | |
| "EQUALS", | |
| "NOT_EQUALS", | |
| "GREATER_THAN", | |
| "LESS_THAN", | |
| "GREATER_THAN_EQUALS", | |
| "LESS_THAN_EQUALS", | |
| "CONTAINS", | |
| "NOT_CONTAINS", | |
| "IN" | |
| ] | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "searchPrompt": { | |
| "$ref": "#/definitions/SearchPrompt" | |
| }, | |
| "openingParen": { | |
| "type": "string" | |
| }, | |
| "closingParen": { | |
| "type": "string" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "subSearchId": { | |
| "type": "string" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "DataStoreDTO": { | |
| "type": "object", | |
| "required": [ | |
| "databaseConnectionId", | |
| "name", | |
| "tableName" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the datastore configuration data." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the datastore." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description of the datastore." | |
| }, | |
| "databaseConnectionId": { | |
| "type": "string", | |
| "description": "The id of the database connection to be used by the datastore." | |
| }, | |
| "schema": { | |
| "type": "string", | |
| "description": "The database schema name to be used by the datastore." | |
| }, | |
| "tableName": { | |
| "type": "string", | |
| "description": "The database table name to be used by the datastore." | |
| }, | |
| "columns": { | |
| "type": "array", | |
| "description": "The database table columns to be used by the datastore.", | |
| "items": { | |
| "$ref": "#/definitions/DataStoreColumnDTO" | |
| } | |
| } | |
| }, | |
| "description": "DataStore data used to configure datastores for the system." | |
| }, | |
| "RootShiftDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "Gets the id attribute of the ShiftDTO object." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Gets the name attribute." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Gets the description attribute of the shift." | |
| }, | |
| "shiftParts": { | |
| "type": "array", | |
| "description": "Gets the shiftParts attribute.", | |
| "items": { | |
| "$ref": "#/definitions/ShiftPartDTO" | |
| } | |
| } | |
| }, | |
| "description": "The DTO object for a Shift's intrinsic properties and shift parts." | |
| }, | |
| "DatasourceDTO": { | |
| "type": "object", | |
| "properties": { | |
| "clientOnly": { | |
| "type": "boolean", | |
| "description": "Whether the datasource is cient only.", | |
| "default": false | |
| }, | |
| "configResourcePath": { | |
| "type": "string", | |
| "description": "The config resource path of the datasource." | |
| }, | |
| "hasCustomInterface": { | |
| "type": "boolean", | |
| "description": "If true the datasource type has its own custom interface.", | |
| "default": false | |
| }, | |
| "datasourceType": { | |
| "type": "string", | |
| "description": "The type of the datasource." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description of the datasource." | |
| }, | |
| "displayName": { | |
| "type": "string", | |
| "description": "The display name of the datasource." | |
| }, | |
| "entryControlResourcePath": { | |
| "type": "string", | |
| "description": "The entry control resource flag of the datasource." | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the datasource." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the datasource." | |
| }, | |
| "properties": { | |
| "type": "array", | |
| "description": "The datasource properties associated with the datasource.", | |
| "items": { | |
| "$ref": "#/definitions/DatasourcePropertyDTO" | |
| } | |
| }, | |
| "parameterNames": { | |
| "type": "array", | |
| "description": "The parameter names of the datasource.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "referenced": { | |
| "type": "boolean", | |
| "description": "The referenced attribute of the datasource.", | |
| "default": false | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The marked for delete attribute of the datasource.", | |
| "default": false | |
| }, | |
| "parameters": { | |
| "type": "array", | |
| "description": "The datasource parameter of the datasource.", | |
| "items": { | |
| "$ref": "#/definitions/DatasourceParameterDTO" | |
| } | |
| }, | |
| "intents": { | |
| "type": "array", | |
| "description": "The datasource intents of the datasource.", | |
| "items": { | |
| "$ref": "#/definitions/DatasourceIntentDTO" | |
| } | |
| }, | |
| "promptList": { | |
| "type": "array", | |
| "description": "The parameter prompt associated with the datasource.", | |
| "items": { | |
| "$ref": "#/definitions/ParameterPromptDTO" | |
| } | |
| }, | |
| "testable": { | |
| "type": "boolean", | |
| "description": "If true the datasource can be tested.", | |
| "default": false | |
| }, | |
| "isEditable": { | |
| "type": "boolean", | |
| "description": "Whether the datasource is editable.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The definition of a data source." | |
| }, | |
| "DashboardDTO": { | |
| "type": "object", | |
| "required": [ | |
| "backgroundColor", | |
| "categoryId", | |
| "name", | |
| "status" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the dashboard." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the dashboard. Must be unique within its category." | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "The status of the dashboard, should always be STANDARD for user dashboards.", | |
| "enum": [ | |
| "STANDARD" | |
| ] | |
| }, | |
| "content": { | |
| "type": "array", | |
| "description": "The charts that reside on this dashboard.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardChartableDTO" | |
| } | |
| }, | |
| "dashboardInputs": { | |
| "type": "array", | |
| "description": "The inputs provided to the dashboard, in the form of hidden inputs or user prompts.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardInputDTO" | |
| } | |
| }, | |
| "categoryId": { | |
| "type": "string", | |
| "description": "The ID of the dashboard category that holds this dashboard." | |
| }, | |
| "categoryName": { | |
| "type": "string", | |
| "description": "The name of the category that holds this dashboard." | |
| }, | |
| "isLocked": { | |
| "type": "boolean", | |
| "description": "Whether this dashboard is currently locked for editing.", | |
| "default": false | |
| }, | |
| "lockOwner": { | |
| "type": "string", | |
| "description": "The username of the user who has locked this dashboard for editing." | |
| }, | |
| "lockOwnerFirstName": { | |
| "type": "string", | |
| "description": "The first name of the user who has locked this dashboard for editing." | |
| }, | |
| "lockOwnerLastName": { | |
| "type": "string", | |
| "description": "The username of the user who has locked this dashboard for editing." | |
| }, | |
| "dateModified": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "The date and time that this dashboard was last modified." | |
| }, | |
| "backgroundColor": { | |
| "type": "string", | |
| "description": "The background color of the dashboard." | |
| }, | |
| "isValid": { | |
| "type": "boolean", | |
| "description": "Whether this dashboard is currently in a valid state.", | |
| "default": false | |
| }, | |
| "groupCount": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "The number of groups that are currently assigned access to this dashboard." | |
| }, | |
| "drillDownCount": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "The number of dashboards that drill down to this dashboard." | |
| }, | |
| "margin": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The margin between charts on this dashboard." | |
| }, | |
| "isUserAssigned": { | |
| "type": "boolean", | |
| "description": "Whether the current user is assigned group access to this dashboard.", | |
| "default": false | |
| }, | |
| "overrideErrorsOnSave": { | |
| "type": "boolean", | |
| "description": "Whether to override errors while saving this dashboard.", | |
| "default": false | |
| } | |
| }, | |
| "description": "A dashboard used to display charts to a user." | |
| }, | |
| "FormControl": { | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "type" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "controlSteps": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormControlStep" | |
| } | |
| }, | |
| "deletedFormControlSteps": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormControlStep" | |
| } | |
| }, | |
| "form": { | |
| "$ref": "#/definitions/Form" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "disabled": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "formId": { | |
| "type": "string" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "LicenseMetricsDTO": { | |
| "type": "object", | |
| "properties": { | |
| "totalLicensesAvailable": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Total licenses available to the system, or -1 if enterprise." | |
| }, | |
| "totalLicensesConsumed": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Total licenses available to the system, or -1 if enterprise." | |
| }, | |
| "groupLicensesConsumed": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Total licenses assigned to groups that are in use." | |
| }, | |
| "floatingLicensesConsumed": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Total floating licenses that are in use." | |
| }, | |
| "dedicatedLicensesConsumed": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Total licenses assigned to specific users that are in use." | |
| }, | |
| "groupLicensesAvailable": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Total number of licenses assigned to groups." | |
| }, | |
| "floatingLicensesAvailable": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Total number of licenses that are not dedicated or group-assigned." | |
| }, | |
| "dedicatedLicensesAvailable": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Total number of licenses assigned to specific users." | |
| }, | |
| "enterprise": { | |
| "type": "boolean", | |
| "description": "If true, the license is an enterprise license.", | |
| "default": false | |
| } | |
| }, | |
| "description": "Amalgamated view of license usage vs availability." | |
| }, | |
| "HsmSearchPreviewDTO": { | |
| "type": "object", | |
| "properties": { | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The start index of the results." | |
| }, | |
| "maxNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of the results to return." | |
| }, | |
| "searchId": { | |
| "type": "string", | |
| "description": "The search id to use." | |
| }, | |
| "hsmId": { | |
| "type": "string", | |
| "description": "The hsm id to use." | |
| }, | |
| "searchSortOrders": { | |
| "type": "array", | |
| "description": "The sort orders to use.", | |
| "items": { | |
| "$ref": "#/definitions/SearchSortOrderDTO" | |
| } | |
| }, | |
| "metadataValueCriteria": { | |
| "type": "array", | |
| "description": "The metadata value criteria to use.", | |
| "items": { | |
| "$ref": "#/definitions/MetadataValueCriteria" | |
| } | |
| } | |
| }, | |
| "description": "The representation of the hsm search preview dto object." | |
| }, | |
| "DocumentTypeCopyDTO": { | |
| "type": "object", | |
| "properties": { | |
| "categoryId": { | |
| "type": "string", | |
| "description": "The ID of the category the document type is associated with." | |
| }, | |
| "categoryName": { | |
| "type": "string", | |
| "description": "The name of the category the document type is associated with." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description of the document type." | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the document type." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the document type." | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "The type of document type.", | |
| "enum": [ | |
| "INTERNAL", | |
| "STANDARD", | |
| "DELETED" | |
| ] | |
| }, | |
| "fullText": { | |
| "type": "boolean", | |
| "description": "Flag to indicate document type is full texted.", | |
| "default": false | |
| }, | |
| "version": { | |
| "type": "boolean", | |
| "description": "The version of the document type.", | |
| "default": false | |
| }, | |
| "documentCount": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "The count of the documents associated with the document type." | |
| }, | |
| "retentionPolicy": { | |
| "description": "The retention policy associated with the document type.", | |
| "$ref": "#/definitions/RetentionPolicyDTO" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The flag to indicate if document type is marked for deletion.", | |
| "default": false | |
| }, | |
| "newDocumentTypeDto": { | |
| "description": "The new document type dto to create.", | |
| "$ref": "#/definitions/DocumentTypeDTO" | |
| }, | |
| "existingDocumentTypeId": { | |
| "type": "string", | |
| "description": "The ID of the existing document type to copy." | |
| }, | |
| "copyMetadataFlag": { | |
| "type": "boolean", | |
| "description": "The flag indicating if the document type metadata should be copied or not.", | |
| "default": false | |
| }, | |
| "copySecurityFlag": { | |
| "type": "boolean", | |
| "description": "The flag indicating if the document type security should be copied or not.", | |
| "default": false | |
| }, | |
| "copyIndexingFlag": { | |
| "type": "boolean", | |
| "description": "The flag indicating if the document type indexing configuration should be copied or not.", | |
| "default": false | |
| }, | |
| "copyOverlaysFlag": { | |
| "type": "boolean", | |
| "description": "The flag indicating if the document type overlays should be copied or not.", | |
| "default": false | |
| }, | |
| "copyScanProfileFlag": { | |
| "type": "boolean", | |
| "description": "The flag indicating if the document type scan profiles should be copied or not.", | |
| "default": false | |
| }, | |
| "copyProcessModelFlag": { | |
| "type": "boolean", | |
| "description": "The flag indicating if the document type process models should be copied or not.", | |
| "default": false | |
| }, | |
| "copyRetentionPolicyFlag": { | |
| "type": "boolean", | |
| "description": "The flag indicating if the document type retention policy should be copied or not.", | |
| "default": false | |
| }, | |
| "copyFullTextFlag": { | |
| "type": "boolean", | |
| "description": "The flag indicating if the document type full text should be copied or not.", | |
| "default": false | |
| } | |
| }, | |
| "description": "DocumentType data used to create a new document type based off an existing document type." | |
| }, | |
| "DatasourceResultDTO": { | |
| "type": "object", | |
| "properties": { | |
| "value": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "SearchDocIndexingMetadataDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "metadataId": { | |
| "type": "string" | |
| }, | |
| "valueType": { | |
| "type": "string", | |
| "enum": [ | |
| "VARIABLE", | |
| "STATIC", | |
| "DATASOURCE" | |
| ] | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "ReportImporterSortColumnDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id associated with report importer sort column." | |
| }, | |
| "field": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The field number associated with report importer sort column." | |
| }, | |
| "direction": { | |
| "type": "string", | |
| "description": "The sort direction associated with the sort column, ASC/DESC." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal associated with the sort column." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Flag indicating the column has been marked for deletion.", | |
| "default": false | |
| } | |
| }, | |
| "description": "Sort column configuration for report importer." | |
| }, | |
| "DocumentVariable": { | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "type", | |
| "value" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "document": { | |
| "$ref": "#/definitions/Document" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "HSM" | |
| ] | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "SQLWarning": { | |
| "type": "object", | |
| "properties": { | |
| "cause": { | |
| "$ref": "#/definitions/Throwable" | |
| }, | |
| "stackTrace": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/StackTraceElement" | |
| } | |
| }, | |
| "nextWarning": { | |
| "$ref": "#/definitions/SQLWarning" | |
| }, | |
| "errorCode": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "sqlstate": { | |
| "type": "string" | |
| }, | |
| "nextException": { | |
| "$ref": "#/definitions/SQLException" | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "localizedMessage": { | |
| "type": "string" | |
| }, | |
| "suppressed": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Throwable" | |
| } | |
| } | |
| } | |
| }, | |
| "SearchPromptDatasource": { | |
| "type": "object", | |
| "required": [ | |
| "datasource", | |
| "searchPrompt" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "searchPrompt": { | |
| "$ref": "#/definitions/SearchPrompt" | |
| }, | |
| "datasource": { | |
| "$ref": "#/definitions/Datasource" | |
| }, | |
| "searchPromptDatasourceParameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchPromptDatasourceParam" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "FormInstanceSummaryDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "Gets the id attribute of the FormInstanceSummaryDTO object." | |
| }, | |
| "originator": { | |
| "type": "string", | |
| "description": "Gets the originator attribute of the FormInstanceSummaryDTO object." | |
| }, | |
| "originatorFirstName": { | |
| "type": "string", | |
| "description": "The first name of the originator, if available." | |
| }, | |
| "originatorLastName": { | |
| "type": "string", | |
| "description": "The last name of the originator, if available." | |
| }, | |
| "createDate": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Gets the createDate attribute of the FormInstanceSummaryDTO object." | |
| }, | |
| "lastModifiedUser": { | |
| "type": "string", | |
| "description": "Gets the lastModifiedUser attribute of the FormInstanceSummaryDTO object." | |
| }, | |
| "lastModifiedUserFirstName": { | |
| "type": "string", | |
| "description": "The first name of the last acting user, if available." | |
| }, | |
| "lastModifiedUserLastName": { | |
| "type": "string", | |
| "description": "The last name of the last acting user, if available." | |
| }, | |
| "dateModified": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Gets the dateModified attribute of the FormInstanceSummaryDTO object." | |
| }, | |
| "lockOwner": { | |
| "type": "string", | |
| "description": "Gets the lockOwner attribute of the FormInstanceSummaryDTO object." | |
| }, | |
| "lockOwnerFirstName": { | |
| "type": "string", | |
| "description": "The first name of the lock owner, if available." | |
| }, | |
| "lockOwnerLastName": { | |
| "type": "string", | |
| "description": "The last name of the lock owner, if available." | |
| } | |
| }, | |
| "description": "Dto object for the summary of a FormInstance." | |
| }, | |
| "DatasourcePluginDTO": { | |
| "type": "object", | |
| "properties": { | |
| "configResourcePath": { | |
| "type": "string", | |
| "description": "The config resource path for the plugin dto." | |
| }, | |
| "entryControlResourcePath": { | |
| "type": "string", | |
| "description": "The entry control resource path for the plugin dto." | |
| }, | |
| "datasourceType": { | |
| "type": "string", | |
| "description": "The datasource type." | |
| }, | |
| "displayName": { | |
| "type": "string", | |
| "description": "The display name of the datasource type." | |
| }, | |
| "hasCustomInterface": { | |
| "type": "boolean", | |
| "description": "If true the datasource type has its own custom interface.", | |
| "default": false | |
| }, | |
| "testable": { | |
| "type": "boolean", | |
| "description": "If true the datasource can be tested.", | |
| "default": false | |
| } | |
| }, | |
| "description": "A plugin DTO for Datasources." | |
| }, | |
| "RenderDashboardChartableDTO": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "The chart type.", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "drillDown": { | |
| "description": "The next level of drill down where this chart can go.", | |
| "$ref": "#/definitions/DrillDownDTO" | |
| }, | |
| "rendering": { | |
| "description": "The JSON rendering of the chart.", | |
| "$ref": "#/definitions/RenderedChart" | |
| }, | |
| "title": { | |
| "description": "The chart title definition.", | |
| "$ref": "#/definitions/TitlePropertiesDTO" | |
| }, | |
| "border": { | |
| "description": "The chart border definition.", | |
| "$ref": "#/definitions/ChartBorderDTO" | |
| }, | |
| "parentChartInputs": { | |
| "type": "array", | |
| "description": "The inputs that were given to this chart when rendering. Used when drilling down to the next level.", | |
| "items": { | |
| "$ref": "#/definitions/KeyValuePair" | |
| } | |
| } | |
| }, | |
| "description": "An object defining the information needed to render a chart on a dashboard." | |
| }, | |
| "BarChartDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/ChartDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "INTERNAL", | |
| "STANDARD" | |
| ] | |
| }, | |
| "isLocked": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "lockOwner": { | |
| "type": "string" | |
| }, | |
| "lockOwnerFirstName": { | |
| "type": "string" | |
| }, | |
| "lockOwnerLastName": { | |
| "type": "string" | |
| }, | |
| "dateModified": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "properties": { | |
| "$ref": "#/definitions/ChartablePropertiesDTO" | |
| }, | |
| "datasourceId": { | |
| "type": "string" | |
| }, | |
| "datasourceName": { | |
| "type": "string" | |
| }, | |
| "datasourceParameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DatasourceArgumentDTO" | |
| } | |
| }, | |
| "refreshInterval": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "isValid": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "variables": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartVariableDTO" | |
| } | |
| }, | |
| "datasourceInputs": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartDatasourceInputDTO" | |
| } | |
| }, | |
| "dashboardCount": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "overrideErrorsOnSave": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "chartType": { | |
| "type": "string", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "labelColumn": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| }, | |
| "seriesColumn": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| }, | |
| "dataColumns": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| } | |
| } | |
| }, | |
| "description": "A bar chart." | |
| } | |
| ] | |
| }, | |
| "ShiftMembersOperationDTO": { | |
| "type": "object", | |
| "properties": { | |
| "updateType": { | |
| "type": "string", | |
| "description": "Gets the update type attribute of the object.", | |
| "enum": [ | |
| "USER", | |
| "GROUP" | |
| ] | |
| }, | |
| "shiftId": { | |
| "type": "string", | |
| "description": "Id of the shift that is the target of the operation." | |
| }, | |
| "ids": { | |
| "type": "array", | |
| "description": "Gets the entity ids that should be used to populate the shift, based on update type.", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "description": "DTO representing shift membership changes." | |
| }, | |
| "Attachment": { | |
| "type": "object", | |
| "properties": { | |
| "headers": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "object": { | |
| "type": "object" | |
| }, | |
| "contentType": { | |
| "$ref": "#/definitions/MediaType" | |
| }, | |
| "contentDisposition": { | |
| "$ref": "#/definitions/ContentDisposition" | |
| }, | |
| "dataHandler": { | |
| "$ref": "#/definitions/DataHandler" | |
| }, | |
| "contentId": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "SecurityFilterDTO": { | |
| "type": "object", | |
| "properties": { | |
| "comparatorType": { | |
| "type": "string", | |
| "description": "The comparator type used when evaluating the filter.", | |
| "enum": [ | |
| "EQUALS", | |
| "NOT_EQUALS", | |
| "GREATER_THAN", | |
| "LESS_THAN", | |
| "GREATER_THAN_EQUALS", | |
| "LESS_THAN_EQUALS", | |
| "CONTAINS", | |
| "NOT_CONTAINS", | |
| "IN" | |
| ] | |
| }, | |
| "connectiveType": { | |
| "type": "string", | |
| "description": "The connective type used when evaluating the filter.", | |
| "enum": [ | |
| "AND", | |
| "OR" | |
| ] | |
| }, | |
| "dateValue": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "The date value to use in the filter." | |
| }, | |
| "decimalValue": { | |
| "type": "number", | |
| "format": "double", | |
| "description": "The decimal value to use in the filter." | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "The unique identifier of this filter." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal of this filter in the list for this permission type." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "metadataId": { | |
| "type": "string", | |
| "description": "The ID of the metadata object that this filter checks against." | |
| }, | |
| "metadataName": { | |
| "type": "string", | |
| "description": "The name of the metadata object that this filter checks against." | |
| }, | |
| "metadataType": { | |
| "type": "string", | |
| "description": "The type of the metadata object that this filter checks against.", | |
| "enum": [ | |
| "DATE", | |
| "INTEGER", | |
| "DECIMAL", | |
| "STRING_VARIABLE" | |
| ] | |
| }, | |
| "numericValue": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The integer value to use in the filter." | |
| }, | |
| "strValue": { | |
| "type": "string", | |
| "description": "The string value to use in the filter." | |
| } | |
| }, | |
| "description": "An object representing a security filter used in document security." | |
| }, | |
| "TooltipsPropertiesDTO": { | |
| "type": "object", | |
| "properties": { | |
| "visible": { | |
| "type": "boolean", | |
| "description": "Whether the tooltips are visible.", | |
| "default": false | |
| }, | |
| "includeName": { | |
| "type": "boolean", | |
| "description": "Whether tooltips include the item name.", | |
| "default": false | |
| }, | |
| "includeValue": { | |
| "type": "boolean", | |
| "description": "Whether the tooltips include the item value.", | |
| "default": false | |
| }, | |
| "includeCrosshair": { | |
| "type": "boolean", | |
| "description": "Whether the tooltips include a crosshair.", | |
| "default": false | |
| } | |
| }, | |
| "description": "Configuration for the tooltips for a chart." | |
| }, | |
| "GroupMemberDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/GroupMemberDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "FormDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "Gets the id attribute of the FormDTO object." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Gets the name attribute of the FormDTO object." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Gets the description attribute of the FormDTO object." | |
| }, | |
| "version": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Gets the version attribute of the FormDTO object." | |
| }, | |
| "isLocked": { | |
| "type": "boolean", | |
| "description": "Gets the isLocked attribute of the FormDTO object.", | |
| "default": false | |
| }, | |
| "lockOwner": { | |
| "type": "string", | |
| "description": "Gets the lockOwner attribute of the FormDTO object." | |
| }, | |
| "dateModified": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "Gets the dateModified attribute of the FormDTO object." | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "Gets the status attribute of the FormDTO object.", | |
| "enum": [ | |
| "ACTIVE", | |
| "INACTIVE", | |
| "INACTIVE_STILL_RUNNING", | |
| "DELETED" | |
| ] | |
| }, | |
| "width": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Gets the width attribute of the FormDTO object." | |
| }, | |
| "height": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Gets the height attribute of the FormDTO object." | |
| }, | |
| "currentStepId": { | |
| "type": "string", | |
| "description": "Gets the currentStepId attribute of the FormDTO object." | |
| }, | |
| "allowAnonymousAccessToView": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "allowAnonymousAccessToEdit": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "formControls": { | |
| "type": "array", | |
| "description": "Gets the formControls attribute of the FormDTO object.", | |
| "items": { | |
| "$ref": "#/definitions/FormControlDTO" | |
| } | |
| }, | |
| "steps": { | |
| "type": "array", | |
| "description": "Gets the steps attribute of the FormDTO object.", | |
| "items": { | |
| "$ref": "#/definitions/FormStepDTO" | |
| } | |
| }, | |
| "styles": { | |
| "type": "string", | |
| "description": "Gets the styles attribute of the FormDTO object." | |
| } | |
| }, | |
| "description": "A data transfer object representing a form design." | |
| }, | |
| "ViewPromptDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "View prompt id." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "View prompt name." | |
| }, | |
| "displayLabel": { | |
| "type": "string", | |
| "description": "View prompt display label." | |
| }, | |
| "fieldType": { | |
| "type": "string", | |
| "description": "View prompt field type.", | |
| "enum": [ | |
| "TEXT", | |
| "LIST" | |
| ] | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "View prompt data type.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "NUMBER" | |
| ] | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "View prompt datasource id." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "View prompt datasource name." | |
| }, | |
| "validatorDisplayDtos": { | |
| "type": "array", | |
| "description": "View prompt validator display dtos.", | |
| "items": { | |
| "$ref": "#/definitions/ValidatorDisplayDTO" | |
| } | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "View prompt ordinal." | |
| }, | |
| "defaultValue": { | |
| "type": "string", | |
| "description": "View prompt default value." | |
| }, | |
| "defaultValueType": { | |
| "type": "string", | |
| "description": "View prompt default value type.", | |
| "enum": [ | |
| "NONE", | |
| "STATIC", | |
| "USE_DATASOURCE" | |
| ] | |
| }, | |
| "prePopulateValues": { | |
| "type": "array", | |
| "description": "Pre-populated values for the view prompts.", | |
| "items": { | |
| "$ref": "#/definitions/VariableDTO" | |
| } | |
| }, | |
| "viewPromptResult": { | |
| "description": "View prompt result dto.", | |
| "$ref": "#/definitions/ViewPromptResultDTO" | |
| } | |
| }, | |
| "description": "View prompt configuration information." | |
| }, | |
| "ScalePropertiesDTO": { | |
| "type": "object", | |
| "properties": { | |
| "x": { | |
| "description": "The X axis configuration.", | |
| "$ref": "#/definitions/AxisScaleDTO" | |
| }, | |
| "y": { | |
| "description": "The Y axis configuration.", | |
| "$ref": "#/definitions/AxisScaleDTO" | |
| }, | |
| "r": { | |
| "description": "The R scale configuration.", | |
| "$ref": "#/definitions/RadialScaleDTO" | |
| } | |
| }, | |
| "description": "An object containing a chart's scale configuration." | |
| }, | |
| "DirectoryImporterDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/ImporterDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the importer." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the importer." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description to be used by the importer." | |
| }, | |
| "running": { | |
| "type": "boolean", | |
| "description": "Flag indicating that the importer is running.", | |
| "default": false | |
| }, | |
| "idle": { | |
| "type": "boolean", | |
| "description": "Flag indicating importer is running but not processing.", | |
| "default": false | |
| }, | |
| "server": { | |
| "type": "string", | |
| "description": "The server details where the importer will run." | |
| }, | |
| "processType": { | |
| "type": "string", | |
| "description": "Importer process type.Values allowed are EMAIL,REPORT,COLD,OBJECT,INDEX.", | |
| "enum": [ | |
| "EMAIL", | |
| "REPORT", | |
| "INDEX", | |
| "OBJECT", | |
| "COLD" | |
| ] | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "The importer status INTERNAL/EXTERNAL.", | |
| "enum": [ | |
| "INTERNAL", | |
| "ACTIVE" | |
| ] | |
| }, | |
| "preRender": { | |
| "type": "boolean", | |
| "description": "Flag indicating that files imported by the importer will be pre-rendered.", | |
| "default": false | |
| }, | |
| "pollingFrequency": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Numeric indicating how often the importer would poll for files in the monitored directory/email folder." | |
| }, | |
| "pollingUnits": { | |
| "type": "string", | |
| "description": "String indicating what units the polling frequency uses. Valid values are SECONDS,MINUTES,HOURS,DAYS.", | |
| "enum": [ | |
| "SECONDS", | |
| "MINUTES", | |
| "HOURS", | |
| "DAYS" | |
| ] | |
| }, | |
| "calculatedProperties": { | |
| "type": "array", | |
| "description": "The calculated properties to be used by the importer.", | |
| "items": { | |
| "$ref": "#/definitions/CalculatedPropertyDTO" | |
| } | |
| }, | |
| "ruleSets": { | |
| "type": "array", | |
| "description": "The rulesets to be used by the importer.", | |
| "items": { | |
| "$ref": "#/definitions/RuleSetDTO" | |
| } | |
| }, | |
| "importerPluginName": { | |
| "type": "string", | |
| "description": "The plugin to be used by the importer." | |
| }, | |
| "schedule": { | |
| "description": "The importer schedule.", | |
| "$ref": "#/definitions/GenericScheduleDTO" | |
| }, | |
| "lastErrorMessage": { | |
| "type": "string", | |
| "description": "The last error message associated with the importer." | |
| }, | |
| "pending": { | |
| "type": "boolean", | |
| "description": "Flag indicating that start/stop of importer is pending.", | |
| "default": false | |
| }, | |
| "get_class": { | |
| "type": "string" | |
| }, | |
| "importerSettings": { | |
| "type": "string" | |
| }, | |
| "directoryPath": { | |
| "type": "string", | |
| "description": "The directory path being monitored by the importer." | |
| }, | |
| "fileFilter": { | |
| "type": "string", | |
| "description": "The file filter to be used by the importer." | |
| }, | |
| "serial": { | |
| "type": "boolean", | |
| "description": "Flag indicating the files are to be processed serially.", | |
| "default": false | |
| } | |
| }, | |
| "description": "A parent class for all Kendo charts." | |
| } | |
| ] | |
| }, | |
| "CompleteJobWrapperDTO": { | |
| "type": "object", | |
| "properties": { | |
| "jobId": { | |
| "type": "string" | |
| }, | |
| "actorId": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "LegalHoldCustodian": { | |
| "type": "object", | |
| "required": [ | |
| "legalHoldCase", | |
| "user" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "legalHoldCase": { | |
| "$ref": "#/definitions/LegalHoldCase" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/User" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "newObject": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "PasswordRuleWrapperDTO": { | |
| "type": "object", | |
| "properties": { | |
| "passwordRuleDto": { | |
| "description": "The password rule DTO, containing all rule data.", | |
| "$ref": "#/definitions/PasswordRuleDTO" | |
| }, | |
| "invalidateCurrentPasswords": { | |
| "type": "boolean", | |
| "description": "The flag to indicate whether or not current passwords should be invalidated on update.", | |
| "default": false | |
| }, | |
| "passwordRetentionCount": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The number of passwords that should be retained by the system to ensure that the user does not continue to using the same password over and over again." | |
| } | |
| }, | |
| "description": "Wrapper DTO for working with strong password rules for the system." | |
| }, | |
| "DatasourceArgumentDTO": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the property." | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "The value of the property in string form." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type of the property.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "dataValue": { | |
| "type": "object" | |
| } | |
| }, | |
| "description": "An argument to be sent to a datasource." | |
| }, | |
| "GroupAssociationDTO": { | |
| "type": "object", | |
| "properties": { | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The start index for paging." | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The max results for a page." | |
| }, | |
| "entityType": { | |
| "type": "string", | |
| "description": "The type of entity.", | |
| "enum": [ | |
| "BATCHES", | |
| "DASHBOARDS", | |
| "EXPORT_PROFILES", | |
| "FAX", | |
| "FORMS", | |
| "JOB_VIEWS", | |
| "PRINTER", | |
| "PROCESS_MODELS", | |
| "SEARCH", | |
| "SECURITY_ACCESS", | |
| "SCAN_PROFILES", | |
| "USERS", | |
| "FEATURE_RIGHTS" | |
| ] | |
| }, | |
| "entityIds": { | |
| "type": "array", | |
| "description": "The entity IDs.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "filters": { | |
| "description": "The filters.", | |
| "$ref": "#/definitions/Filters" | |
| } | |
| }, | |
| "description": "An object representing a group." | |
| }, | |
| "DispositionQueue": { | |
| "type": "object", | |
| "required": [ | |
| "dateCreated", | |
| "retentionPolicy" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "retentionPolicy": { | |
| "$ref": "#/definitions/RetentionPolicy" | |
| }, | |
| "dateCreated": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "items": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/DispositionQueueItem" | |
| } | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "ObjectImporterDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/DirectoryImporterDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the importer." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the importer." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description to be used by the importer." | |
| }, | |
| "running": { | |
| "type": "boolean", | |
| "description": "Flag indicating that the importer is running.", | |
| "default": false | |
| }, | |
| "idle": { | |
| "type": "boolean", | |
| "description": "Flag indicating importer is running but not processing.", | |
| "default": false | |
| }, | |
| "server": { | |
| "type": "string", | |
| "description": "The server details where the importer will run." | |
| }, | |
| "processType": { | |
| "type": "string", | |
| "description": "Importer process type.Values allowed are EMAIL,REPORT,COLD,OBJECT,INDEX.", | |
| "enum": [ | |
| "EMAIL", | |
| "REPORT", | |
| "INDEX", | |
| "OBJECT", | |
| "COLD" | |
| ] | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "The importer status INTERNAL/EXTERNAL.", | |
| "enum": [ | |
| "INTERNAL", | |
| "ACTIVE" | |
| ] | |
| }, | |
| "preRender": { | |
| "type": "boolean", | |
| "description": "Flag indicating that files imported by the importer will be pre-rendered.", | |
| "default": false | |
| }, | |
| "pollingFrequency": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Numeric indicating how often the importer would poll for files in the monitored directory/email folder." | |
| }, | |
| "pollingUnits": { | |
| "type": "string", | |
| "description": "String indicating what units the polling frequency uses. Valid values are SECONDS,MINUTES,HOURS,DAYS.", | |
| "enum": [ | |
| "SECONDS", | |
| "MINUTES", | |
| "HOURS", | |
| "DAYS" | |
| ] | |
| }, | |
| "calculatedProperties": { | |
| "type": "array", | |
| "description": "The calculated properties to be used by the importer.", | |
| "items": { | |
| "$ref": "#/definitions/CalculatedPropertyDTO" | |
| } | |
| }, | |
| "ruleSets": { | |
| "type": "array", | |
| "description": "The rulesets to be used by the importer.", | |
| "items": { | |
| "$ref": "#/definitions/RuleSetDTO" | |
| } | |
| }, | |
| "importerPluginName": { | |
| "type": "string", | |
| "description": "The plugin to be used by the importer." | |
| }, | |
| "schedule": { | |
| "description": "The importer schedule.", | |
| "$ref": "#/definitions/GenericScheduleDTO" | |
| }, | |
| "lastErrorMessage": { | |
| "type": "string", | |
| "description": "The last error message associated with the importer." | |
| }, | |
| "pending": { | |
| "type": "boolean", | |
| "description": "Flag indicating that start/stop of importer is pending.", | |
| "default": false | |
| }, | |
| "get_class": { | |
| "type": "string" | |
| }, | |
| "importerSettings": { | |
| "type": "string" | |
| }, | |
| "directoryPath": { | |
| "type": "string", | |
| "description": "The directory path being monitored by the importer." | |
| }, | |
| "fileFilter": { | |
| "type": "string", | |
| "description": "The file filter to be used by the importer." | |
| }, | |
| "serial": { | |
| "type": "boolean", | |
| "description": "Flag indicating the files are to be processed serially.", | |
| "default": false | |
| } | |
| }, | |
| "description": "An object importer." | |
| } | |
| ] | |
| }, | |
| "SearchResultFormDTO": { | |
| "type": "object", | |
| "properties": { | |
| "formDesignName": { | |
| "type": "string" | |
| }, | |
| "formEditable": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "searchFormData": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormInstanceDataDTO" | |
| } | |
| } | |
| } | |
| }, | |
| "IndexImporterDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/DirectoryImporterDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the importer." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the importer." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description to be used by the importer." | |
| }, | |
| "running": { | |
| "type": "boolean", | |
| "description": "Flag indicating that the importer is running.", | |
| "default": false | |
| }, | |
| "idle": { | |
| "type": "boolean", | |
| "description": "Flag indicating importer is running but not processing.", | |
| "default": false | |
| }, | |
| "server": { | |
| "type": "string", | |
| "description": "The server details where the importer will run." | |
| }, | |
| "processType": { | |
| "type": "string", | |
| "description": "Importer process type.Values allowed are EMAIL,REPORT,COLD,OBJECT,INDEX.", | |
| "enum": [ | |
| "EMAIL", | |
| "REPORT", | |
| "INDEX", | |
| "OBJECT", | |
| "COLD" | |
| ] | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "The importer status INTERNAL/EXTERNAL.", | |
| "enum": [ | |
| "INTERNAL", | |
| "ACTIVE" | |
| ] | |
| }, | |
| "preRender": { | |
| "type": "boolean", | |
| "description": "Flag indicating that files imported by the importer will be pre-rendered.", | |
| "default": false | |
| }, | |
| "pollingFrequency": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Numeric indicating how often the importer would poll for files in the monitored directory/email folder." | |
| }, | |
| "pollingUnits": { | |
| "type": "string", | |
| "description": "String indicating what units the polling frequency uses. Valid values are SECONDS,MINUTES,HOURS,DAYS.", | |
| "enum": [ | |
| "SECONDS", | |
| "MINUTES", | |
| "HOURS", | |
| "DAYS" | |
| ] | |
| }, | |
| "calculatedProperties": { | |
| "type": "array", | |
| "description": "The calculated properties to be used by the importer.", | |
| "items": { | |
| "$ref": "#/definitions/CalculatedPropertyDTO" | |
| } | |
| }, | |
| "ruleSets": { | |
| "type": "array", | |
| "description": "The rulesets to be used by the importer.", | |
| "items": { | |
| "$ref": "#/definitions/RuleSetDTO" | |
| } | |
| }, | |
| "importerPluginName": { | |
| "type": "string", | |
| "description": "The plugin to be used by the importer." | |
| }, | |
| "schedule": { | |
| "description": "The importer schedule.", | |
| "$ref": "#/definitions/GenericScheduleDTO" | |
| }, | |
| "lastErrorMessage": { | |
| "type": "string", | |
| "description": "The last error message associated with the importer." | |
| }, | |
| "pending": { | |
| "type": "boolean", | |
| "description": "Flag indicating that start/stop of importer is pending.", | |
| "default": false | |
| }, | |
| "get_class": { | |
| "type": "string" | |
| }, | |
| "importerSettings": { | |
| "type": "string" | |
| }, | |
| "directoryPath": { | |
| "type": "string", | |
| "description": "The directory path being monitored by the importer." | |
| }, | |
| "fileFilter": { | |
| "type": "string", | |
| "description": "The file filter to be used by the importer." | |
| }, | |
| "serial": { | |
| "type": "boolean", | |
| "description": "Flag indicating the files are to be processed serially.", | |
| "default": false | |
| }, | |
| "importMethod": { | |
| "type": "string", | |
| "description": "The import method associated with the index import. MOVE, COPY, IN_PLACE", | |
| "enum": [ | |
| "COPY", | |
| "MOVE", | |
| "IN_PLACE", | |
| "NONE", | |
| "IMPORT_EXTERNAL" | |
| ] | |
| }, | |
| "delimiter": { | |
| "type": "string", | |
| "description": "The delimiter for the index file." | |
| }, | |
| "filePathField": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The field index that holds file path in the index file." | |
| }, | |
| "externalRepositoryPluginName": { | |
| "type": "string", | |
| "description": "The repository plugin to be used by the importer." | |
| }, | |
| "properties": { | |
| "type": "array", | |
| "description": "The properties to be used by the importer.", | |
| "items": { | |
| "$ref": "#/definitions/PropertyDTO" | |
| } | |
| } | |
| }, | |
| "description": "An index importer." | |
| } | |
| ] | |
| }, | |
| "ComparableObject": { | |
| "type": "object" | |
| }, | |
| "DocumentHierarchyDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "xml": { | |
| "name": "result" | |
| }, | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/DocumentHierarchyDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "ClipboardItemDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of this item." | |
| }, | |
| "userId": { | |
| "type": "string", | |
| "description": "The user ID." | |
| }, | |
| "documentId": { | |
| "type": "string", | |
| "description": "The document ID." | |
| }, | |
| "displayName": { | |
| "type": "string", | |
| "description": "The display name for the document." | |
| } | |
| }, | |
| "description": "Object representing an item on the clipboard for a user." | |
| }, | |
| "ObjectDTO": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "dataType": { | |
| "type": "string" | |
| }, | |
| "fields": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ObjectDTO" | |
| } | |
| } | |
| } | |
| }, | |
| "BatchDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/BatchDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "RenderedChart": { | |
| "type": "object" | |
| }, | |
| "Role": { | |
| "type": "object", | |
| "required": [ | |
| "roleName" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "actors": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Actor" | |
| } | |
| }, | |
| "roleName": { | |
| "type": "string" | |
| }, | |
| "originalName": { | |
| "type": "string" | |
| }, | |
| "nameChanged": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validateOrdinals": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validateActors": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "ChecklistSearchResultDTO": { | |
| "type": "object", | |
| "properties": { | |
| "searchDisplayName": { | |
| "type": "string" | |
| }, | |
| "subSearches": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SubSearchResultsDTO" | |
| } | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "fulfilled": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "DeviceConfigurationSpecDTO": { | |
| "type": "object", | |
| "required": [ | |
| "label", | |
| "name", | |
| "required" | |
| ], | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the field." | |
| }, | |
| "label": { | |
| "type": "string", | |
| "description": "The label shown to the user when configuring the field." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "A description for the field." | |
| }, | |
| "required": { | |
| "type": "boolean", | |
| "description": "Whether the field is required.", | |
| "default": false | |
| } | |
| }, | |
| "description": "An object used to configure a single property of a Fax plugin." | |
| }, | |
| "HsmDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the HSM configuration." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the HSM configuration." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description of the HSM configuration." | |
| }, | |
| "searchDto": { | |
| "description": "The searchDTO associated with the HSM configuration.", | |
| "$ref": "#/definitions/SearchDTO" | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "The status of the HSM configuration.", | |
| "enum": [ | |
| "ACTIVE", | |
| "INACTIVE" | |
| ] | |
| }, | |
| "occurrenceType": { | |
| "type": "string", | |
| "description": "The occurrence type of the HSM configuration.", | |
| "enum": [ | |
| "DAILY", | |
| "WEEKLY", | |
| "MONTHLY" | |
| ] | |
| }, | |
| "action": { | |
| "description": "The hsm actions of the HSM configuration.", | |
| "$ref": "#/definitions/HsmActionDTO" | |
| }, | |
| "times": { | |
| "type": "array", | |
| "description": "The schedule of the HSM configuration.", | |
| "items": { | |
| "$ref": "#/definitions/HsmScheduledTimeDTO" | |
| } | |
| }, | |
| "runningStatus": { | |
| "type": "boolean", | |
| "description": "Boolean indicating status of the HSM configuration.", | |
| "default": false | |
| }, | |
| "stopTime": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "Date indicating stop time of the HSM configuration." | |
| }, | |
| "server": { | |
| "type": "string", | |
| "description": "The server where the HSM configuration is to be executed." | |
| }, | |
| "processModelName": { | |
| "type": "string", | |
| "description": "The process model name." | |
| } | |
| }, | |
| "description": "The definition of HSM configuration." | |
| }, | |
| "SearchDocIndexing": { | |
| "type": "object", | |
| "required": [ | |
| "allowDocCreation", | |
| "search" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "search": { | |
| "$ref": "#/definitions/Search" | |
| }, | |
| "allowDocCreation": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "documentType": { | |
| "$ref": "#/definitions/DocumentType" | |
| }, | |
| "searchDocIndexingMetadata": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchDocIndexingMetadata" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "FormInstanceData": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "formInstance": { | |
| "$ref": "#/definitions/FormInstance" | |
| }, | |
| "formControl": { | |
| "$ref": "#/definitions/FormControl" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "value": { | |
| "type": "object" | |
| }, | |
| "arrayType": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "PieChartDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/ChartDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "INTERNAL", | |
| "STANDARD" | |
| ] | |
| }, | |
| "isLocked": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "lockOwner": { | |
| "type": "string" | |
| }, | |
| "lockOwnerFirstName": { | |
| "type": "string" | |
| }, | |
| "lockOwnerLastName": { | |
| "type": "string" | |
| }, | |
| "dateModified": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "properties": { | |
| "$ref": "#/definitions/ChartablePropertiesDTO" | |
| }, | |
| "datasourceId": { | |
| "type": "string" | |
| }, | |
| "datasourceName": { | |
| "type": "string" | |
| }, | |
| "datasourceParameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DatasourceArgumentDTO" | |
| } | |
| }, | |
| "refreshInterval": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "isValid": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "variables": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartVariableDTO" | |
| } | |
| }, | |
| "datasourceInputs": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartDatasourceInputDTO" | |
| } | |
| }, | |
| "dashboardCount": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "overrideErrorsOnSave": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "chartType": { | |
| "type": "string", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "labelColumn": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| }, | |
| "seriesColumn": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| }, | |
| "dataColumns": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| } | |
| } | |
| }, | |
| "description": "A pie chart." | |
| } | |
| ] | |
| }, | |
| "MetadataValueDTO": { | |
| "type": "object", | |
| "properties": { | |
| "dateValue": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "decimalValue": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "documentCount": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "documentId": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "metadataId": { | |
| "type": "string" | |
| }, | |
| "metadataName": { | |
| "type": "string" | |
| }, | |
| "numericValue": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "strValue": { | |
| "type": "string" | |
| }, | |
| "metadataType": { | |
| "type": "string", | |
| "enum": [ | |
| "DATE", | |
| "INTEGER", | |
| "DECIMAL", | |
| "STRING_VARIABLE" | |
| ] | |
| }, | |
| "currencyLocale": { | |
| "type": "string" | |
| }, | |
| "decimalPrecision": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "isCurrency": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "DashboardGroupDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "description": "The current page of dashboard group results.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardGroupDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged search result for dashboard groups." | |
| }, | |
| "TitlePropertiesDTO": { | |
| "type": "object", | |
| "properties": { | |
| "text": { | |
| "type": "string", | |
| "description": "The title text." | |
| }, | |
| "font": { | |
| "description": "The font definition.", | |
| "$ref": "#/definitions/TitleFontDTO" | |
| }, | |
| "textAlignment": { | |
| "type": "string", | |
| "description": "The text alignment.", | |
| "enum": [ | |
| "LEFT", | |
| "RIGHT", | |
| "CENTER" | |
| ] | |
| } | |
| }, | |
| "description": "An object that defines the title of a chart." | |
| }, | |
| "LicenseRevocationDTO": { | |
| "type": "object", | |
| "properties": { | |
| "username": { | |
| "type": "string", | |
| "description": "Username to revoke." | |
| }, | |
| "ipAddress": { | |
| "type": "string", | |
| "description": "Unique identifier representing the host device using the license." | |
| } | |
| }, | |
| "description": "A username and IP address identifier used to revoke licenses for a specific user on a specific host." | |
| }, | |
| "Form": { | |
| "type": "object", | |
| "required": [ | |
| "dateModified", | |
| "height", | |
| "isLocked", | |
| "name", | |
| "status", | |
| "version", | |
| "width" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "isLocked": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "lockOwner": { | |
| "type": "string" | |
| }, | |
| "dateModified": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "ACTIVE", | |
| "INACTIVE", | |
| "INACTIVE_STILL_RUNNING", | |
| "DELETED" | |
| ] | |
| }, | |
| "formInstances": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormInstance" | |
| } | |
| }, | |
| "width": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "height": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "styles": { | |
| "type": "string" | |
| }, | |
| "allowAnonymousAccessToView": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "allowAnonymousAccessToEdit": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "formControls": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormControl" | |
| } | |
| }, | |
| "steps": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormStep" | |
| } | |
| }, | |
| "currentStep": { | |
| "$ref": "#/definitions/FormStep" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "ShiftPartDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "startDay": { | |
| "type": "string", | |
| "enum": [ | |
| "MONDAY", | |
| "TUESDAY", | |
| "WEDNESDAY", | |
| "THURSDAY", | |
| "FRIDAY", | |
| "SATURDAY", | |
| "SUNDAY" | |
| ] | |
| }, | |
| "startHour": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "startMinute": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "endDay": { | |
| "type": "string", | |
| "enum": [ | |
| "MONDAY", | |
| "TUESDAY", | |
| "WEDNESDAY", | |
| "THURSDAY", | |
| "FRIDAY", | |
| "SATURDAY", | |
| "SUNDAY" | |
| ] | |
| }, | |
| "endHour": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "endMinute": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "SaveChartAsDTO": { | |
| "type": "object", | |
| "properties": { | |
| "chart": { | |
| "description": "The chart to be saved.", | |
| "$ref": "#/definitions/ChartableDTO" | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the new chart." | |
| }, | |
| "overwriteDesignId": { | |
| "type": "string", | |
| "description": "The ID of a chart to be overwritten with this chart." | |
| } | |
| }, | |
| "description": "An object that contains all the data necessary to invoke a save as operation on a chart." | |
| }, | |
| "DispositionCondition": { | |
| "type": "object", | |
| "required": [ | |
| "period", | |
| "retentionPolicy", | |
| "target", | |
| "timeUnit" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "retentionPolicy": { | |
| "$ref": "#/definitions/RetentionPolicy" | |
| }, | |
| "timeUnit": { | |
| "type": "string", | |
| "enum": [ | |
| "DAYS", | |
| "WEEKS", | |
| "MONTHS", | |
| "YEARS" | |
| ] | |
| }, | |
| "period": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": 0 | |
| }, | |
| "target": { | |
| "type": "string", | |
| "enum": [ | |
| "DATE_METADATA", | |
| "DOCUMENT_CREATED_DATE", | |
| "DOCUMENT_INDEXED_DATE", | |
| "DOCUMENT_LAST_VIEWED_DATE", | |
| "FILE_CREATED_DATE" | |
| ] | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Metadata" | |
| }, | |
| "validateDateMetadata": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "FormMonitoringDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "Gets the id attribute of the FormMonitoringDTO object." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Gets the name attribute of the FormMonitoringDTO object." | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "Gets the status attribute of the FormMonitoringDTO object." | |
| }, | |
| "version": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Gets the version attribute of the FormMonitoringDTO object." | |
| }, | |
| "numInstances": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Gets the numInstances attribute of the FormMonitoringDTO object." | |
| }, | |
| "checkedOutBy": { | |
| "type": "string", | |
| "description": "Gets the checkedOutBy attribute of the FormMonitoringDTO object." | |
| } | |
| }, | |
| "description": "Dto object that populates the initial form monitoring screen." | |
| }, | |
| "DeviceGroupDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "groupName": { | |
| "type": "string" | |
| }, | |
| "groupId": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ExternalFileStoreProp": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "fileStore": { | |
| "$ref": "#/definitions/FileStore" | |
| }, | |
| "keyName": { | |
| "type": "string" | |
| }, | |
| "keyValue": { | |
| "type": "string" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "RadialScaleDTO": { | |
| "type": "object", | |
| "properties": { | |
| "minimum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The minimum value of the scale." | |
| }, | |
| "maximum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum value of the scale." | |
| }, | |
| "increment": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The scale increment." | |
| }, | |
| "label": { | |
| "type": "string", | |
| "description": "The axis label." | |
| }, | |
| "format": { | |
| "description": "The format for the axis label.", | |
| "$ref": "#/definitions/FormatDTO" | |
| }, | |
| "precision": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The scale precision." | |
| }, | |
| "labelRotation": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The rotation of axis labels." | |
| }, | |
| "ranges": { | |
| "type": "array", | |
| "description": "The color ranges for the scale.", | |
| "items": { | |
| "$ref": "#/definitions/RadialRangeDTO" | |
| } | |
| } | |
| }, | |
| "description": "The confiuration for the R axis for a chart." | |
| }, | |
| "CalculatedPropertyDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the calculated property." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the calculated property." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal of the calculated property." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type of the calculated property." | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "The value of the calculated property." | |
| }, | |
| "valueType": { | |
| "type": "string", | |
| "description": "The type of value, either variable, static, macro, or datasource.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "VARIABLE", | |
| "MIXED" | |
| ] | |
| }, | |
| "defaultValue": { | |
| "type": "string", | |
| "description": "The default value of the calculated property." | |
| }, | |
| "format": { | |
| "type": "string", | |
| "description": "The date format if calculated property is a date." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The datasource id associated with the calculated property." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "The name of the datasource associated with the calculated property." | |
| }, | |
| "datasourceParameters": { | |
| "type": "array", | |
| "description": "The datasource parameters.", | |
| "items": { | |
| "$ref": "#/definitions/CalculatedPropertyDatasourceParameterDTO" | |
| } | |
| }, | |
| "importerId": { | |
| "type": "string", | |
| "description": "The importer id the calcualted property is associated with." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Flag indicating the calculated property has been deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The representation of the calculated property associated with the importer." | |
| }, | |
| "FormDocument": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "formInstance": { | |
| "$ref": "#/definitions/FormInstance" | |
| }, | |
| "document": { | |
| "$ref": "#/definitions/Document" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "ExporterProfileDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id associated with the exporter profile." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the exporter profile." | |
| }, | |
| "exportType": { | |
| "type": "string", | |
| "description": "The type of the exporter profile. Valid types are NATIVE, PDF,PDFA, SINGLE_PDF", | |
| "enum": [ | |
| "NATIVE", | |
| "PDF", | |
| "PDFA", | |
| "SINGLE_PDF" | |
| ] | |
| }, | |
| "burnAnnotation": { | |
| "type": "boolean", | |
| "description": "Flag to indicate if annotations must be burnt onto exported documents.", | |
| "default": false | |
| }, | |
| "burnRedaction": { | |
| "type": "boolean", | |
| "description": "Flag to indicate if redactions must be burnt onto exported documents.", | |
| "default": false | |
| }, | |
| "documentNameFormat": { | |
| "type": "string", | |
| "description": "Get the document name format for the exported documents." | |
| }, | |
| "directoryStructure": { | |
| "type": "string", | |
| "description": "Get the directory structure for the exported documents." | |
| }, | |
| "maximumFileSize": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Get the maximum file size for the exported documents." | |
| }, | |
| "outputFileName": { | |
| "type": "string", | |
| "description": "Get the output file name for the exported documents." | |
| }, | |
| "createdBy": { | |
| "type": "string", | |
| "description": "Get the username that created the exporter profile." | |
| }, | |
| "fileSizeUnits": { | |
| "type": "string", | |
| "description": "The file size units associated with the profile. Valid values are KB, MB and GB", | |
| "enum": [ | |
| "KB", | |
| "MB", | |
| "GB" | |
| ] | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description of the exporter profile" | |
| } | |
| }, | |
| "description": "The definition of an exporter profile." | |
| }, | |
| "StorageTypeDTO": { | |
| "type": "object", | |
| "properties": { | |
| "compression": { | |
| "type": "string", | |
| "description": "The compression attribute of the storage type." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description attribute of the storage type." | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "The unique identifier of the storage type." | |
| }, | |
| "pixelType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The pixel type attribute of the storage type." | |
| } | |
| }, | |
| "description": "The representation of the storage type entity used for scanning configuration." | |
| }, | |
| "DataStoreDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "xml": { | |
| "name": "result" | |
| }, | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/DataStoreDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "RetentionPolicy": { | |
| "type": "object", | |
| "required": [ | |
| "dispositionMethod", | |
| "name", | |
| "numberOfApprovals", | |
| "type" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "DEFAULT", | |
| "USER" | |
| ] | |
| }, | |
| "dispositionMethod": { | |
| "type": "string", | |
| "enum": [ | |
| "DELETE", | |
| "PURGE", | |
| "KEEP" | |
| ] | |
| }, | |
| "condition": { | |
| "$ref": "#/definitions/DispositionCondition" | |
| }, | |
| "numberOfApprovals": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": 0 | |
| }, | |
| "processModelName": { | |
| "type": "string" | |
| }, | |
| "convertToPDFA": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "custodians": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/RetentionPolicyCustodian" | |
| } | |
| }, | |
| "documentTypes": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/DocumentType" | |
| } | |
| }, | |
| "pendingApprovals": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/DispositionQueue" | |
| } | |
| }, | |
| "default": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "activeDocumentTypes": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/DocumentType" | |
| } | |
| }, | |
| "validateRequiredCondition": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validateRequiredCustodian": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validateCustodianOrder": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validateApprovalsMustHaveProcessModel": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validateProcessModelMustHaveApprovalsGreaterThanZero": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "SearchSortOrder": { | |
| "type": "object", | |
| "required": [ | |
| "attributeName", | |
| "attributeType", | |
| "name", | |
| "orderType", | |
| "ordinal", | |
| "search" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "search": { | |
| "$ref": "#/definitions/Search" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "attributeType": { | |
| "type": "string", | |
| "enum": [ | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "FULL_TEXT", | |
| "DIARY", | |
| "METADATA", | |
| "OTHER", | |
| "STORED_PROC_PARAM", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES", | |
| "FILE_TYPE", | |
| "HIDDEN", | |
| "HIDDEN_DATE", | |
| "HIDDEN_INTEGER", | |
| "HIDDEN_DECIMAL" | |
| ] | |
| }, | |
| "attributeName": { | |
| "type": "string" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Metadata" | |
| }, | |
| "orderType": { | |
| "type": "string", | |
| "enum": [ | |
| "ASC", | |
| "DESC", | |
| "CUSTOM" | |
| ] | |
| }, | |
| "customValues": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchSortOrderCustom" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "attributeId": { | |
| "type": "string" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "FormControlConfig": { | |
| "type": "object", | |
| "required": [ | |
| "propertyName" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "propertyName": { | |
| "type": "string" | |
| }, | |
| "andOr": { | |
| "type": "string" | |
| }, | |
| "firstOperand": { | |
| "type": "string" | |
| }, | |
| "secondOperand": { | |
| "type": "string" | |
| }, | |
| "firstOperandType": { | |
| "type": "string" | |
| }, | |
| "secondOperandType": { | |
| "type": "string" | |
| }, | |
| "macroName": { | |
| "type": "string" | |
| }, | |
| "formControlStep": { | |
| "$ref": "#/definitions/FormControlStep" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "CategoryDTO": { | |
| "type": "object", | |
| "properties": { | |
| "description": { | |
| "type": "string", | |
| "description": "The description of the category." | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "The unique identifier of the category." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The unique name of the category." | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "The status of the category.", | |
| "enum": [ | |
| "INTERNAL", | |
| "STANDARD", | |
| "DELETED" | |
| ] | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The flag to indicate whether or not the category is to be deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "Representation of a DocFinity category." | |
| }, | |
| "FileStore": { | |
| "type": "object", | |
| "required": [ | |
| "rotation" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "checksum": { | |
| "type": "string" | |
| }, | |
| "size": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "path": { | |
| "type": "string" | |
| }, | |
| "relativePath": { | |
| "type": "string" | |
| }, | |
| "importDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "creator": { | |
| "type": "string" | |
| }, | |
| "fileDefinitionType": { | |
| "type": "string", | |
| "enum": [ | |
| "IN_PLACE", | |
| "POINTER", | |
| "STANDARD", | |
| "FORM", | |
| "EXTERNAL", | |
| "CHECKLIST" | |
| ] | |
| }, | |
| "shared": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "pageCount": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "scaleToFlex": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "externalFileStoreProps": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ExternalFileStoreProp" | |
| } | |
| }, | |
| "rotation": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "printable": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "external": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "redacted": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "inRepository": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "SearchExecutionWrapperDTO": { | |
| "type": "object", | |
| "properties": { | |
| "searchId": { | |
| "type": "string" | |
| }, | |
| "documentId": { | |
| "type": "string" | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxNum": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "searchSortOrders": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchSortOrderDTO" | |
| } | |
| }, | |
| "criteria": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/MetadataValueCriteria" | |
| } | |
| }, | |
| "treeFilters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchTreeFilterExecutionDTO" | |
| } | |
| }, | |
| "documentTypeIds": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "SearchColumnValueDTO": { | |
| "type": "object", | |
| "properties": { | |
| "value": { | |
| "type": "string" | |
| }, | |
| "attributeName": { | |
| "type": "string" | |
| }, | |
| "columnType": { | |
| "type": "string", | |
| "enum": [ | |
| "METADATA", | |
| "LINKED_OUTPUT_COLUMN", | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES" | |
| ] | |
| } | |
| } | |
| }, | |
| "EditLockDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the edit lock." | |
| }, | |
| "username": { | |
| "type": "string", | |
| "description": "The username of the user who is editing the document." | |
| }, | |
| "firstName": { | |
| "type": "string", | |
| "description": "The first name of the user who is editing the document." | |
| }, | |
| "lastName": { | |
| "type": "string", | |
| "description": "The last name of the user who is editing the document." | |
| }, | |
| "editStartDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "The date/time the document was initially edited." | |
| }, | |
| "editToken": { | |
| "type": "string", | |
| "description": "The unique edit token for this edit lock." | |
| }, | |
| "canceledBy": { | |
| "type": "string", | |
| "description": "The username of the user who cancelled this edit." | |
| }, | |
| "cancelDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "The date/time this edit was cancelled." | |
| }, | |
| "documentId": { | |
| "type": "string", | |
| "description": "The document ID of the document being edited. Note that this can be empty if this is a new document." | |
| }, | |
| "documentDisplayName": { | |
| "type": "string", | |
| "description": "The display name of the document." | |
| }, | |
| "documentCategory": { | |
| "type": "string", | |
| "description": "The Category of the document." | |
| }, | |
| "documentType": { | |
| "type": "string", | |
| "description": "The document type of the docuemnt." | |
| }, | |
| "editFileName": { | |
| "type": "string", | |
| "description": "The file name to use when downloading the edited file." | |
| }, | |
| "editAction": { | |
| "type": "string", | |
| "description": "The latest action for this edit lock.", | |
| "enum": [ | |
| "DOWNLOAD_TO_EDIT", | |
| "EDIT_NATIVELY", | |
| "EDIT_DOCUMENT", | |
| "EDIT_CANCELLED", | |
| "AUTO_REPLACE", | |
| "COMMIT_PENDING", | |
| "CANCEL_PENDING", | |
| "UNSUPPORTED" | |
| ] | |
| }, | |
| "sourceType": { | |
| "type": "string", | |
| "description": "The source of this edit lock.", | |
| "enum": [ | |
| "EDIT_LOCK", | |
| "SEARCH_RESULTS", | |
| "BATCH", | |
| "BPM" | |
| ] | |
| }, | |
| "sourceTarget": { | |
| "type": "string", | |
| "description": "The ID of the source for the edit lock. For example, if sourceType is BATCH, this is the ID of the batch." | |
| }, | |
| "pages": { | |
| "type": "array", | |
| "description": "The individual pages that make up the current state of the edited document.", | |
| "items": { | |
| "$ref": "#/definitions/EditQueuePageDTO" | |
| } | |
| }, | |
| "canDelete": { | |
| "type": "boolean", | |
| "description": "Whether this edited document can be deleted.", | |
| "default": false | |
| }, | |
| "shared": { | |
| "type": "boolean", | |
| "description": "Whether any pages of the edited document come from a shared (pointer) document.", | |
| "default": false | |
| }, | |
| "versioned": { | |
| "type": "boolean", | |
| "description": "Whether the edit lock is subject to versioning.", | |
| "default": false | |
| }, | |
| "fileDefinitionType": { | |
| "type": "string", | |
| "description": "The file type of the document.", | |
| "enum": [ | |
| "IN_PLACE", | |
| "POINTER", | |
| "STANDARD", | |
| "FORM", | |
| "EXTERNAL", | |
| "CHECKLIST" | |
| ] | |
| } | |
| }, | |
| "description": "Represents a document that is currently being edited." | |
| }, | |
| "DocumentTypeOverlayDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the object." | |
| }, | |
| "defaultTo": { | |
| "type": "boolean", | |
| "description": "Whether this overlay is the default for all pages where another overlay is not specified.", | |
| "default": false | |
| }, | |
| "documentTypeId": { | |
| "type": "string", | |
| "description": "The ID of the document type to which the overlay is assigned." | |
| }, | |
| "documentTypeOverlayId": { | |
| "type": "string", | |
| "description": "The ID of the object." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "offsetX": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Number of pixels on the X axis to offset the overlay when rendering." | |
| }, | |
| "offsetY": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Number of pixels on the Y axis to offset the overlay when rendering." | |
| }, | |
| "overlayId": { | |
| "type": "string", | |
| "description": "The ID of the overlay." | |
| }, | |
| "overlayName": { | |
| "type": "string", | |
| "description": "The name of the overlay, read-only." | |
| }, | |
| "range": { | |
| "type": "string", | |
| "description": "The page range where the overlay is applied. For default overlays, use 0. Supports any combination of: specific page (3), page range (3-10), wildcards (*-10, 3-*), in a comma-separated list: 1,4,3-7,10-*." | |
| } | |
| }, | |
| "description": "Represents the relationship between an Overlay and a Document Type." | |
| }, | |
| "DocumentTypeMetadataIndexing": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "retainValue": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "allowErrorOverride": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "blindEntry": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "sort": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "setFocus": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "characterCase": { | |
| "type": "string", | |
| "enum": [ | |
| "NORMAL", | |
| "UPPER", | |
| "LOWER" | |
| ] | |
| }, | |
| "documentTypeMetadataDescriptor": { | |
| "$ref": "#/definitions/DocumentTypeMetadata" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "RetentionPolicyCustodianDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "userId": { | |
| "type": "string" | |
| }, | |
| "userName": { | |
| "type": "string" | |
| }, | |
| "firstName": { | |
| "type": "string" | |
| }, | |
| "lastName": { | |
| "type": "string" | |
| }, | |
| "retentionPolicyId": { | |
| "type": "string" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "delete": { | |
| "type": "boolean", | |
| "xml": { | |
| "name": "deleted" | |
| }, | |
| "default": false | |
| } | |
| } | |
| }, | |
| "AddGroupDTO": { | |
| "type": "object", | |
| "properties": { | |
| "group": { | |
| "description": "The details for the new group.", | |
| "$ref": "#/definitions/GroupDTO" | |
| }, | |
| "members": { | |
| "type": "array", | |
| "description": "The users who should be added to this group.", | |
| "items": { | |
| "$ref": "#/definitions/GroupMemberDTO" | |
| } | |
| }, | |
| "featureRights": { | |
| "type": "array", | |
| "description": "The feature rights that should be given to this group.", | |
| "items": { | |
| "$ref": "#/definitions/GroupFeatureRightDTO" | |
| } | |
| }, | |
| "security": { | |
| "type": "array", | |
| "description": "The document security that should be given to this group.", | |
| "items": { | |
| "$ref": "#/definitions/DocumentSecurityAssignmentDTO" | |
| } | |
| } | |
| }, | |
| "description": "A DTO for adding a group and all of its associations on one operation." | |
| }, | |
| "LogEntryDTO": { | |
| "type": "object", | |
| "properties": { | |
| "level": { | |
| "type": "string", | |
| "description": "Log level.", | |
| "enum": [ | |
| "OFF", | |
| "FATAL", | |
| "ERROR", | |
| "WARN", | |
| "INFO", | |
| "DEBUG", | |
| "TRACE", | |
| "ALL" | |
| ] | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Logger name." | |
| }, | |
| "displayName": { | |
| "type": "string", | |
| "description": "Display name." | |
| } | |
| }, | |
| "description": "Entry for a logging module." | |
| }, | |
| "GroupDTO": { | |
| "type": "object", | |
| "properties": { | |
| "groupType": { | |
| "type": "string", | |
| "description": "The type of group.", | |
| "enum": [ | |
| "INTERNAL", | |
| "BATCH", | |
| "DISTRIBUTION", | |
| "FORM" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "The group ID." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The group name." | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "The group status.", | |
| "enum": [ | |
| "ACTIVE", | |
| "INACTIVE", | |
| "INTERNAL", | |
| "DELETED" | |
| ] | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The group description." | |
| }, | |
| "groupAssociationLevel": { | |
| "type": "string", | |
| "description": "The group association level.", | |
| "enum": [ | |
| "ALL", | |
| "PARTIAL", | |
| "NONE" | |
| ] | |
| }, | |
| "external": { | |
| "type": "boolean", | |
| "description": "Whether the group is managed by an external system such as LDAP.", | |
| "default": false | |
| } | |
| }, | |
| "description": "An object representing a group." | |
| }, | |
| "ViewDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/ViewDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "TitleFontDTO": { | |
| "type": "object", | |
| "properties": { | |
| "color": { | |
| "type": "string", | |
| "description": "The font color." | |
| }, | |
| "size": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The font size." | |
| } | |
| }, | |
| "description": "An object defining the font used in a chart title." | |
| }, | |
| "PlotPropertiesDTO": { | |
| "type": "object", | |
| "properties": { | |
| "includeName": { | |
| "type": "boolean", | |
| "description": "Whether to include the item name on the plot.", | |
| "default": false | |
| }, | |
| "includeValue": { | |
| "type": "boolean", | |
| "description": "Whether to include the item value on the plot.", | |
| "default": false | |
| }, | |
| "maxLabels": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of labels to show." | |
| }, | |
| "colors": { | |
| "type": "array", | |
| "description": "The series color definitions.", | |
| "items": { | |
| "$ref": "#/definitions/SeriesColorDTO" | |
| } | |
| } | |
| }, | |
| "description": "The plot configuration for a chart." | |
| }, | |
| "CancelEditErrorResponseDTO": { | |
| "type": "object", | |
| "properties": { | |
| "editLockId": { | |
| "type": "string", | |
| "description": "The ID of the edit lock." | |
| }, | |
| "errorMessage": { | |
| "type": "string", | |
| "description": "The error message, if any." | |
| }, | |
| "errorCode": { | |
| "type": "string", | |
| "description": "The error code, if any.", | |
| "enum": [ | |
| "INSUFFICIENT_PERMISSIONS", | |
| "EDIT_LOCK_DOES_NOT_EXIST", | |
| "DOCUMENT_DOES_NOT_EXIST" | |
| ] | |
| }, | |
| "displayName": { | |
| "type": "string", | |
| "description": "The display name of the edited document." | |
| }, | |
| "documentId": { | |
| "type": "string", | |
| "description": "The document ID of the edited document." | |
| } | |
| }, | |
| "description": "The result of attempting to cancel an edit for a document." | |
| }, | |
| "ViewUserGroupNameDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of User to View association configuration data." | |
| }, | |
| "viewId": { | |
| "type": "string", | |
| "description": "The view id of User to View association configuration data." | |
| }, | |
| "groupName": { | |
| "type": "string", | |
| "description": "The group name of User to View association configuration data." | |
| } | |
| }, | |
| "description": "User to View association configuration data." | |
| }, | |
| "DocumentTypeMetadataChecklist": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "documentTypeMetadata": { | |
| "$ref": "#/definitions/DocumentTypeMetadata" | |
| }, | |
| "searchDocIndexingMetadata": { | |
| "$ref": "#/definitions/SearchDocIndexingMetadata" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "TempOverlayDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "FormControlStep": { | |
| "type": "object", | |
| "required": [ | |
| "disabled", | |
| "hidden", | |
| "x", | |
| "y" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "formControl": { | |
| "$ref": "#/definitions/FormControl" | |
| }, | |
| "formStep": { | |
| "$ref": "#/definitions/FormStep" | |
| }, | |
| "width": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "height": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "percentWidth": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "percentHeight": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "labelPosition": { | |
| "type": "string", | |
| "enum": [ | |
| "LEFT", | |
| "RIGHT", | |
| "TOP", | |
| "BOTTOM" | |
| ] | |
| }, | |
| "required": { | |
| "type": "string" | |
| }, | |
| "disabled": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "string" | |
| }, | |
| "tooltip": { | |
| "type": "string" | |
| }, | |
| "datasource": { | |
| "type": "string" | |
| }, | |
| "x": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "y": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "loadOrder": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "properties": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormControlProperty" | |
| } | |
| }, | |
| "formActions": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormAction" | |
| } | |
| }, | |
| "validators": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormControlValidator" | |
| } | |
| }, | |
| "configData": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormControlConfig" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "SecurityFilter": { | |
| "type": "object", | |
| "required": [ | |
| "comparatorType", | |
| "documentSecurity", | |
| "metadata", | |
| "ordinal", | |
| "value" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "documentSecurity": { | |
| "$ref": "#/definitions/DocumentSecurity" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Metadata" | |
| }, | |
| "connectiveType": { | |
| "type": "string", | |
| "enum": [ | |
| "AND", | |
| "OR" | |
| ] | |
| }, | |
| "comparatorType": { | |
| "type": "string", | |
| "enum": [ | |
| "EQUALS", | |
| "NOT_EQUALS", | |
| "GREATER_THAN", | |
| "LESS_THAN", | |
| "GREATER_THAN_EQUALS", | |
| "LESS_THAN_EQUALS", | |
| "CONTAINS", | |
| "NOT_CONTAINS", | |
| "IN" | |
| ] | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": 0 | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "FormInstance": { | |
| "type": "object", | |
| "required": [ | |
| "completed", | |
| "createdDate", | |
| "isLocked", | |
| "lastModifiedBy", | |
| "lastModifiedDate", | |
| "showInSavedList", | |
| "submitted" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "form": { | |
| "$ref": "#/definitions/Form" | |
| }, | |
| "creator": { | |
| "$ref": "#/definitions/User" | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "lastModifiedDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "lastModifiedBy": { | |
| "type": "string" | |
| }, | |
| "submitted": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "submittedDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "completed": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "completedDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "formInstanceData": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormInstanceData" | |
| } | |
| }, | |
| "isLocked": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "lockOwner": { | |
| "type": "string" | |
| }, | |
| "currentStep": { | |
| "$ref": "#/definitions/FormStep" | |
| }, | |
| "formDocuments": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormDocument" | |
| } | |
| }, | |
| "formActionIds": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "showInSavedList": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "savedDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "PackageItemPluginDTO": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "The type of package item plugin" | |
| }, | |
| "swf": { | |
| "type": "string" | |
| }, | |
| "icon": { | |
| "type": "string" | |
| }, | |
| "propertyNames": { | |
| "type": "array", | |
| "description": "The property names of the package item plugin", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "displayName": { | |
| "type": "string", | |
| "description": "The display name of the package item plugin" | |
| } | |
| }, | |
| "description": "PackageItemPlugin data model" | |
| }, | |
| "ChartBorderDTO": { | |
| "type": "object", | |
| "properties": { | |
| "size": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The size of the border." | |
| }, | |
| "color": { | |
| "type": "string", | |
| "description": "The color of the border." | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of the border." | |
| } | |
| }, | |
| "description": "An object that defines the border for a chart." | |
| }, | |
| "Datasource": { | |
| "type": "object", | |
| "required": [ | |
| "clientOnly", | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "clientOnly": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "properties": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/DatasourceProperty" | |
| } | |
| }, | |
| "parameters": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/DatasourceParameter" | |
| } | |
| }, | |
| "intents": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/DatasourceIntent" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "parameterNames": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "originalName": { | |
| "type": "string" | |
| }, | |
| "nameChanged": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "datasourceType": { | |
| "type": "string" | |
| }, | |
| "datasourcePluginDTO": { | |
| "$ref": "#/definitions/DatasourcePluginDTO" | |
| }, | |
| "validateUniqueParameterNames": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validateUniqueIntentTypes": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "userInterface": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ParameterPromptDTO" | |
| } | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "TaskCompletionDTO": { | |
| "type": "object", | |
| "properties": { | |
| "remainingTasks": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DocfinityTaskDTO" | |
| } | |
| }, | |
| "errorMessage": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ParameterPromptDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the prompt object." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The prompt name." | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The prompt type.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "DASHBOARD_PROMPT" | |
| ] | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type of the prompt.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The ID of the datasource used by the prompt." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal of the prompt." | |
| }, | |
| "label": { | |
| "type": "string", | |
| "description": "The prompt label." | |
| }, | |
| "inputType": { | |
| "type": "string", | |
| "description": "The type of user prompt.", | |
| "enum": [ | |
| "CHECKBOX", | |
| "SWITCH", | |
| "DATE_FIELD", | |
| "LIST", | |
| "TEXT_FIELD", | |
| "READ_ONLY", | |
| "TEXT_AREA", | |
| "AUTO_COMPLETE" | |
| ] | |
| }, | |
| "data": { | |
| "type": "array", | |
| "description": "The data values to use in the prompt, useful for lists.", | |
| "items": { | |
| "$ref": "#/definitions/DataValue" | |
| } | |
| }, | |
| "autoCompleteEndpoint": { | |
| "type": "string", | |
| "description": "The endpoint to use when requesting data in the auto complete control." | |
| }, | |
| "autoCompleteTextField": { | |
| "type": "string", | |
| "description": "The field to display in the auto complete control." | |
| }, | |
| "autoCompleteMinLength": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The minimum number of characters to type in the auto complete control before it filters." | |
| }, | |
| "maxLength": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum length of the prompt value." | |
| }, | |
| "strDefaultValue": { | |
| "type": "string", | |
| "description": "The default value of the prompt in string form." | |
| }, | |
| "placeholderValue": { | |
| "type": "string", | |
| "description": "The placeholder value to show in the prompt." | |
| }, | |
| "labelTrue": { | |
| "type": "string", | |
| "description": "The true label for switch prompts." | |
| }, | |
| "labelFalse": { | |
| "type": "string", | |
| "description": "The false label for switch prompts." | |
| }, | |
| "responsibilityMapping": { | |
| "type": "array", | |
| "description": "The dependency mapping for the prompt.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "parameterPromptDatasourceArguments": { | |
| "type": "array", | |
| "description": "The datasource arguments used for the prompt's datasource.", | |
| "items": { | |
| "$ref": "#/definitions/ParameterPromptDatasourceArgDTO" | |
| } | |
| }, | |
| "macroString": { | |
| "type": "string", | |
| "description": "The macro string used by the prompt." | |
| }, | |
| "required": { | |
| "type": "boolean", | |
| "description": "Whether the prompt is required.", | |
| "default": false | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether the prompt is hidden.", | |
| "default": false | |
| }, | |
| "editable": { | |
| "type": "boolean", | |
| "description": "Whether the prompt is editable.", | |
| "default": false | |
| } | |
| }, | |
| "description": "A generic representation of a user prompt." | |
| }, | |
| "FormatDTO": { | |
| "type": "object", | |
| "properties": { | |
| "formatType": { | |
| "type": "string", | |
| "description": "The format type.", | |
| "enum": [ | |
| "NONE", | |
| "LEADING", | |
| "TRAILING", | |
| "PERCENTAGE" | |
| ] | |
| }, | |
| "formatValue": { | |
| "type": "string", | |
| "description": "The format value." | |
| }, | |
| "formatPercent": { | |
| "type": "boolean", | |
| "description": "Whether to format as a percentage in addition to the formatted value.", | |
| "default": false | |
| } | |
| }, | |
| "description": "An object that holds the format properties for a chart." | |
| }, | |
| "SysPropertyDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the system property. Read-only." | |
| }, | |
| "category": { | |
| "type": "string", | |
| "description": "The system property category. Read-only." | |
| }, | |
| "subcategory": { | |
| "type": "string", | |
| "description": "The system property subcategory. Read-only." | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "The system property value." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The system property name. Read-only." | |
| }, | |
| "prompt": { | |
| "type": "string", | |
| "description": "The system property prompt value. Read-only." | |
| }, | |
| "generic": { | |
| "type": "boolean", | |
| "description": "Whether the system property is generic. Read-only.", | |
| "default": false | |
| }, | |
| "defaultValue": { | |
| "type": "string", | |
| "description": "The system property default value, used during reset operations. Read-only." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The system property description. Read-only." | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The system property data type. Read-only." | |
| }, | |
| "units": { | |
| "type": "string", | |
| "description": "The system property units. Read-only." | |
| }, | |
| "min": { | |
| "type": "string", | |
| "description": "The system property min value. Read-only." | |
| }, | |
| "max": { | |
| "type": "string", | |
| "description": "The system property max value. Read-only." | |
| }, | |
| "enumValues": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "description": "A DocFinity system property used to control a setting for the system." | |
| }, | |
| "GroupMemberAssignmentDTO": { | |
| "type": "object", | |
| "properties": { | |
| "groupIds": { | |
| "type": "array", | |
| "description": "The group IDs.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "users": { | |
| "type": "array", | |
| "description": "The users.", | |
| "items": { | |
| "$ref": "#/definitions/UserDTO" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The markedForDelete flag.", | |
| "default": false | |
| } | |
| }, | |
| "description": "An object representing a user assignment to a group." | |
| }, | |
| "SearchStoredProcedureParameterDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the parameter in the stored procedure search." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal of this parameter with respect to other parameters in the search." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the parameter." | |
| }, | |
| "mode": { | |
| "type": "string", | |
| "description": "The mode of the parameter in the stored procedure.", | |
| "enum": [ | |
| "IN", | |
| "OUT", | |
| "INOUT", | |
| "RESULT", | |
| "RETURN", | |
| "UNKNOWN" | |
| ] | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of the database column associated to this parameter.", | |
| "enum": [ | |
| "INTEGER", | |
| "NUMBER", | |
| "SMALLINT", | |
| "BIGINT", | |
| "TINYINT", | |
| "BOOLEAN", | |
| "BIT", | |
| "DATE", | |
| "TIME", | |
| "TIMESTAMP", | |
| "DOUBLE", | |
| "FLOAT", | |
| "DECIMAL", | |
| "NUMERIC", | |
| "REAL", | |
| "VARCHAR", | |
| "LONGVARCHAR", | |
| "CHAR", | |
| "BLOB", | |
| "CLOB", | |
| "NCLOB", | |
| "NVARCHAR", | |
| "NCHAR", | |
| "LONGNVARCHAR", | |
| "SQLXML", | |
| "STRING", | |
| "ARRAY", | |
| "BINARY", | |
| "DATALINK", | |
| "DISTINCT", | |
| "JAVA_OBJECT", | |
| "NULL", | |
| "REF", | |
| "STRUCT", | |
| "VARBINARY", | |
| "LONGVARBINARY", | |
| "ROWID", | |
| "UNKNOWN" | |
| ] | |
| }, | |
| "metadataType": { | |
| "type": "string", | |
| "description": "The data type of the parameter.", | |
| "enum": [ | |
| "DATE", | |
| "INTEGER", | |
| "DECIMAL", | |
| "STRING_VARIABLE" | |
| ] | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The indication whether or not this parameter should be deleted from the stored procedure search configuration.", | |
| "default": false | |
| }, | |
| "searchParameter": { | |
| "description": "The search parameter to associated with this particular input parameter to the stored procedure.", | |
| "$ref": "#/definitions/SearchParameterDTO" | |
| }, | |
| "parameterType": { | |
| "type": "string", | |
| "description": "The type of the parameter.", | |
| "enum": [ | |
| "NONE", | |
| "STATIC", | |
| "MACRO", | |
| "PROMPT" | |
| ] | |
| }, | |
| "searchPromptDTO": { | |
| "description": "The search prompt to associate with this particular input parameter to the stored procedure.", | |
| "$ref": "#/definitions/SearchPromptDTO" | |
| } | |
| }, | |
| "description": "The representation of a parameter used in a stored procedure search." | |
| }, | |
| "FormControlStepDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "formControlId": { | |
| "type": "string" | |
| }, | |
| "formControlName": { | |
| "type": "string" | |
| }, | |
| "formStepId": { | |
| "type": "string" | |
| }, | |
| "formStepName": { | |
| "type": "string" | |
| }, | |
| "formStepOrdinal": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "width": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "height": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "percentWidth": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "percentHeight": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "labelPosition": { | |
| "type": "string", | |
| "enum": [ | |
| "LEFT", | |
| "RIGHT", | |
| "TOP", | |
| "BOTTOM" | |
| ] | |
| }, | |
| "required": { | |
| "type": "string" | |
| }, | |
| "disabled": { | |
| "type": "string" | |
| }, | |
| "hidden": { | |
| "type": "string" | |
| }, | |
| "tooltip": { | |
| "type": "string" | |
| }, | |
| "datasource": { | |
| "type": "string" | |
| }, | |
| "datasourceObject": { | |
| "$ref": "#/definitions/DatasourceDTO" | |
| }, | |
| "x": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "y": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "loadOrder": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "properties": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormControlPropertyDTO" | |
| } | |
| }, | |
| "actions": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormActionDTO" | |
| } | |
| }, | |
| "validators": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormControlValidatorDTO" | |
| } | |
| }, | |
| "requiredConditionConfigData": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormControlConfigDTO" | |
| } | |
| }, | |
| "hiddenConditionConfigData": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormControlConfigDTO" | |
| } | |
| }, | |
| "disabledConditionConfigData": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormControlConfigDTO" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "FormActionProperty": { | |
| "type": "object", | |
| "required": [ | |
| "formAction", | |
| "propertyName", | |
| "propertyValue" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "propertyName": { | |
| "type": "string" | |
| }, | |
| "propertyValue": { | |
| "type": "string" | |
| }, | |
| "formAction": { | |
| "$ref": "#/definitions/FormAction" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "DatabaseDriverDTO": { | |
| "type": "object", | |
| "properties": { | |
| "databaseType": { | |
| "type": "string" | |
| }, | |
| "driverName": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "url": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "SearchParameterPromptDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the prompt object." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The prompt name." | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The prompt type.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "DASHBOARD_PROMPT" | |
| ] | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type of the prompt.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The ID of the datasource used by the prompt." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal of the prompt." | |
| }, | |
| "label": { | |
| "type": "string", | |
| "description": "The prompt label." | |
| }, | |
| "inputType": { | |
| "type": "string", | |
| "description": "The type of user prompt.", | |
| "enum": [ | |
| "CHECKBOX", | |
| "SWITCH", | |
| "DATE_FIELD", | |
| "LIST", | |
| "TEXT_FIELD", | |
| "READ_ONLY", | |
| "TEXT_AREA", | |
| "AUTO_COMPLETE" | |
| ] | |
| }, | |
| "data": { | |
| "type": "array", | |
| "description": "The data values to use in the prompt, useful for lists.", | |
| "items": { | |
| "$ref": "#/definitions/DataValue" | |
| } | |
| }, | |
| "autoCompleteEndpoint": { | |
| "type": "string", | |
| "description": "The endpoint to use when requesting data in the auto complete control." | |
| }, | |
| "autoCompleteTextField": { | |
| "type": "string", | |
| "description": "The field to display in the auto complete control." | |
| }, | |
| "autoCompleteMinLength": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The minimum number of characters to type in the auto complete control before it filters." | |
| }, | |
| "maxLength": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum length of the prompt value." | |
| }, | |
| "strDefaultValue": { | |
| "type": "string", | |
| "description": "The default value of the prompt in string form." | |
| }, | |
| "placeholderValue": { | |
| "type": "string", | |
| "description": "The placeholder value to show in the prompt." | |
| }, | |
| "labelTrue": { | |
| "type": "string", | |
| "description": "The true label for switch prompts." | |
| }, | |
| "labelFalse": { | |
| "type": "string", | |
| "description": "The false label for switch prompts." | |
| }, | |
| "responsibilityMapping": { | |
| "type": "array", | |
| "description": "The dependency mapping for the prompt.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "parameterPromptDatasourceArguments": { | |
| "type": "array", | |
| "description": "The datasource arguments used for the prompt's datasource.", | |
| "items": { | |
| "$ref": "#/definitions/ParameterPromptDatasourceArgDTO" | |
| } | |
| }, | |
| "macroString": { | |
| "type": "string", | |
| "description": "The macro string used by the prompt." | |
| }, | |
| "allowMultipleValues": { | |
| "type": "boolean", | |
| "description": "The indication whether or not this parameter prompt will accept multiple values.", | |
| "default": false | |
| }, | |
| "attributeType": { | |
| "type": "string", | |
| "description": "The type of the attribute associated with parameter prompt.", | |
| "enum": [ | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "FULL_TEXT", | |
| "DIARY", | |
| "METADATA", | |
| "OTHER", | |
| "STORED_PROC_PARAM", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES", | |
| "FILE_TYPE", | |
| "HIDDEN", | |
| "HIDDEN_DATE", | |
| "HIDDEN_INTEGER", | |
| "HIDDEN_DECIMAL" | |
| ] | |
| }, | |
| "attributeName": { | |
| "type": "string", | |
| "description": "The name of the attribute associated with this parameter prompt." | |
| }, | |
| "required": { | |
| "type": "boolean", | |
| "description": "Whether the prompt is required.", | |
| "default": false | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether the prompt is hidden.", | |
| "default": false | |
| }, | |
| "editable": { | |
| "type": "boolean", | |
| "description": "Whether the prompt is editable.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The representation of the search parameter prompt." | |
| }, | |
| "ReportImporterDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/DirectoryImporterDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the importer." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the importer." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description to be used by the importer." | |
| }, | |
| "running": { | |
| "type": "boolean", | |
| "description": "Flag indicating that the importer is running.", | |
| "default": false | |
| }, | |
| "idle": { | |
| "type": "boolean", | |
| "description": "Flag indicating importer is running but not processing.", | |
| "default": false | |
| }, | |
| "server": { | |
| "type": "string", | |
| "description": "The server details where the importer will run." | |
| }, | |
| "processType": { | |
| "type": "string", | |
| "description": "Importer process type.Values allowed are EMAIL,REPORT,COLD,OBJECT,INDEX.", | |
| "enum": [ | |
| "EMAIL", | |
| "REPORT", | |
| "INDEX", | |
| "OBJECT", | |
| "COLD" | |
| ] | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "The importer status INTERNAL/EXTERNAL.", | |
| "enum": [ | |
| "INTERNAL", | |
| "ACTIVE" | |
| ] | |
| }, | |
| "preRender": { | |
| "type": "boolean", | |
| "description": "Flag indicating that files imported by the importer will be pre-rendered.", | |
| "default": false | |
| }, | |
| "pollingFrequency": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Numeric indicating how often the importer would poll for files in the monitored directory/email folder." | |
| }, | |
| "pollingUnits": { | |
| "type": "string", | |
| "description": "String indicating what units the polling frequency uses. Valid values are SECONDS,MINUTES,HOURS,DAYS.", | |
| "enum": [ | |
| "SECONDS", | |
| "MINUTES", | |
| "HOURS", | |
| "DAYS" | |
| ] | |
| }, | |
| "calculatedProperties": { | |
| "type": "array", | |
| "description": "The calculated properties to be used by the importer.", | |
| "items": { | |
| "$ref": "#/definitions/CalculatedPropertyDTO" | |
| } | |
| }, | |
| "ruleSets": { | |
| "type": "array", | |
| "description": "The rulesets to be used by the importer.", | |
| "items": { | |
| "$ref": "#/definitions/RuleSetDTO" | |
| } | |
| }, | |
| "importerPluginName": { | |
| "type": "string", | |
| "description": "The plugin to be used by the importer." | |
| }, | |
| "schedule": { | |
| "description": "The importer schedule.", | |
| "$ref": "#/definitions/GenericScheduleDTO" | |
| }, | |
| "lastErrorMessage": { | |
| "type": "string", | |
| "description": "The last error message associated with the importer." | |
| }, | |
| "pending": { | |
| "type": "boolean", | |
| "description": "Flag indicating that start/stop of importer is pending.", | |
| "default": false | |
| }, | |
| "get_class": { | |
| "type": "string" | |
| }, | |
| "importerSettings": { | |
| "type": "string" | |
| }, | |
| "directoryPath": { | |
| "type": "string", | |
| "description": "The directory path being monitored by the importer." | |
| }, | |
| "fileFilter": { | |
| "type": "string", | |
| "description": "The file filter to be used by the importer." | |
| }, | |
| "serial": { | |
| "type": "boolean", | |
| "description": "Flag indicating the files are to be processed serially.", | |
| "default": false | |
| }, | |
| "uploadRepositoryPath": { | |
| "type": "string", | |
| "description": "The upload repository path for the report importer." | |
| }, | |
| "reportType": { | |
| "type": "string", | |
| "description": "The report type for the report importer SHORT_REPORT, LONG_REPORT or PDF_REPORT.", | |
| "enum": [ | |
| "SHORT_REPORT", | |
| "LONG_REPORT", | |
| "PDF_REPORT" | |
| ] | |
| }, | |
| "pathField": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The field that holds path information in the report index file." | |
| }, | |
| "driveLetter": { | |
| "type": "string", | |
| "description": "The drive letter where raw report are held." | |
| }, | |
| "uncPath": { | |
| "type": "string", | |
| "description": "The UNC path where the raw reports are held." | |
| }, | |
| "compareFields": { | |
| "type": "string", | |
| "description": "Flag to indicate if fields are to be compared." | |
| }, | |
| "mergeContiguous": { | |
| "type": "boolean", | |
| "description": "Flag to indicate if continguous values are to be merged.", | |
| "default": false | |
| }, | |
| "startPageField": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Field holding the start page of the report document." | |
| }, | |
| "endPageField": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Field holding the end page of the report document." | |
| }, | |
| "headerLineProperties": { | |
| "type": "array", | |
| "description": "The headlines associated with the report.", | |
| "items": { | |
| "$ref": "#/definitions/ReportHeaderLinePropertyDTO" | |
| } | |
| }, | |
| "sortColumns": { | |
| "type": "array", | |
| "description": "The sort columns associated with the report.", | |
| "items": { | |
| "$ref": "#/definitions/ReportImporterSortColumnDTO" | |
| } | |
| }, | |
| "mergeFields": { | |
| "type": "array", | |
| "description": "The merge columns associated with the report.", | |
| "items": { | |
| "$ref": "#/definitions/ReportImporterMergeFieldDTO" | |
| } | |
| }, | |
| "lineProperties": { | |
| "type": "array", | |
| "description": "The line properties associated with the report.", | |
| "items": { | |
| "$ref": "#/definitions/PropertyDTO" | |
| } | |
| } | |
| }, | |
| "description": "A report importer." | |
| } | |
| ] | |
| }, | |
| "SearchPromptDatasourceDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "datasourceId": { | |
| "type": "string" | |
| }, | |
| "datasourceName": { | |
| "type": "string" | |
| }, | |
| "searchPromptDatasourceParameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchPromptDatasourceParamDTO" | |
| } | |
| } | |
| } | |
| }, | |
| "RadialRangeDTO": { | |
| "type": "object", | |
| "properties": { | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal of the color." | |
| }, | |
| "color": { | |
| "type": "string", | |
| "description": "The color to use." | |
| }, | |
| "width": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The width of this color." | |
| } | |
| }, | |
| "description": "The configuration for a range color on a radial axis for a chart." | |
| }, | |
| "WebserviceDTO": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "wsdlUrl": { | |
| "type": "string" | |
| }, | |
| "services": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ServiceInfoDTO" | |
| } | |
| } | |
| } | |
| }, | |
| "RetentionPolicyDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the retention policy" | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the retention policy" | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description of the retention policy" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The RetentionPolicyType of the retention policy. Values DEFAULT/USER", | |
| "enum": [ | |
| "DEFAULT", | |
| "USER" | |
| ] | |
| }, | |
| "dispositionMethod": { | |
| "type": "string", | |
| "description": "The DispositionMethod of the retention policy. Values DELETE/PURGE/KEEP", | |
| "enum": [ | |
| "DELETE", | |
| "PURGE", | |
| "KEEP" | |
| ] | |
| }, | |
| "condition": { | |
| "description": "The disposition condition dto associated with the retention policy.", | |
| "$ref": "#/definitions/DispositionConditionDTO" | |
| }, | |
| "processModelName": { | |
| "type": "string", | |
| "description": "The process model name associated with the retention policy." | |
| }, | |
| "numberOfApprovals": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The number of approvals required for the retention policy." | |
| }, | |
| "convertToPDFA": { | |
| "type": "boolean", | |
| "description": "Flag to control pdfa creation for documents associated with the retention policy.", | |
| "default": false | |
| }, | |
| "custodians": { | |
| "type": "array", | |
| "description": "The custodians associated with the retention policy.", | |
| "items": { | |
| "$ref": "#/definitions/RetentionPolicyCustodianDTO" | |
| } | |
| }, | |
| "documentTypes": { | |
| "type": "array", | |
| "description": "The document types associated with the retention policy.", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeDTO" | |
| } | |
| } | |
| }, | |
| "description": "Data model for a retention policy" | |
| }, | |
| "StackTraceElement": { | |
| "type": "object", | |
| "properties": { | |
| "methodName": { | |
| "type": "string" | |
| }, | |
| "fileName": { | |
| "type": "string" | |
| }, | |
| "lineNumber": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "className": { | |
| "type": "string" | |
| }, | |
| "nativeMethod": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "SearchResultRowDTO": { | |
| "type": "object", | |
| "properties": { | |
| "displayName": { | |
| "type": "string" | |
| }, | |
| "documentTypeId": { | |
| "type": "string" | |
| }, | |
| "documentTypeName": { | |
| "type": "string" | |
| }, | |
| "searchName": { | |
| "type": "string" | |
| }, | |
| "categoryName": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "pointer": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "rolesBitMask": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "thumbnailURL": { | |
| "type": "string" | |
| }, | |
| "diaries": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "fileSize": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "fileDefinitionType": { | |
| "type": "string", | |
| "enum": [ | |
| "IN_PLACE", | |
| "POINTER", | |
| "STANDARD", | |
| "FORM", | |
| "EXTERNAL", | |
| "CHECKLIST" | |
| ] | |
| }, | |
| "redacted": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "editLockOwner": { | |
| "type": "string" | |
| }, | |
| "subSearchName": { | |
| "type": "string" | |
| }, | |
| "subSearchRequired": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "hasLegalHold": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "columnValueDTOs": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchColumnValueDTO" | |
| } | |
| } | |
| } | |
| }, | |
| "ScanSettingDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "xml": { | |
| "name": "result" | |
| }, | |
| "description": "Representation of the pageable collection of scan settings.", | |
| "items": { | |
| "$ref": "#/definitions/ScanSettingDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "EditQueuePageDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "editLockId": { | |
| "type": "string" | |
| }, | |
| "sourceDocumentId": { | |
| "type": "string" | |
| }, | |
| "sourcePageNumber": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "newPageNumber": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "rotationAngle": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "fileName": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "PreviewDashboardChartableDTO": { | |
| "type": "object", | |
| "properties": { | |
| "dashboardChartable": { | |
| "description": "The full DashboardChartableDTO.", | |
| "$ref": "#/definitions/DashboardChartableDTO" | |
| }, | |
| "dashboard": { | |
| "description": "The full DashboardDTO.", | |
| "$ref": "#/definitions/DashboardDTO" | |
| }, | |
| "dashboardInputs": { | |
| "type": "array", | |
| "description": "The values for the current dashboard inputs.", | |
| "items": { | |
| "$ref": "#/definitions/KeyValuePair" | |
| } | |
| } | |
| }, | |
| "description": "An object that contains the data necessary to preview a chart on a dashboard." | |
| }, | |
| "ScanSettingDTO": { | |
| "type": "object", | |
| "properties": { | |
| "automaticDocumentFeeder": { | |
| "type": "boolean", | |
| "description": "The flag indicating support of automatic document feeder.", | |
| "default": false | |
| }, | |
| "blankPageThreshold": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "The threshold of blank pages configured for the scan settings." | |
| }, | |
| "compression": { | |
| "type": "string", | |
| "description": "The compression attribute of the scan settings." | |
| }, | |
| "dpiResolution": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The DPI resolution setting for the scan profile." | |
| }, | |
| "duplex": { | |
| "type": "boolean", | |
| "description": "The flag indicating if this scan profile supports duplex scanning.", | |
| "default": false | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the scan setting." | |
| }, | |
| "multipage": { | |
| "type": "boolean", | |
| "description": "The flag indicating if this scan setting support multipage scanning.", | |
| "default": false | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the scan setting." | |
| }, | |
| "pixelType": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The pixel type of the scan setting." | |
| }, | |
| "showUI": { | |
| "type": "boolean", | |
| "description": "The flag indicating if the scanning user interface should be shown.", | |
| "default": false | |
| }, | |
| "storageTypeDescription": { | |
| "type": "string", | |
| "description": "The description of the storage type." | |
| }, | |
| "storageTypeId": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "The indicator of the storage type." | |
| }, | |
| "scanSettingType": { | |
| "type": "string", | |
| "description": "The type of the scan setting.", | |
| "enum": [ | |
| "INTERNAL", | |
| "ACTIVE" | |
| ] | |
| }, | |
| "docFinitySeparator": { | |
| "type": "boolean", | |
| "description": "The flag indicating to use the DocFinity separator.", | |
| "default": false | |
| }, | |
| "scanToExternalDir": { | |
| "type": "boolean", | |
| "description": "The flag indicating if the operation should scan to an external directory.", | |
| "default": false | |
| }, | |
| "externalDirPath": { | |
| "type": "string", | |
| "description": "The representation of the external directory path in which to save scans." | |
| }, | |
| "saveToServer": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "deleteBlankPage": { | |
| "type": "boolean", | |
| "description": "The flag indicating if blank pages should be deleted.", | |
| "default": false | |
| }, | |
| "convertToPdf": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "blankDeviationThreshold": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The blank deviation threshold of the scan settings." | |
| }, | |
| "deleteBackOfSeparator": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "simulateDuplex": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "operationId": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "Representation of scan settings." | |
| }, | |
| "LdapServerDTO": { | |
| "type": "object", | |
| "properties": { | |
| "baseDn": { | |
| "type": "string", | |
| "description": "Gets the baseDn attribute of the LdapServerDTO object." | |
| }, | |
| "baseDNs": { | |
| "type": "array", | |
| "description": "Gets the BaseDn array attribute of the LdapServerDTO object.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "emailAddressAttr": { | |
| "type": "string", | |
| "description": "Gets the emailAddressAttr attribute of the LdapServerDTO object." | |
| }, | |
| "externalReferenceAttr": { | |
| "type": "string", | |
| "description": "Gets the externalReferenceAttr attribute of the LdapServerDTO object." | |
| }, | |
| "firstNameAttr": { | |
| "type": "string", | |
| "description": "Gets the firstNameAttr attribute of the LdapServerDTO object." | |
| }, | |
| "lastNameAttr": { | |
| "type": "string", | |
| "description": "Gets the lastNameAttr attribute of the LdapServerDTO object." | |
| }, | |
| "ldapServerType": { | |
| "type": "string" | |
| }, | |
| "middleNameAttr": { | |
| "type": "string", | |
| "description": "Gets the middleNameAttr attribute of the LdapServerDTO object." | |
| }, | |
| "modifiedTimeStampAttr": { | |
| "type": "string", | |
| "description": "Gets the modifiedTimeStampAttr attribute of the LdapServerDTO object." | |
| }, | |
| "password": { | |
| "type": "string", | |
| "description": "Gets the password attribute of the LdapServerDTO object." | |
| }, | |
| "phoneNumberAttr": { | |
| "type": "string", | |
| "description": "Gets the phoneNumberAttr attribute of the LdapServerDTO object." | |
| }, | |
| "serverName": { | |
| "type": "string", | |
| "description": "Gets the serverName attribute of the LdapServerDTO object." | |
| }, | |
| "serverPort": { | |
| "type": "string", | |
| "description": "Gets the serverPort attribute of the LdapServerDTO object." | |
| }, | |
| "valid": { | |
| "type": "boolean", | |
| "description": "Gets users valid attribute.", | |
| "default": false | |
| }, | |
| "groupsValid": { | |
| "type": "boolean", | |
| "description": "Gets groups valid attribute.", | |
| "default": false | |
| }, | |
| "memberOfAttr": { | |
| "type": "string", | |
| "description": "Used to determine group memberships." | |
| }, | |
| "subDn": { | |
| "type": "string", | |
| "description": "Gets the subDn attribute of the LdapServerDTO object." | |
| }, | |
| "useBaseDn": { | |
| "type": "boolean", | |
| "description": "Gets the useBaseDn attribute of the LdapServerDTO object.", | |
| "default": false | |
| }, | |
| "userFilter": { | |
| "type": "string", | |
| "description": "Gets the userFilter attribute of the LdapServerDTO object." | |
| }, | |
| "userDn": { | |
| "type": "string", | |
| "description": "Gets the userDn attribute of the LdapServerDTO object." | |
| }, | |
| "usernameAttr": { | |
| "type": "string", | |
| "description": "Gets the usernameAttr attribute of the LdapServerDTO object." | |
| }, | |
| "userStatusAttr": { | |
| "type": "string", | |
| "description": "Gets the userStatusAttr attribute of the LdapServerDTO object." | |
| }, | |
| "ssl": { | |
| "type": "boolean", | |
| "description": "Gets the ssl attribute of the LdapServerDTO object.", | |
| "default": false | |
| }, | |
| "serverType": { | |
| "type": "string", | |
| "description": "Gets the ldap server type.", | |
| "enum": [ | |
| "ACTIVE_DIRECTORY", | |
| "STANDARD_LDAP" | |
| ] | |
| }, | |
| "enabled": { | |
| "type": "boolean", | |
| "description": "Gets the enabled attribute of the LdapServerDTO object.", | |
| "default": false | |
| }, | |
| "synchronizeGroups": { | |
| "type": "boolean", | |
| "description": "Gets whether to synchronize groups.", | |
| "default": false | |
| }, | |
| "synchronizeAllGroups": { | |
| "type": "boolean", | |
| "description": "Gets whether to sychronize all groups.", | |
| "default": false | |
| }, | |
| "groupNameAttr": { | |
| "type": "string", | |
| "description": "Gets group name attribute." | |
| }, | |
| "groupEntityFilter": { | |
| "type": "string", | |
| "description": "Gets the group entity filter." | |
| } | |
| }, | |
| "description": "LdapServerDTO object contains connection and user lookup details for the ldap server." | |
| }, | |
| "StaticIntegerDashboardInputDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/StaticDashboardInputDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DashboardInput." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The input name, must be unique per dashboard." | |
| }, | |
| "value": { | |
| "type": "object" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of input.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "DASHBOARD_PROMPT" | |
| ] | |
| }, | |
| "dashboardId": { | |
| "type": "string", | |
| "description": "The ID of the dashboard that owns this input." | |
| }, | |
| "dashboardName": { | |
| "type": "string", | |
| "description": "The name of the dashboard that owns this input." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The ID of the datasource used by this input." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "The name of the datasource used by this input." | |
| }, | |
| "datasourceResults": { | |
| "type": "array", | |
| "description": "The results from executing the datasource.", | |
| "items": { | |
| "$ref": "#/definitions/DataValue" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "responsibilityMapping": { | |
| "type": "array", | |
| "description": "The responsibility mapping for executing dependent inputs.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "dashboardInputDatasourceInputs": { | |
| "type": "array", | |
| "description": "The inputs needed for the datasource for this input.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardInputDatasourceInputDTO" | |
| } | |
| }, | |
| "staticType": { | |
| "type": "string", | |
| "description": "The type of static input.", | |
| "enum": [ | |
| "BOOLEAN", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "STRING" | |
| ] | |
| }, | |
| "integerValue": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The static integer value." | |
| } | |
| }, | |
| "description": "A static hidden integer input." | |
| } | |
| ] | |
| }, | |
| "FormMonitoringSummaryDTO": { | |
| "type": "object", | |
| "properties": { | |
| "versions": { | |
| "description": "Paged collection of form version details.", | |
| "$ref": "#/definitions/PagedCollectionFormMonitoringDTO" | |
| }, | |
| "workingCopy": { | |
| "description": "Details about the working copy of the form.", | |
| "$ref": "#/definitions/FormMonitoringDTO" | |
| } | |
| }, | |
| "description": "Wrapper class used to hold both standard form version details as well as separate properties that provide details for the Form's working copy." | |
| }, | |
| "DatabaseConnection": { | |
| "type": "object", | |
| "required": [ | |
| "acquireAttempts", | |
| "acquireIncrement", | |
| "archive", | |
| "databaseDriverName", | |
| "initialPoolSize", | |
| "maxIdleTime", | |
| "maxPoolSize", | |
| "minPoolSize", | |
| "name", | |
| "password", | |
| "username" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "databaseDriverName": { | |
| "type": "string" | |
| }, | |
| "dbUrl": { | |
| "type": "string" | |
| }, | |
| "serverName": { | |
| "type": "string" | |
| }, | |
| "port": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "databaseName": { | |
| "type": "string" | |
| }, | |
| "customUrl": { | |
| "type": "string" | |
| }, | |
| "username": { | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "minPoolSize": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": 1 | |
| }, | |
| "maxPoolSize": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": 1, | |
| "maximum": 10000 | |
| }, | |
| "initialPoolSize": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": 1 | |
| }, | |
| "acquireIncrement": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": 1, | |
| "maximum": 1000 | |
| }, | |
| "acquireAttempts": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": 0, | |
| "maximum": 100 | |
| }, | |
| "maxIdleTime": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": 0, | |
| "maximum": 86400 | |
| }, | |
| "archive": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "databaseMetadata": { | |
| "$ref": "#/definitions/DatabaseMetaData" | |
| }, | |
| "databaseVendor": { | |
| "type": "string", | |
| "enum": [ | |
| "MSSQL", | |
| "ORACLE", | |
| "DB2", | |
| "CUSTOM" | |
| ] | |
| }, | |
| "originalName": { | |
| "type": "string" | |
| }, | |
| "maxPoolSizeErrorMessage": { | |
| "type": "string" | |
| }, | |
| "addMode": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "nameChanged": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "encryptedPassword": { | |
| "type": "string" | |
| }, | |
| "validateMinPoolSizeLessThanEqualToMax": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validateInitialPoolSizeGreaterThanEqualToMin": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validateInitialPoolSizeLessThanEqualToMax": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "PasswordRuleDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "minimumLength": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "minimumSpecialCharacters": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "minimumLowerCaseCharacters": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "minimumUpperCaseCharacters": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "minimumNumbers": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "PulledLdapGroupDTO": { | |
| "type": "object", | |
| "properties": { | |
| "groupName": { | |
| "type": "string", | |
| "description": "Name of the group, as stored in LDAP." | |
| }, | |
| "objectGuid": { | |
| "type": "string", | |
| "description": "Globally unique LDAP identifier of the group." | |
| }, | |
| "lastPulled": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "Date that information was last added or updated from the LDAP server." | |
| }, | |
| "synchronize": { | |
| "type": "boolean", | |
| "description": "If true, use this information to make a DocFinity group.", | |
| "default": false | |
| }, | |
| "modifiedTimestamp": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "description": "Information about groups pulled from an LDAP server." | |
| }, | |
| "DashboardChartableDTO": { | |
| "type": "object", | |
| "required": [ | |
| "chartableId" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DashboardChartable." | |
| }, | |
| "dashboardId": { | |
| "type": "string", | |
| "description": "The ID of the dashboard that owns this DashboardChartable." | |
| }, | |
| "dashboardName": { | |
| "type": "string", | |
| "description": "The name of the dashboard that owns this DashboardChartable." | |
| }, | |
| "chartableId": { | |
| "type": "string", | |
| "description": "The ID of the chart." | |
| }, | |
| "chartableName": { | |
| "type": "string", | |
| "description": "The name of the chart." | |
| }, | |
| "chartableType": { | |
| "type": "string", | |
| "description": "The chart type.", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "chartableIsValid": { | |
| "type": "boolean", | |
| "description": "Whether the chart is in a valid state.", | |
| "default": false | |
| }, | |
| "isValid": { | |
| "type": "boolean", | |
| "description": "Whether this item is in a valid state.", | |
| "default": false | |
| }, | |
| "layout": { | |
| "description": "The layout of this item.", | |
| "$ref": "#/definitions/ChartableLayoutDTO" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "input": { | |
| "type": "array", | |
| "description": "The inputs to the DashboardChartable.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardChartableInputDTO" | |
| } | |
| }, | |
| "drillDowns": { | |
| "type": "array", | |
| "description": "The drill downs configured for this DashboardChartable.", | |
| "items": { | |
| "$ref": "#/definitions/DrillDownDTO" | |
| } | |
| }, | |
| "drillDownCount": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "The number of drill downs used in this DashboardChartable." | |
| } | |
| }, | |
| "description": "An instance of a chart on a dashboard at the top level." | |
| }, | |
| "FullTextDTO": { | |
| "type": "object", | |
| "properties": { | |
| "highlight": { | |
| "type": "string" | |
| }, | |
| "lastIndexed": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "majorVersion": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "HolidayDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The holiday ID." | |
| }, | |
| "start": { | |
| "type": "string", | |
| "description": "The holiday start date as a system date formatted string." | |
| }, | |
| "end": { | |
| "type": "string", | |
| "description": "The holiday end date as a system date formatted string." | |
| }, | |
| "title": { | |
| "type": "string", | |
| "description": "The holiday name." | |
| } | |
| }, | |
| "description": "The dto representation of a holiday." | |
| }, | |
| "DrillDownDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DrillDown." | |
| }, | |
| "dashboardChartableId": { | |
| "type": "string", | |
| "description": "The ID of the DashboardChartable that owns this drill down." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The order of the drill down." | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of drill down.", | |
| "enum": [ | |
| "URL", | |
| "DASHBOARD", | |
| "CHART" | |
| ] | |
| }, | |
| "chartableId": { | |
| "type": "string", | |
| "description": "The ID of the target chart, set only when type is CHART." | |
| }, | |
| "chartableName": { | |
| "type": "string", | |
| "description": "The name of the target chart, set only when type is CHART." | |
| }, | |
| "chartableType": { | |
| "type": "string", | |
| "description": "The type of the target chart, set only when type is CHART.", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "dashboardId": { | |
| "type": "string", | |
| "description": "The ID of the target dashboard, set only when type is DASHBOARD." | |
| }, | |
| "dashboardName": { | |
| "type": "string", | |
| "description": "The name of the target dashboard, set only when type is DASHBOARD." | |
| }, | |
| "url": { | |
| "type": "string", | |
| "description": "The target URL, set only when type is URL." | |
| }, | |
| "chartInputs": { | |
| "type": "array", | |
| "description": "The input mappings for the target chart, set only when type is CHART.", | |
| "items": { | |
| "$ref": "#/definitions/DrillDownChartInputDTO" | |
| } | |
| }, | |
| "dashboardInputs": { | |
| "type": "array", | |
| "description": "The input mappings for the target dashboard, set only when type is DASHBOARD.", | |
| "items": { | |
| "$ref": "#/definitions/DrillDownDashboardInputDTO" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "isValid": { | |
| "type": "boolean", | |
| "description": "Whether this item is in a valid state.", | |
| "default": false | |
| } | |
| }, | |
| "description": "A transition from a chart to another object: a chart, dashboard, or URL." | |
| }, | |
| "SearchFormData": { | |
| "type": "object", | |
| "required": [ | |
| "formControlName", | |
| "search", | |
| "value" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "formControlName": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "search": { | |
| "$ref": "#/definitions/Search" | |
| }, | |
| "isNew": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "IndexPropertyDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/PropertyDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the property." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name associated with the property." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal associated with the property." | |
| }, | |
| "field": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The field associated with the property." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type associated with the property." | |
| }, | |
| "textCase": { | |
| "type": "string", | |
| "description": "The text case associated with the property." | |
| }, | |
| "trim": { | |
| "type": "boolean", | |
| "description": "Flag indicating the property value needs to be trimmed.", | |
| "default": false | |
| }, | |
| "defaultValue": { | |
| "type": "string", | |
| "description": "The default value of the property." | |
| }, | |
| "format": { | |
| "type": "string", | |
| "description": "The date format associated with the property." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Flag indicating the property is marked for deletion.", | |
| "default": false | |
| } | |
| }, | |
| "description": "An index importer property." | |
| } | |
| ] | |
| }, | |
| "DatabaseSchemaDTO": { | |
| "type": "object", | |
| "properties": { | |
| "databaseConnectionId": { | |
| "type": "string", | |
| "description": "The database connection id." | |
| }, | |
| "schemaName": { | |
| "type": "string", | |
| "description": "The schema name in the database." | |
| } | |
| }, | |
| "description": "The definition of the database schema." | |
| }, | |
| "ValidatorTestingDTO": { | |
| "type": "object", | |
| "properties": { | |
| "validatorDto": { | |
| "description": "Representation of the validator.", | |
| "$ref": "#/definitions/ValidatorDTO" | |
| }, | |
| "metadataName": { | |
| "type": "string", | |
| "description": "Name of the metadata to test." | |
| }, | |
| "parameters": { | |
| "type": "array", | |
| "description": "Array of parameters to use during testing.", | |
| "items": { | |
| "$ref": "#/definitions/KeyValuePair" | |
| } | |
| } | |
| }, | |
| "description": "An object representing a validator and data to test." | |
| }, | |
| "SearchPromptDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The unique identifier of the search prompt." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The indication of the intent to delete the search.", | |
| "default": false | |
| }, | |
| "attributeType": { | |
| "type": "string", | |
| "description": "The attributeType attribute of the SearchPromptDTO object. The type of the search prompt attribute, describing what piece of data to which this search prompt is associated. Note that based on attribute type, other fields in this DTO may be required fields.", | |
| "enum": [ | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "FULL_TEXT", | |
| "DIARY", | |
| "METADATA", | |
| "OTHER", | |
| "STORED_PROC_PARAM", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES", | |
| "FILE_TYPE", | |
| "HIDDEN", | |
| "HIDDEN_DATE", | |
| "HIDDEN_INTEGER", | |
| "HIDDEN_DECIMAL" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal value is used to place the search prompts of a search in the correct order as they should be used in the presentation to the user" | |
| }, | |
| "metadata": { | |
| "description": "The metadata attribute of the SearchPromptDTO object. If the data in this prompt is represents something non-metadata (like Category, for instance), then the metadata will be NULL. This is required if attribute type is METADATA.", | |
| "$ref": "#/definitions/MetadataDTO" | |
| }, | |
| "metadataType": { | |
| "type": "string", | |
| "description": "The metadataType attribute of the SearchPromptDTO object. The metadata type field describes the data type of the metadata. If this prompt does not use metadata, then the metadata type field will be NULL. Thie value is required if the attribute type is METADATA.", | |
| "enum": [ | |
| "DATE", | |
| "INTEGER", | |
| "DECIMAL", | |
| "STRING_VARIABLE" | |
| ] | |
| }, | |
| "lookupList": { | |
| "type": "boolean", | |
| "description": "The lookupList attribute of the SearchPromptDTO object. The lookupList field indicates whether or not default data will be provided to the user to choose from in the form of a list display.", | |
| "default": false | |
| }, | |
| "lookupListData": { | |
| "type": "array", | |
| "description": "The lookupList data of the SearchPromptDTO object. This lookup list data is populated if and only if the search prompt attribute type is METADATA, which means that the prompt refers to a piece of metadata. The metadata values are populated into this lookup list. If the attribute type is not METADATA, then this method will return a null value.", | |
| "items": { | |
| "$ref": "#/definitions/MetadataValueDTO" | |
| } | |
| }, | |
| "lookupListCategory": { | |
| "type": "array", | |
| "description": "The lookupList data of the SearchPromptDTO object. This lookup list data is populated if and only if the search prompt attribute type is CATEGORY, which means that the prompt refers to a category. The category values are populated into this lookup list. If the attribute type is not CATEGORY, then this method will return a null value.", | |
| "items": { | |
| "$ref": "#/definitions/CategoryDTO" | |
| } | |
| }, | |
| "lookupListDocumentType": { | |
| "type": "array", | |
| "description": "The lookupList data of the SearchPromptDTO object. This lookup list data is populated if and only if the search prompt attribute type is DOCUMENT_TYPE, which means that the prompt refers to a document type. The document type values are populated into this lookup list. If the attribute type is not DOCUMENT_TYPE, then this method will return a null value.", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeDTO" | |
| } | |
| }, | |
| "lookupListDocumentVariables": { | |
| "type": "array", | |
| "description": "This lookup list data is populated if and only if the search prompt attribute type is DOCUMENT_VARIABLES, which means that the prompt refers to document variables. The documetn variable are populated into this lookup list. Note: This will not be ALL the document variables, but will be all the VALUES that have been set to a particular document variables. If the attribute type is not DOCUMENT_VARIABLES, then this method will return a null value.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the prompt is used during configuration of the search. It provides a way for a search prompt to be referenced by dynamic SQL sub-selects as well as referenced in this like bracket manager configuration." | |
| }, | |
| "attributeName": { | |
| "type": "string", | |
| "description": "The attribute name is not the name of the prompt, but rather, is a more specific description of the prompt that will be used to determine the type of attribute being represented by the prompt. NOTE: In most cases, the attribute name will be identical to the attribute type. However, in the case where the attribute type represents Document Attributes, for example, more specifics are needed to determine which attribute is being referenced by the prompt. This is where attribute name will have a different value." | |
| }, | |
| "defaultValueType": { | |
| "type": "string", | |
| "description": "The flag indicating that the type of the default value.", | |
| "enum": [ | |
| "NONE", | |
| "STATIC", | |
| "FIRST_VALUE" | |
| ] | |
| }, | |
| "searchPromptValue": { | |
| "description": "The search prompt value will be populated with the default value for this search prompt, if a default value does exist. If no default value exists, then the last value specified by the user will attempt to be retrieved, provided that the user had executed the search in the past and provided a value to the prompt.", | |
| "$ref": "#/definitions/SearchPromptValueDTO" | |
| }, | |
| "allowMultipleValues": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "filterCategory": { | |
| "type": "string", | |
| "description": "The name of the category that the prompt's options will be filtered by, thereby narrowing the options for the prompt." | |
| }, | |
| "filterCategoryId": { | |
| "type": "string", | |
| "description": "The ID of the category that the prompt's options will be filtered by, thereby narrowing the options for the prompt." | |
| }, | |
| "filterDocumentType": { | |
| "type": "string", | |
| "description": "The name of the document type that the prompt's options will be filtered by, thereby narrowing the options for the prompt." | |
| }, | |
| "filterDocumentTypeId": { | |
| "type": "string", | |
| "description": "The ID of the document type that the prompt's options will be filtered by, thereby narrowing the options for the prompt." | |
| }, | |
| "allowUserInput": { | |
| "type": "boolean", | |
| "description": "The allowUserInput attribute of the SearchPromptDTO. This field indicates if the user can edit the prompt value or not.", | |
| "default": false | |
| }, | |
| "lookupListDatasource": { | |
| "type": "array", | |
| "description": "The datasource used by the lookup list.", | |
| "items": { | |
| "$ref": "#/definitions/DataValue" | |
| } | |
| }, | |
| "responsibilityMapping": { | |
| "type": "array", | |
| "description": "The list of search prompt names that this prompt is responsible for executing when changed.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "minLength": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The minLength attribute of the SearchPromptDTO object, if the object represents a piece of metadata. This method is available for validation purposes. If the SearchPromptDTO object does not work on a STRING_VARIABLE metadata object, a null value is returned." | |
| }, | |
| "maxLength": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maxLength attribute of the SearchPromptDTO object, if the object represents a piece of metadata. This method is available for validation purposes. If the SearchPromptDTO object does not work on a STRING_VARIABLE metadata object, a null value is returned." | |
| }, | |
| "required": { | |
| "type": "boolean", | |
| "description": "The value required field indicates that this search cannot be executed unless a value is provided to this prompt", | |
| "default": false | |
| }, | |
| "promptLabel": { | |
| "type": "string", | |
| "description": " The label of the prompt. The label is not the name of the prompt, but rather, is the question, descriptor, or presentation string that the user will see describing the prompt. For example, the label could be (What is your first name?) or (Please enter your first name)" | |
| }, | |
| "searchPromptDatasource": { | |
| "description": "The datasource used by the search prompt.", | |
| "$ref": "#/definitions/SearchPromptDatasourceDTO" | |
| }, | |
| "searchPromptType": { | |
| "type": "string", | |
| "description": "The search prompt type of the SearchPromptDTO object. STATIC search prompts require no user interaction, but can be used to display values to the user that will be used during the execution of the search. PROMPTED search prompts require user input to retrieve their values.", | |
| "enum": [ | |
| "PROMPTED", | |
| "STATIC" | |
| ] | |
| } | |
| }, | |
| "description": "The representation the SearchPrompt domain object. Note that this object works with the composition context of a Search DTO. The SearchPrompt DTO contains all that data necessary to setup a search prompt in the system." | |
| }, | |
| "ShiftMemberDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "Gets the id attribute of the ShiftMemberDTO object." | |
| }, | |
| "userName": { | |
| "type": "string", | |
| "description": "Gets the userName attribute of the ShiftMemberDTO object." | |
| }, | |
| "firstName": { | |
| "type": "string", | |
| "description": "Gets the firstName attribute of the ShiftMemberDTO object." | |
| }, | |
| "lastName": { | |
| "type": "string", | |
| "description": "Gets the lastName attribute of the ShiftMemberDTO object." | |
| } | |
| }, | |
| "description": "DTO that contains information about a member of a shift." | |
| }, | |
| "ValidatorPluginDTO": { | |
| "type": "object", | |
| "properties": { | |
| "configResourcePath": { | |
| "type": "string" | |
| }, | |
| "displayName": { | |
| "type": "string" | |
| }, | |
| "entryControlResourcePath": { | |
| "type": "string" | |
| }, | |
| "validatorType": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ImporterStatusCommand": { | |
| "type": "object", | |
| "properties": { | |
| "importerId": { | |
| "type": "string", | |
| "description": "The importer id associated with the importer status." | |
| }, | |
| "action": { | |
| "type": "string", | |
| "description": "The importer status action associated with the importer.", | |
| "enum": [ | |
| "START", | |
| "STOP", | |
| "RESTART" | |
| ] | |
| }, | |
| "username": { | |
| "type": "string", | |
| "description": "The username of the person initiating the command." | |
| }, | |
| "ipAddress": { | |
| "type": "string", | |
| "description": "The ip address associated with the command." | |
| }, | |
| "resetLastErrorMessage": { | |
| "type": "boolean", | |
| "description": "If the last error message is to be reset.", | |
| "default": false | |
| } | |
| }, | |
| "description": "A command object used to start or stop an importer." | |
| }, | |
| "DocumentTypeGroup": { | |
| "type": "object", | |
| "required": [ | |
| "documentType", | |
| "group" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "documentType": { | |
| "$ref": "#/definitions/DocumentType" | |
| }, | |
| "group": { | |
| "$ref": "#/definitions/Group" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "documentSecurities": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DocumentSecurity" | |
| } | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "FormActionDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "condition": { | |
| "type": "string" | |
| }, | |
| "event": { | |
| "type": "string" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "properties": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormActionPropertyDTO" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "ProcessModel": { | |
| "type": "object", | |
| "required": [ | |
| "auditingEnabled", | |
| "dateModified", | |
| "isLocked", | |
| "name", | |
| "status", | |
| "version", | |
| "versionMapping", | |
| "xml" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "xml": { | |
| "type": "string" | |
| }, | |
| "isLocked": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "lockOwner": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "dateModified": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "ACTIVE", | |
| "INACTIVE", | |
| "INACTIVE_STILL_RUNNING" | |
| ] | |
| }, | |
| "versionMapping": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "processModelPackageItems": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProcessModelPackageItem" | |
| } | |
| }, | |
| "documentTypeProcessModels": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeProcessModel" | |
| } | |
| }, | |
| "auditingEnabled": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validateItems": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "GlobalSessionDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "userId": { | |
| "type": "string" | |
| }, | |
| "username": { | |
| "type": "string" | |
| }, | |
| "firstName": { | |
| "type": "string" | |
| }, | |
| "lastName": { | |
| "type": "string" | |
| }, | |
| "clientKey": { | |
| "type": "string" | |
| }, | |
| "licensableModuleId": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "lastAccess": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "licensePoolId": { | |
| "type": "string" | |
| }, | |
| "licensePoolName": { | |
| "type": "string" | |
| }, | |
| "revoked": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "deviceId": { | |
| "type": "string" | |
| }, | |
| "deviceType": { | |
| "type": "string", | |
| "enum": [ | |
| "MOBILE", | |
| "TABLET", | |
| "NORMAL" | |
| ] | |
| } | |
| } | |
| }, | |
| "OperationInfoDTO": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "namespace": { | |
| "type": "string" | |
| }, | |
| "input": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ParameterDTO" | |
| } | |
| }, | |
| "output": { | |
| "$ref": "#/definitions/ObjectDTO" | |
| } | |
| } | |
| }, | |
| "EmailImporterDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/ImporterDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the importer." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the importer." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description to be used by the importer." | |
| }, | |
| "running": { | |
| "type": "boolean", | |
| "description": "Flag indicating that the importer is running.", | |
| "default": false | |
| }, | |
| "idle": { | |
| "type": "boolean", | |
| "description": "Flag indicating importer is running but not processing.", | |
| "default": false | |
| }, | |
| "server": { | |
| "type": "string", | |
| "description": "The server details where the importer will run." | |
| }, | |
| "processType": { | |
| "type": "string", | |
| "description": "Importer process type.Values allowed are EMAIL,REPORT,COLD,OBJECT,INDEX.", | |
| "enum": [ | |
| "EMAIL", | |
| "REPORT", | |
| "INDEX", | |
| "OBJECT", | |
| "COLD" | |
| ] | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "The importer status INTERNAL/EXTERNAL.", | |
| "enum": [ | |
| "INTERNAL", | |
| "ACTIVE" | |
| ] | |
| }, | |
| "preRender": { | |
| "type": "boolean", | |
| "description": "Flag indicating that files imported by the importer will be pre-rendered.", | |
| "default": false | |
| }, | |
| "pollingFrequency": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Numeric indicating how often the importer would poll for files in the monitored directory/email folder." | |
| }, | |
| "pollingUnits": { | |
| "type": "string", | |
| "description": "String indicating what units the polling frequency uses. Valid values are SECONDS,MINUTES,HOURS,DAYS.", | |
| "enum": [ | |
| "SECONDS", | |
| "MINUTES", | |
| "HOURS", | |
| "DAYS" | |
| ] | |
| }, | |
| "calculatedProperties": { | |
| "type": "array", | |
| "description": "The calculated properties to be used by the importer.", | |
| "items": { | |
| "$ref": "#/definitions/CalculatedPropertyDTO" | |
| } | |
| }, | |
| "ruleSets": { | |
| "type": "array", | |
| "description": "The rulesets to be used by the importer.", | |
| "items": { | |
| "$ref": "#/definitions/RuleSetDTO" | |
| } | |
| }, | |
| "importerPluginName": { | |
| "type": "string", | |
| "description": "The plugin to be used by the importer." | |
| }, | |
| "schedule": { | |
| "description": "The importer schedule.", | |
| "$ref": "#/definitions/GenericScheduleDTO" | |
| }, | |
| "lastErrorMessage": { | |
| "type": "string", | |
| "description": "The last error message associated with the importer." | |
| }, | |
| "pending": { | |
| "type": "boolean", | |
| "description": "Flag indicating that start/stop of importer is pending.", | |
| "default": false | |
| }, | |
| "get_class": { | |
| "type": "string" | |
| }, | |
| "importerSettings": { | |
| "type": "string" | |
| }, | |
| "whiteList": { | |
| "type": "string", | |
| "description": "A list of email addresses to always accept mail from." | |
| }, | |
| "blackList": { | |
| "type": "string", | |
| "description": "A list of email addresses to never accept mail from." | |
| }, | |
| "toAddress": { | |
| "type": "string", | |
| "description": "The email address to be monitored." | |
| }, | |
| "username": { | |
| "type": "string", | |
| "description": "The username to connect to monitored email address." | |
| }, | |
| "password": { | |
| "type": "string", | |
| "description": "The password to connect to monitored email address." | |
| }, | |
| "hostname": { | |
| "type": "string", | |
| "description": "The host name where the email server is located." | |
| }, | |
| "port": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The port number where the email server is located." | |
| }, | |
| "folder": { | |
| "type": "string", | |
| "description": "The folder name in the email address inbox to be monitored." | |
| }, | |
| "importType": { | |
| "type": "string", | |
| "description": "The type of import to be done BODY,ATTACHMENTS,BOTH.", | |
| "enum": [ | |
| "BODY", | |
| "ATTACHMENTS", | |
| "BOTH", | |
| "NONE" | |
| ] | |
| }, | |
| "deleteMethod": { | |
| "type": "string", | |
| "description": "The type of delete to be done after import ALWAYS,NEVER,ON_IMPORT.", | |
| "enum": [ | |
| "ALWAYS", | |
| "ON_IMPORT", | |
| "NEVER" | |
| ] | |
| } | |
| }, | |
| "description": "An email importer." | |
| } | |
| ] | |
| }, | |
| "SearchSortOrderCustom": { | |
| "type": "object", | |
| "required": [ | |
| "ordinal", | |
| "searchSortOrder", | |
| "value" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "searchSortOrder": { | |
| "$ref": "#/definitions/SearchSortOrder" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "RestfulResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "description": "The collection of items.", | |
| "items": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "A generic object that holds a collection of items to be returned via JSON. Generally used when adding or updating items in conjunction with a Kendo DataSource." | |
| }, | |
| "DatabaseConnectionDTO": { | |
| "type": "object", | |
| "properties": { | |
| "acquireAttempts": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "acquireIncrement": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "databaseDriverName": { | |
| "type": "string" | |
| }, | |
| "standardUrl": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "initialPoolSize": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "maxIdleTime": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxPoolSize": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "minPoolSize": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "username": { | |
| "type": "string" | |
| }, | |
| "serverName": { | |
| "type": "string" | |
| }, | |
| "port": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "databaseName": { | |
| "type": "string" | |
| }, | |
| "customUrl": { | |
| "type": "string" | |
| }, | |
| "archive": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "useStandard": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "Sort": { | |
| "type": "object", | |
| "properties": { | |
| "field": { | |
| "type": "string", | |
| "description": "The field by which to sort." | |
| }, | |
| "ascending": { | |
| "type": "boolean", | |
| "description": "Whether to sort ascendingly or descendingly.", | |
| "default": false | |
| }, | |
| "dir": { | |
| "type": "string", | |
| "description": "The sort direction.", | |
| "enum": [ | |
| "asc", | |
| "desc" | |
| ] | |
| } | |
| }, | |
| "description": "A generic sort object that allows you to sort by a named field in either direction." | |
| }, | |
| "TaskPropertyDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "propertyName": { | |
| "type": "string" | |
| }, | |
| "propertyValue": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "HsmActionPropertyDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the HSM action property." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the HSM action property." | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "The value of the HSM action property." | |
| } | |
| }, | |
| "description": "The HSM action property details." | |
| }, | |
| "GrantedAuthority": { | |
| "type": "object", | |
| "properties": { | |
| "authority": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "TextDashboardPromptDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/DatasourceRequiredDashboardPromptDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DashboardInput." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The input name, must be unique per dashboard." | |
| }, | |
| "value": { | |
| "type": "object" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of input.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "DASHBOARD_PROMPT" | |
| ] | |
| }, | |
| "dashboardId": { | |
| "type": "string", | |
| "description": "The ID of the dashboard that owns this input." | |
| }, | |
| "dashboardName": { | |
| "type": "string", | |
| "description": "The name of the dashboard that owns this input." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The ID of the datasource used by this input." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "The name of the datasource used by this input." | |
| }, | |
| "datasourceResults": { | |
| "type": "array", | |
| "description": "The results from executing the datasource.", | |
| "items": { | |
| "$ref": "#/definitions/DataValue" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "responsibilityMapping": { | |
| "type": "array", | |
| "description": "The responsibility mapping for executing dependent inputs.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "dashboardInputDatasourceInputs": { | |
| "type": "array", | |
| "description": "The inputs needed for the datasource for this input.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardInputDatasourceInputDTO" | |
| } | |
| }, | |
| "label": { | |
| "type": "string", | |
| "description": "The prompt label." | |
| }, | |
| "promptType": { | |
| "type": "string", | |
| "description": "The prompt type.", | |
| "enum": [ | |
| "SWITCH", | |
| "DATE", | |
| "TEXT", | |
| "DROP_DOWN_LIST" | |
| ] | |
| }, | |
| "required": { | |
| "type": "boolean", | |
| "description": "Whether the input is required.", | |
| "default": false | |
| }, | |
| "defaultValueType": { | |
| "type": "string", | |
| "description": "The default value type.", | |
| "enum": [ | |
| "STATIC", | |
| "MACRO", | |
| "DATASOURCE", | |
| "FIRST", | |
| "SPECIFIC", | |
| "PROMPT" | |
| ] | |
| }, | |
| "defaultValue": { | |
| "type": "string", | |
| "description": "The default static text or macro." | |
| } | |
| }, | |
| "description": "A text prompt." | |
| } | |
| ] | |
| }, | |
| "LegendPropertiesDTO": { | |
| "type": "object", | |
| "properties": { | |
| "visible": { | |
| "type": "boolean", | |
| "description": "Whether the legend is visible.", | |
| "default": false | |
| }, | |
| "position": { | |
| "type": "string", | |
| "description": "The legend's position." | |
| } | |
| }, | |
| "description": "An object containing the configuration for a chart legend." | |
| }, | |
| "StaticDateDashboardInputDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/StaticDashboardInputDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DashboardInput." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The input name, must be unique per dashboard." | |
| }, | |
| "value": { | |
| "type": "object" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of input.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "DASHBOARD_PROMPT" | |
| ] | |
| }, | |
| "dashboardId": { | |
| "type": "string", | |
| "description": "The ID of the dashboard that owns this input." | |
| }, | |
| "dashboardName": { | |
| "type": "string", | |
| "description": "The name of the dashboard that owns this input." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The ID of the datasource used by this input." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "The name of the datasource used by this input." | |
| }, | |
| "datasourceResults": { | |
| "type": "array", | |
| "description": "The results from executing the datasource.", | |
| "items": { | |
| "$ref": "#/definitions/DataValue" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "responsibilityMapping": { | |
| "type": "array", | |
| "description": "The responsibility mapping for executing dependent inputs.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "dashboardInputDatasourceInputs": { | |
| "type": "array", | |
| "description": "The inputs needed for the datasource for this input.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardInputDatasourceInputDTO" | |
| } | |
| }, | |
| "staticType": { | |
| "type": "string", | |
| "description": "The type of static input.", | |
| "enum": [ | |
| "BOOLEAN", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "STRING" | |
| ] | |
| }, | |
| "dateValue": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "The static date value." | |
| } | |
| }, | |
| "description": "A static hidden date input." | |
| } | |
| ] | |
| }, | |
| "ProcessModelNameDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the process model name configuration data." | |
| }, | |
| "viewId": { | |
| "type": "string", | |
| "description": "The view id associated with the process model name configuration data." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name associated with the process model name configuration data." | |
| } | |
| }, | |
| "description": "Process model name information." | |
| }, | |
| "LicenseEmailDTO": { | |
| "type": "object", | |
| "properties": { | |
| "days": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "threshold": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "emailFrequency": { | |
| "type": "string", | |
| "enum": [ | |
| "NEVER", | |
| "DAILY", | |
| "WEEKLY", | |
| "MONTHLY" | |
| ] | |
| } | |
| } | |
| }, | |
| "DrillDownKeyValuePair": { | |
| "type": "object", | |
| "properties": { | |
| "key": { | |
| "type": "string", | |
| "description": "The name or key of the property." | |
| }, | |
| "value": { | |
| "type": "object", | |
| "description": "The current value of the property in its raw data type." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type of the property.", | |
| "enum": [ | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING" | |
| ] | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of drill down property in use.", | |
| "enum": [ | |
| "X_VALUE", | |
| "Y_VALUE", | |
| "R_VALUE", | |
| "SERIES_NAME", | |
| "TEXT_LABEL", | |
| "TEXT_VALUE", | |
| "CELL_VALUE", | |
| "COLUMN_HEADER", | |
| "NAMED_COLUMN_VALUE" | |
| ] | |
| }, | |
| "dataValue": { | |
| "type": "object" | |
| } | |
| }, | |
| "description": "An extension of KeyValuePair that supplies a type field." | |
| }, | |
| "ColdNarrativeDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the cold narrative." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Name of the cold narrative." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Description of the cold narrative." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Ordinal of the cold narrative." | |
| }, | |
| "coldNarrative": { | |
| "type": "string", | |
| "description": "Script of the cold narrative." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Flag indicating the cold narrative is to be deleted.", | |
| "default": false | |
| }, | |
| "rawFileUnderTest": { | |
| "type": "string", | |
| "description": "Path to the raw file to be tested." | |
| } | |
| }, | |
| "description": "The cold narrative configuration" | |
| }, | |
| "Throwable": { | |
| "type": "object", | |
| "properties": { | |
| "cause": { | |
| "$ref": "#/definitions/Throwable" | |
| }, | |
| "stackTrace": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/StackTraceElement" | |
| } | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "localizedMessage": { | |
| "type": "string" | |
| }, | |
| "suppressed": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Throwable" | |
| } | |
| } | |
| } | |
| }, | |
| "GroupMemberDTO": { | |
| "type": "object", | |
| "properties": { | |
| "groupAdmin": { | |
| "type": "boolean", | |
| "description": "Whether the user is an administrator of this group.", | |
| "default": false | |
| }, | |
| "groupId": { | |
| "type": "string", | |
| "description": "The group ID." | |
| }, | |
| "groupName": { | |
| "type": "string", | |
| "description": "The group name." | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "The ID." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "userId": { | |
| "type": "string", | |
| "description": "The user ID." | |
| }, | |
| "userName": { | |
| "type": "string", | |
| "description": "The username of the user." | |
| }, | |
| "firstName": { | |
| "type": "string", | |
| "description": "The user first name." | |
| }, | |
| "lastName": { | |
| "type": "string", | |
| "description": "The user last name." | |
| } | |
| }, | |
| "description": "A member of a group." | |
| }, | |
| "DatasourceProperty": { | |
| "type": "object", | |
| "required": [ | |
| "datasource", | |
| "displayName", | |
| "displayValue", | |
| "name", | |
| "value" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "datasource": { | |
| "$ref": "#/definitions/Datasource" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "displayName": { | |
| "type": "string" | |
| }, | |
| "displayValue": { | |
| "type": "string" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "GroupFeatureRight": { | |
| "type": "object", | |
| "required": [ | |
| "featureRight", | |
| "group" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "group": { | |
| "$ref": "#/definitions/Group" | |
| }, | |
| "featureRight": { | |
| "$ref": "#/definitions/FeatureRight" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "authority": { | |
| "type": "string" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "FeatureRight": { | |
| "type": "object", | |
| "required": [ | |
| "description", | |
| "name", | |
| "permissionClassification", | |
| "permissionKey", | |
| "permissionType" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "permissionClassification": { | |
| "$ref": "#/definitions/PermissionClassification" | |
| }, | |
| "permissionKey": { | |
| "type": "string" | |
| }, | |
| "permissionType": { | |
| "type": "string", | |
| "enum": [ | |
| "FEATURE_RIGHT", | |
| "GROUP_ADMINISTRATION", | |
| "SYSTEM_ACCESS" | |
| ] | |
| }, | |
| "groups": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Group" | |
| } | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "FormStep": { | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "ordinal" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": 0 | |
| }, | |
| "form": { | |
| "$ref": "#/definitions/Form" | |
| }, | |
| "formControlSteps": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormControlStep" | |
| } | |
| }, | |
| "deletedFormControlSteps": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormControlStep" | |
| } | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "BusinessDayDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "Gets the id of the business day." | |
| }, | |
| "weekDay": { | |
| "type": "string", | |
| "description": "Gets the weekday of the business day." | |
| }, | |
| "startTime": { | |
| "type": "string", | |
| "description": "Gets the start time of the business day." | |
| }, | |
| "endTime": { | |
| "type": "string", | |
| "description": "Gets the end time of the business day." | |
| }, | |
| "enabled": { | |
| "type": "boolean", | |
| "description": "Returns true if this business day is enabled.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The DTO object for a business day." | |
| }, | |
| "AxisScaleDTO": { | |
| "type": "object", | |
| "properties": { | |
| "visible": { | |
| "type": "boolean", | |
| "description": "Whether the axis is visible.", | |
| "default": false | |
| }, | |
| "label": { | |
| "type": "string", | |
| "description": "The axis label." | |
| }, | |
| "format": { | |
| "description": "The format for the axis label.", | |
| "$ref": "#/definitions/FormatDTO" | |
| }, | |
| "precision": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The scale precision." | |
| }, | |
| "titleRotation": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The axis title rotation." | |
| }, | |
| "labelRotation": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The axis label rotation." | |
| }, | |
| "labelStep": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "How many steps between labels." | |
| }, | |
| "majorStep": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The major step interval." | |
| }, | |
| "minorTicks": { | |
| "type": "boolean", | |
| "description": "Whether to show minor axis ticks.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The configuration for a chart's X or Y axis." | |
| }, | |
| "PagedCollection": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "description": "The current page of results.", | |
| "items": { | |
| "type": "object" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "SearchParameterDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the parameter associated with the search." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The indication as to whether or not to delete this parameter from the search.", | |
| "default": false | |
| }, | |
| "attributeId": { | |
| "type": "string", | |
| "description": "The ID of the attribute (data) associated with this parameter. If the data is non-metadata, then this ID will be NULL." | |
| }, | |
| "attributeName": { | |
| "type": "string", | |
| "description": "The name of the attribute (data) associated with this parameter." | |
| }, | |
| "metadataType": { | |
| "type": "string", | |
| "description": "The type of the metadata associated with this parameter. If the parameter is not associated to metadata, then this field will be NULL.", | |
| "enum": [ | |
| "DATE", | |
| "INTEGER", | |
| "DECIMAL", | |
| "STRING_VARIABLE" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal of this parameter with respect to other parameters in the search." | |
| }, | |
| "sortOrder": { | |
| "type": "string", | |
| "description": "The sort order associated with this parameter. NOTE: This value is no longer used because of SearchSortOrder.", | |
| "enum": [ | |
| "ASC", | |
| "DESC", | |
| "CUSTOM" | |
| ] | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of the parameter, indicating what needs to be associated to the parameter. Static static parameter will associate a static value with the parameter. A prompted parameter will require input from a user prompt. A custom parameter will require input from multiple sources to do a sub-select query from other tables to retrieve values to use in the search.", | |
| "enum": [ | |
| "PROMPTED", | |
| "STATIC", | |
| "MACRO", | |
| "CUSTOM" | |
| ] | |
| }, | |
| "attributeType": { | |
| "type": "string", | |
| "description": "The type of the attribute used by the parameter.", | |
| "enum": [ | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "FULL_TEXT", | |
| "DIARY", | |
| "METADATA", | |
| "OTHER", | |
| "STORED_PROC_PARAM", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES", | |
| "FILE_TYPE", | |
| "HIDDEN", | |
| "HIDDEN_DATE", | |
| "HIDDEN_INTEGER", | |
| "HIDDEN_DECIMAL" | |
| ] | |
| }, | |
| "comparatorType": { | |
| "type": "string", | |
| "description": "The comparator operator used in the execution and resolution of this parameter.", | |
| "enum": [ | |
| "EQUALS", | |
| "NOT_EQUALS", | |
| "GREATER_THAN", | |
| "LESS_THAN", | |
| "GREATER_THAN_EQUALS", | |
| "LESS_THAN_EQUALS", | |
| "CONTAINS", | |
| "NOT_CONTAINS", | |
| "IN" | |
| ] | |
| }, | |
| "connectiveType": { | |
| "type": "string", | |
| "description": "The connector that is used to connect this parameter and the parameter that occurs directly before this parameter when ordered by their parameter ordinal values within the search.", | |
| "enum": [ | |
| "AND", | |
| "OR" | |
| ] | |
| }, | |
| "dateValue": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "The date value of the parameter, when the parameter is a DATE data type. If the data type of the parameter is not a date, this value should be NULL." | |
| }, | |
| "decimalValue": { | |
| "type": "number", | |
| "format": "double", | |
| "description": "The decimal value of the parameter, when the parameter is a DECIMAL data type. If the data type of the parameter is not a decimal, this value should be NULL." | |
| }, | |
| "numericValue": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The numeric value of the parameter, when the parameter is a INTEGER data type. If the data type of the parameter is not a integer, this value should be NULL." | |
| }, | |
| "openingParen": { | |
| "type": "string", | |
| "description": "The representation of opening parenthesis that will begin groupings of parameters for execution purposes. If no parenthesis are associated with this parameter, then this value should be NULL." | |
| }, | |
| "closingParen": { | |
| "type": "string", | |
| "description": "The representation of closing parenthesis that will end groupings of parameters for execution purposes. If no parenthesis are associated with this parameter, then this value should be NULL." | |
| }, | |
| "searchPromptId": { | |
| "type": "string", | |
| "description": "The ID of the search prompt used in the execution of this parameter. This is the unique identifier of the search prompt to which this parameter is associated. If this parameter does not used a prompt, then this value should be NULL." | |
| }, | |
| "searchPromptName": { | |
| "type": "string", | |
| "description": "The name of the search prompt used in the execution of this parameter. This is the unique identifier (with a particular search) of the search prompt to which this parameter is associated. If this parameter does not used a prompt, then this value should be NULL." | |
| }, | |
| "promptLabel": { | |
| "type": "string" | |
| }, | |
| "valueRequired": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "lookupList": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "strValue": { | |
| "type": "string", | |
| "description": "The string value of the parameter, when the parameter is a STRING data type. If the data type of the parameter is not a string, this value should be NULL." | |
| } | |
| }, | |
| "description": "The representation of the parameter objects associated with a search." | |
| }, | |
| "DocumentTypeGroupDTO": { | |
| "type": "object", | |
| "properties": { | |
| "documentSecurityDtos": { | |
| "type": "array", | |
| "description": "The individual security permissions allowed for this group and document type.", | |
| "items": { | |
| "$ref": "#/definitions/DocumentSecurityDTO" | |
| } | |
| }, | |
| "documentTypeId": { | |
| "type": "string", | |
| "description": "The document type ID." | |
| }, | |
| "documentTypeName": { | |
| "type": "string", | |
| "description": "The document type name." | |
| }, | |
| "categoryId": { | |
| "type": "string", | |
| "description": "The ID of the category for the document type." | |
| }, | |
| "categoryName": { | |
| "type": "string", | |
| "description": "The name of the category for the document type." | |
| }, | |
| "groupId": { | |
| "type": "string", | |
| "description": "The group ID." | |
| }, | |
| "groupName": { | |
| "type": "string", | |
| "description": "The group name." | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "The unique identifier for this relationship." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "An object representing the document security configuration for 1 group and 1 document type." | |
| }, | |
| "SearchFormDataDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The unique identifier of the form data." | |
| }, | |
| "formControlName": { | |
| "type": "string", | |
| "description": "The name of the form control." | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "The value of the piece of form data." | |
| }, | |
| "searchId": { | |
| "type": "string", | |
| "description": "The unique identifier of the search." | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "The deleted attribute of the search form data.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The representation of the form data to associated to the search." | |
| }, | |
| "PrintFaxServer": { | |
| "type": "object", | |
| "required": [ | |
| "isSecureHttp", | |
| "port", | |
| "serverName", | |
| "serverType" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "serverName": { | |
| "type": "string" | |
| }, | |
| "port": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "isSecureHttp": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "devices": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/PrintFaxDevice" | |
| } | |
| }, | |
| "serverType": { | |
| "type": "string", | |
| "enum": [ | |
| "PRINTER", | |
| "FAX" | |
| ] | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "DrillDownChartInputDTO": { | |
| "type": "object", | |
| "required": [ | |
| "chartVariableId" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID." | |
| }, | |
| "drillDownId": { | |
| "type": "string", | |
| "description": "The ID of the DrillDown that owns this item." | |
| }, | |
| "chartVariableId": { | |
| "type": "string", | |
| "description": "The ID of the target chart variable." | |
| }, | |
| "chartVariableName": { | |
| "type": "string", | |
| "description": "The name of the target chart variable." | |
| }, | |
| "inputType": { | |
| "type": "string", | |
| "description": "The type of input given to the target chart variable.", | |
| "enum": [ | |
| "DASHBOARD_INPUT", | |
| "PARENT_INPUT", | |
| "PARENT_OUTPUT" | |
| ] | |
| }, | |
| "inputDashboardInputId": { | |
| "type": "string", | |
| "description": "The ID of the dashboard input to send as the value for the mapping, set only when inputType is DASHBOARD_INPUT." | |
| }, | |
| "inputDashboardInputName": { | |
| "type": "string", | |
| "description": "The name of the dashboard input to send as the value for the mapping, set only when inputType is DASHBOARD_INPUT." | |
| }, | |
| "parentDrillDownChartInputId": { | |
| "type": "string", | |
| "description": "The ID of the parent input to send as the value for the mapping, set only when inputType is PARENT_INPUT." | |
| }, | |
| "parentDrillDownChartInputName": { | |
| "type": "string", | |
| "description": "The name of the parent input to send as the value for the mapping, set only when inputType is PARENT_INPUT." | |
| }, | |
| "parentOutput": { | |
| "type": "string", | |
| "description": "The type of parent output to send as the value for the mapping, set only when inputType is PARENT_OUTPUT.", | |
| "enum": [ | |
| "X_VALUE", | |
| "Y_VALUE", | |
| "R_VALUE", | |
| "SERIES_NAME", | |
| "TEXT_LABEL", | |
| "TEXT_VALUE", | |
| "CELL_VALUE", | |
| "COLUMN_HEADER", | |
| "NAMED_COLUMN_VALUE" | |
| ] | |
| }, | |
| "tableColumnName": { | |
| "type": "string", | |
| "description": "The name of the table column to send as the value for the mapping, set only when inputType is PARENT_OUTPUT and parentOutput is NAMED_COLUMN_VALUE." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "An input mapping for a drill down to a chart." | |
| }, | |
| "DocumentTypeMetadataDatasource": { | |
| "type": "object", | |
| "required": [ | |
| "editable" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "documentTypeMetadata": { | |
| "$ref": "#/definitions/DocumentTypeMetadata" | |
| }, | |
| "datasource": { | |
| "$ref": "#/definitions/Datasource" | |
| }, | |
| "runDatasource": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "editable": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "IndexingConfigurationDTO": { | |
| "type": "object", | |
| "properties": { | |
| "allowErrorOverride": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "blindEntry": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "characterCase": { | |
| "type": "string", | |
| "enum": [ | |
| "NORMAL", | |
| "UPPER", | |
| "LOWER" | |
| ] | |
| }, | |
| "datasourceId": { | |
| "type": "string" | |
| }, | |
| "dependentMetadataIds": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "documentTypeId": { | |
| "type": "string" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "metadataId": { | |
| "type": "string" | |
| }, | |
| "retainValue": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "setFocus": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "sort": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validatorIds": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "runDatasource": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "isDatasourceEditable": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "OverlayDTO": { | |
| "type": "object", | |
| "properties": { | |
| "description": { | |
| "type": "string", | |
| "description": "Description of the overlay." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Name of the overlay." | |
| }, | |
| "overlayId": { | |
| "type": "string", | |
| "description": "ID of the overlay." | |
| }, | |
| "path": { | |
| "type": "string", | |
| "description": "Path to the overlay." | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "ID of the overlay." | |
| }, | |
| "tempFileId": { | |
| "type": "string", | |
| "description": "The ID/extension of the temporary file where the overlay file is stored, if the file is being added or updated." | |
| } | |
| }, | |
| "description": "Object that represents a document overlay." | |
| }, | |
| "DatasourceParameterDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the datasource parameter." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the datasource parameter." | |
| }, | |
| "source": { | |
| "type": "string", | |
| "description": "The source of the datasource parameter.", | |
| "enum": [ | |
| "STATIC", | |
| "MACRO", | |
| "VARIABLE" | |
| ] | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type of the datasource parameter.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "The value of the datasource parameter." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The datasource id of the datasource parameter." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "The datasource name of the datasource parameter." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The deleted flag of the datasource parameter.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The definition of a data source parameters." | |
| }, | |
| "SearchChecklistParameterDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The unique identifier of the parameter." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The indication of the intent to delete the parameter.", | |
| "default": false | |
| }, | |
| "attributeId": { | |
| "type": "string", | |
| "description": "The unique identifier of the metadata used in this parameter. If the data in this parameter is represents something non-metadata (like Category, for instance), then the attributeId will be NULL." | |
| }, | |
| "attributeName": { | |
| "type": "string", | |
| "description": "The name of the actual attribute for the parameter. If the attribute is metadata, this will be the name of the metadata." | |
| }, | |
| "metadataType": { | |
| "type": "string", | |
| "description": "The field describes the data type of the metadata. If this parameter does not use metadata, then the metadata type field will be NULL.", | |
| "enum": [ | |
| "DATE", | |
| "INTEGER", | |
| "DECIMAL", | |
| "STRING_VARIABLE" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal value, used to place the parameters in the correct order for execution of the search." | |
| }, | |
| "sortOrder": { | |
| "type": "string", | |
| "description": "Deprecated - this is no longer used. SearchSortOrder is used for sorting instead.", | |
| "enum": [ | |
| "ASC", | |
| "DESC", | |
| "CUSTOM" | |
| ] | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of the SearchChecklistParameterDTO object. A static parameter will associate a static value with the parameter. A prompted parameter will require input from a user prompt. A custom parameter will require input from multiple sources to do a sub-select query from other tables to retrieve values to use in the search.", | |
| "enum": [ | |
| "PROMPTED", | |
| "STATIC", | |
| "MACRO", | |
| "CUSTOM" | |
| ] | |
| }, | |
| "attributeType": { | |
| "type": "string", | |
| "description": "The type of the search parameter attribute, describing what piece of data to which this search parameter is associated. Note that based on attribute type, other fields in this DTO may be required fields.", | |
| "enum": [ | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "FULL_TEXT", | |
| "DIARY", | |
| "METADATA", | |
| "OTHER", | |
| "STORED_PROC_PARAM", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES", | |
| "FILE_TYPE", | |
| "HIDDEN", | |
| "HIDDEN_DATE", | |
| "HIDDEN_INTEGER", | |
| "HIDDEN_DECIMAL" | |
| ] | |
| }, | |
| "comparatorType": { | |
| "type": "string", | |
| "description": "The comparison operator that will be used during search execution when working with this search parameter.", | |
| "enum": [ | |
| "EQUALS", | |
| "NOT_EQUALS", | |
| "GREATER_THAN", | |
| "LESS_THAN", | |
| "GREATER_THAN_EQUALS", | |
| "LESS_THAN_EQUALS", | |
| "CONTAINS", | |
| "NOT_CONTAINS", | |
| "IN" | |
| ] | |
| }, | |
| "connectiveType": { | |
| "type": "string", | |
| "description": "The connective type operator that will be used during the search execution when working with this search parameter. This connector will connect this search parameter and the parameter that occurs directly before this parameter when ordered by their ordinal values.", | |
| "enum": [ | |
| "AND", | |
| "OR" | |
| ] | |
| }, | |
| "dateValue": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "The date type value for the metadata used in this search parameter. If the parameter reppresents a piece of metadata and the attribute type describing the metadata data type is a DATE, then this value will be required. Otherwise, this value should be NULL. Also note, this parameter is required if the MetadataType parameter equals DATE. " | |
| }, | |
| "decimalValue": { | |
| "type": "number", | |
| "format": "double", | |
| "description": "The decimal value for the metadata used in this search parameter. If the parameter represents a piece of metadata and the attribute type describing the metadata data type is a DECIMAL, then this value will be required. Otherwise, this value should be NULL. Also note, this parameter is required if the MetadataType parameter equals DECIMAL." | |
| }, | |
| "numericValue": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The numeric value for the metadata used in this search parameter. If the parameter represents a piece of metadata and the attribute type describing the metadata data type is a INTEGER, then this value will be required. Otherwise, this value should be NULL. Also note, this parameter is required if the MetadataType parameter equals INTEGER." | |
| }, | |
| "openingParen": { | |
| "type": "string", | |
| "description": "The string representation of opening parenthesis - ( - that will begin groupings of parameters for search queries. If no parenthesis are associated with this parameter, then this method will return NULL." | |
| }, | |
| "closingParen": { | |
| "type": "string", | |
| "description": "The string representation of closing parenthesis - ) - that will end groupings of parameters for search queries. If no parenthesis are associated with this parameter, then this method will return NULL." | |
| }, | |
| "searchPromptId": { | |
| "type": "string", | |
| "description": "The search prompt id attribute of the SearchChecklistParameterDTO object. The search prompt id is the unique identifier of the search prompt to which this search parameter is associated. If the parameter does not use a single prompt - or a prompt at all - then this will be NULL " | |
| }, | |
| "searchPromptName": { | |
| "type": "string", | |
| "description": "The search prompt name attribute of the SearchChecklistParameterDTO object. The search prompt name is the unique identifier of the search prompt to which this search parameter is associated on a per search basis. Across multiple searches, prompts may have the same name, but within a single search, each prompts name must be unique. If the parameter uses multiple prompts - or the parameter doesn't use a prompt at all, then this will be NULL." | |
| }, | |
| "strValue": { | |
| "type": "string", | |
| "description": "The string value for the metadata used in this search parameter. If the parameter represents a piece of metadata and the attribute type describing the metadata data type is a STRING, then this value will be required. Otherwise, this value should be NULL. Also note, Required - this parameter is required if the MetadataType parameter equals STRING." | |
| } | |
| }, | |
| "description": "The representation of the SearchChecklistParameter domain object. Note that this object works with the composition context of a Search dto." | |
| }, | |
| "DocumentErrorResultDTO": { | |
| "type": "object", | |
| "properties": { | |
| "documentId": { | |
| "type": "string", | |
| "description": "The ID of the document." | |
| }, | |
| "errorMessage": { | |
| "type": "string", | |
| "description": "The specific error message of this object." | |
| }, | |
| "errorCode": { | |
| "type": "string", | |
| "description": "The specific error code associated with this object.", | |
| "enum": [ | |
| "INSUFFICIENT_PERMISSIONS", | |
| "DOCUMENT_IN_BUSINESS_PROCESS", | |
| "DOES_NOT_EXIST", | |
| "FILE_NOT_DELETED", | |
| "DOCUMENT_IS_BEING_EDITED", | |
| "REPOSITORY_NOT_WRITABLE", | |
| "FILE_NOT_MARKED_AS_EXTERNAL", | |
| "DOCUMENT_ON_LEGAL_HOLD", | |
| "RUNTIME_EXCEPTION" | |
| ] | |
| }, | |
| "displayName": { | |
| "type": "string", | |
| "description": "The display name of the document." | |
| }, | |
| "localizedErrorCode": { | |
| "type": "string", | |
| "description": "The localized error message of the object." | |
| } | |
| } | |
| }, | |
| "SearchPromptDatasourceParamDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the parameter to the datasource associated with the search prompt." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The indication as to whether or not to delete this parameter to the datasource associated with the search prompt.", | |
| "default": false | |
| }, | |
| "datasourceParameterName": { | |
| "type": "string", | |
| "description": "The name of the parameter to the datasource associated with the search prompt." | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "The value of the parameter to the datasource associated with the search prompt." | |
| }, | |
| "searchPromptDatasourceParameterType": { | |
| "type": "string", | |
| "description": "The type (NONE, STATIC, MACRO, PROMPT) of the parameter to the datasource associated with the search prompt.", | |
| "enum": [ | |
| "NONE", | |
| "STATIC", | |
| "MACRO", | |
| "PROMPT" | |
| ] | |
| } | |
| }, | |
| "description": "The representation of the parameter objects to a datasource uses in a search prompt." | |
| }, | |
| "ProcessModelDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "xml": { | |
| "name": "result" | |
| }, | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/ProcessModelDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "UserViewerSetting": { | |
| "type": "object", | |
| "required": [ | |
| "docTypeMetadata", | |
| "rotationAngle", | |
| "user", | |
| "zoomFactor" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/User" | |
| }, | |
| "docTypeMetadata": { | |
| "$ref": "#/definitions/DocumentTypeMetadata" | |
| }, | |
| "zoomFactor": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "rotationAngle": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "xcoordinate": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "ycoordinate": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "DocumentTypeMetadataValidator": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "documentTypeMetadata": { | |
| "$ref": "#/definitions/DocumentTypeMetadata" | |
| }, | |
| "validator": { | |
| "$ref": "#/definitions/Validator" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "ChartableDTO": { | |
| "type": "object", | |
| "discriminator": "_class", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "INTERNAL", | |
| "STANDARD" | |
| ] | |
| }, | |
| "isLocked": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "lockOwner": { | |
| "type": "string" | |
| }, | |
| "lockOwnerFirstName": { | |
| "type": "string" | |
| }, | |
| "lockOwnerLastName": { | |
| "type": "string" | |
| }, | |
| "dateModified": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "properties": { | |
| "$ref": "#/definitions/ChartablePropertiesDTO" | |
| }, | |
| "datasourceId": { | |
| "type": "string" | |
| }, | |
| "datasourceName": { | |
| "type": "string" | |
| }, | |
| "datasourceParameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DatasourceArgumentDTO" | |
| } | |
| }, | |
| "refreshInterval": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "isValid": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "variables": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartVariableDTO" | |
| } | |
| }, | |
| "datasourceInputs": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartDatasourceInputDTO" | |
| } | |
| }, | |
| "dashboardCount": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "overrideErrorsOnSave": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| }, | |
| "description": "The representation of a Chart object." | |
| }, | |
| "GroupTotalDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "xml": { | |
| "name": "result" | |
| }, | |
| "description": "A page of group total search results.", | |
| "items": { | |
| "$ref": "#/definitions/GroupTotalDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged search result for group totals." | |
| }, | |
| "ViewPromptResultDTO": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "stringValue": { | |
| "type": "string" | |
| }, | |
| "dateValue": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "numericValue": { | |
| "type": "number", | |
| "format": "double" | |
| } | |
| } | |
| }, | |
| "DashboardCategoryDTO": { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the category." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the category. Must be unique." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "A brief description of the category." | |
| } | |
| }, | |
| "description": "A category used to group together related dashboards." | |
| }, | |
| "FormGroup": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "formName": { | |
| "type": "string" | |
| }, | |
| "group": { | |
| "$ref": "#/definitions/Group" | |
| }, | |
| "groupId": { | |
| "type": "string" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "ImporterDTO": { | |
| "type": "object", | |
| "discriminator": "_class", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the importer." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the importer." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description to be used by the importer." | |
| }, | |
| "running": { | |
| "type": "boolean", | |
| "description": "Flag indicating that the importer is running.", | |
| "default": false | |
| }, | |
| "idle": { | |
| "type": "boolean", | |
| "description": "Flag indicating importer is running but not processing.", | |
| "default": false | |
| }, | |
| "server": { | |
| "type": "string", | |
| "description": "The server details where the importer will run." | |
| }, | |
| "processType": { | |
| "type": "string", | |
| "description": "Importer process type.Values allowed are EMAIL,REPORT,COLD,OBJECT,INDEX.", | |
| "enum": [ | |
| "EMAIL", | |
| "REPORT", | |
| "INDEX", | |
| "OBJECT", | |
| "COLD" | |
| ] | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "The importer status INTERNAL/EXTERNAL.", | |
| "enum": [ | |
| "INTERNAL", | |
| "ACTIVE" | |
| ] | |
| }, | |
| "preRender": { | |
| "type": "boolean", | |
| "description": "Flag indicating that files imported by the importer will be pre-rendered.", | |
| "default": false | |
| }, | |
| "pollingFrequency": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Numeric indicating how often the importer would poll for files in the monitored directory/email folder." | |
| }, | |
| "pollingUnits": { | |
| "type": "string", | |
| "description": "String indicating what units the polling frequency uses. Valid values are SECONDS,MINUTES,HOURS,DAYS.", | |
| "enum": [ | |
| "SECONDS", | |
| "MINUTES", | |
| "HOURS", | |
| "DAYS" | |
| ] | |
| }, | |
| "calculatedProperties": { | |
| "type": "array", | |
| "description": "The calculated properties to be used by the importer.", | |
| "items": { | |
| "$ref": "#/definitions/CalculatedPropertyDTO" | |
| } | |
| }, | |
| "ruleSets": { | |
| "type": "array", | |
| "description": "The rulesets to be used by the importer.", | |
| "items": { | |
| "$ref": "#/definitions/RuleSetDTO" | |
| } | |
| }, | |
| "importerPluginName": { | |
| "type": "string", | |
| "description": "The plugin to be used by the importer." | |
| }, | |
| "schedule": { | |
| "description": "The importer schedule.", | |
| "$ref": "#/definitions/GenericScheduleDTO" | |
| }, | |
| "lastErrorMessage": { | |
| "type": "string", | |
| "description": "The last error message associated with the importer." | |
| }, | |
| "pending": { | |
| "type": "boolean", | |
| "description": "Flag indicating that start/stop of importer is pending.", | |
| "default": false | |
| }, | |
| "get_class": { | |
| "type": "string" | |
| }, | |
| "importerSettings": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": "The representation of an Importer object." | |
| }, | |
| "FeatureRightDTO": { | |
| "type": "object", | |
| "properties": { | |
| "classificationId": { | |
| "type": "string", | |
| "description": "The ID of the classification group for this feature right." | |
| }, | |
| "classificationName": { | |
| "type": "string", | |
| "description": "The classification name." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The feature right description." | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "The feature right ID." | |
| }, | |
| "key": { | |
| "type": "string", | |
| "description": "The feature right key (unique)." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The feature right name." | |
| } | |
| }, | |
| "description": "A feature right for the system." | |
| }, | |
| "OutputStream": { | |
| "type": "object" | |
| }, | |
| "Document": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "documentType": { | |
| "$ref": "#/definitions/DocumentType" | |
| }, | |
| "fileStore": { | |
| "$ref": "#/definitions/FileStore" | |
| }, | |
| "creator": { | |
| "type": "string" | |
| }, | |
| "createdByUser": { | |
| "$ref": "#/definitions/User" | |
| }, | |
| "indexed": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "redacted": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "indexedDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "indexedBy": { | |
| "type": "string" | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "displayName": { | |
| "type": "string" | |
| }, | |
| "diaries": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Diary" | |
| } | |
| }, | |
| "diaryCount": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "dateDeleted": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "deletedBy": { | |
| "type": "string" | |
| }, | |
| "deletedByUser": { | |
| "$ref": "#/definitions/User" | |
| }, | |
| "importUniquenessHash": { | |
| "type": "string" | |
| }, | |
| "formDocuments": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormDocument" | |
| } | |
| }, | |
| "documentVariables": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DocumentVariable" | |
| } | |
| }, | |
| "lastViewedDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "retentionPolicy": { | |
| "$ref": "#/definitions/RetentionPolicy" | |
| }, | |
| "retentionPolicyOverridden": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "retentionPolicyOverrideDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "retentionPolicyOverrideUser": { | |
| "$ref": "#/definitions/User" | |
| }, | |
| "legalHolds": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/LegalHold" | |
| } | |
| }, | |
| "dispositionQueueItems": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/DispositionQueueItem" | |
| } | |
| }, | |
| "newlyIndexed": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "reindexDocumentTypeChanged": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "lastModifiedDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "entryMethod": { | |
| "type": "string", | |
| "enum": [ | |
| "PRINT_TO", | |
| "SEND_TO", | |
| "SCAN_TO", | |
| "IMPORT", | |
| "SCAN", | |
| "BPM", | |
| "FILE_UPLOAD", | |
| "OFFICE", | |
| "FORM", | |
| "POINTER", | |
| "SAVE_SEARCH", | |
| "EDITING", | |
| "UNKNOWN" | |
| ] | |
| }, | |
| "onLegalHold": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "checklistDocument": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validateRetentionPolicyMetadata": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "queuedForDisposition": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "PreviewChartDTO": { | |
| "type": "object", | |
| "properties": { | |
| "chart": { | |
| "description": "The fully populated ChartDTO.", | |
| "$ref": "#/definitions/ChartableDTO" | |
| }, | |
| "executeDatasource": { | |
| "type": "boolean", | |
| "description": "Whether to execute the datasource for the chart.", | |
| "default": false | |
| }, | |
| "previouslyRenderedChart": { | |
| "type": "string", | |
| "description": "The previous JSON for the chart." | |
| }, | |
| "keyValuePairs": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/KeyValuePair" | |
| } | |
| } | |
| }, | |
| "description": "An object that contains the data necessary to preview a chart." | |
| }, | |
| "Actor": { | |
| "type": "object", | |
| "required": [ | |
| "actor", | |
| "ordinal", | |
| "role" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "actor": { | |
| "type": "string" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/User" | |
| }, | |
| "role": { | |
| "$ref": "#/definitions/Role" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": 0 | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "MacroFunctionDTO": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "argumentCount": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "Permission": { | |
| "type": "object", | |
| "required": [ | |
| "description", | |
| "name", | |
| "permissionClassification", | |
| "permissionKey", | |
| "permissionType" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "permissionClassification": { | |
| "$ref": "#/definitions/PermissionClassification" | |
| }, | |
| "permissionKey": { | |
| "type": "string" | |
| }, | |
| "permissionType": { | |
| "type": "string", | |
| "enum": [ | |
| "FEATURE_RIGHT", | |
| "GROUP_ADMINISTRATION", | |
| "SYSTEM_ACCESS" | |
| ] | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "SearchTreeFilter": { | |
| "type": "object", | |
| "required": [ | |
| "attributeName", | |
| "attributeType", | |
| "ordinal", | |
| "search", | |
| "sortOrder" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributeType": { | |
| "type": "string", | |
| "enum": [ | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "FULL_TEXT", | |
| "DIARY", | |
| "METADATA", | |
| "OTHER", | |
| "STORED_PROC_PARAM", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES", | |
| "FILE_TYPE", | |
| "HIDDEN", | |
| "HIDDEN_DATE", | |
| "HIDDEN_INTEGER", | |
| "HIDDEN_DECIMAL" | |
| ] | |
| }, | |
| "attributeName": { | |
| "type": "string" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Metadata" | |
| }, | |
| "search": { | |
| "$ref": "#/definitions/Search" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "sortOrder": { | |
| "type": "string", | |
| "enum": [ | |
| "ASC", | |
| "DESC", | |
| "CUSTOM" | |
| ] | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "isNew": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "RoleDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "description": "A page of role search results.", | |
| "items": { | |
| "$ref": "#/definitions/RoleDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "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 | |
| } | |
| } | |
| }, | |
| "ValidationError": { | |
| "type": "object", | |
| "properties": { | |
| "objectName": { | |
| "type": "string", | |
| "description": "The name of the object to which the error pertains." | |
| }, | |
| "fieldName": { | |
| "type": "string", | |
| "description": "The name of the filed to which the error pertains." | |
| }, | |
| "errorCode": { | |
| "type": "string", | |
| "description": "A generic error code." | |
| }, | |
| "errorMessage": { | |
| "type": "string", | |
| "description": "The detailed error message." | |
| }, | |
| "errorInfo": { | |
| "type": "string", | |
| "description": "Additional error information." | |
| }, | |
| "localeErrorCode": { | |
| "type": "string", | |
| "description": "The DocFinity locale error code." | |
| } | |
| }, | |
| "description": "A single validation error or warning." | |
| }, | |
| "Overlay": { | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "path" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "path": { | |
| "type": "string" | |
| }, | |
| "nameChanged": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "SearchResultColumn": { | |
| "type": "object", | |
| "required": [ | |
| "attributeName", | |
| "attributeType", | |
| "ordinal", | |
| "search" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributeType": { | |
| "type": "string", | |
| "enum": [ | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "FULL_TEXT", | |
| "DIARY", | |
| "METADATA", | |
| "OTHER", | |
| "STORED_PROC_PARAM", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES", | |
| "FILE_TYPE", | |
| "HIDDEN", | |
| "HIDDEN_DATE", | |
| "HIDDEN_INTEGER", | |
| "HIDDEN_DECIMAL" | |
| ] | |
| }, | |
| "attributeName": { | |
| "type": "string" | |
| }, | |
| "search": { | |
| "$ref": "#/definitions/Search" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Metadata" | |
| }, | |
| "searchResultLinkedMetadata": { | |
| "$ref": "#/definitions/SearchResultLinkedMetadata" | |
| }, | |
| "attribute": { | |
| "type": "object" | |
| }, | |
| "attributeId": { | |
| "type": "string" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "DatasourceParameter": { | |
| "type": "object", | |
| "required": [ | |
| "dataType", | |
| "datasource", | |
| "name", | |
| "source" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "datasource": { | |
| "$ref": "#/definitions/Datasource" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "source": { | |
| "type": "string", | |
| "enum": [ | |
| "STATIC", | |
| "MACRO", | |
| "VARIABLE" | |
| ] | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "validateMacro": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "RenderDashboardDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the dashboard." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the dashboard." | |
| }, | |
| "isValid": { | |
| "type": "boolean", | |
| "description": "Whether the dashboard is currently in a valid state.", | |
| "default": false | |
| }, | |
| "backgroundColor": { | |
| "type": "string", | |
| "description": "The background color of the dashboard." | |
| }, | |
| "margin": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The margin between charts on the dashboard." | |
| }, | |
| "content": { | |
| "type": "array", | |
| "description": "The charts that reside on the dashboard.", | |
| "items": { | |
| "$ref": "#/definitions/RenderDashboardContentDTO" | |
| } | |
| }, | |
| "dateModified": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "The date and time when the dashboard was last modified." | |
| } | |
| }, | |
| "description": "An object used to render a dashboard." | |
| }, | |
| "DocumentTypeProcessModelDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "documentTypeId": { | |
| "type": "string" | |
| }, | |
| "documentTypeName": { | |
| "type": "string" | |
| }, | |
| "processModelId": { | |
| "type": "string" | |
| }, | |
| "processModelName": { | |
| "type": "string" | |
| }, | |
| "packageItemName": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "GaugeChartDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/ChartDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "INTERNAL", | |
| "STANDARD" | |
| ] | |
| }, | |
| "isLocked": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "lockOwner": { | |
| "type": "string" | |
| }, | |
| "lockOwnerFirstName": { | |
| "type": "string" | |
| }, | |
| "lockOwnerLastName": { | |
| "type": "string" | |
| }, | |
| "dateModified": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "properties": { | |
| "$ref": "#/definitions/ChartablePropertiesDTO" | |
| }, | |
| "datasourceId": { | |
| "type": "string" | |
| }, | |
| "datasourceName": { | |
| "type": "string" | |
| }, | |
| "datasourceParameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DatasourceArgumentDTO" | |
| } | |
| }, | |
| "refreshInterval": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "isValid": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "variables": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartVariableDTO" | |
| } | |
| }, | |
| "datasourceInputs": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartDatasourceInputDTO" | |
| } | |
| }, | |
| "dashboardCount": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "overrideErrorsOnSave": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "chartType": { | |
| "type": "string", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "labelColumn": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| }, | |
| "seriesColumn": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| }, | |
| "dataColumns": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| } | |
| } | |
| }, | |
| "description": "A gauge chart." | |
| } | |
| ] | |
| }, | |
| "DataSource": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "inputStream": { | |
| "$ref": "#/definitions/InputStream" | |
| }, | |
| "contentType": { | |
| "type": "string" | |
| }, | |
| "outputStream": { | |
| "$ref": "#/definitions/OutputStream" | |
| } | |
| } | |
| }, | |
| "ValidatorDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "xml": { | |
| "name": "result" | |
| }, | |
| "description": "Representation of the pageable collection of validators.", | |
| "items": { | |
| "$ref": "#/definitions/ValidatorDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "An object representing a pageable collection of validators." | |
| }, | |
| "CommandInfo": { | |
| "type": "object", | |
| "properties": { | |
| "commandName": { | |
| "type": "string" | |
| }, | |
| "commandClass": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "SearchGroupDTO": { | |
| "type": "object", | |
| "properties": { | |
| "groupId": { | |
| "type": "string", | |
| "description": "The ID of the associated group." | |
| }, | |
| "groupName": { | |
| "type": "string", | |
| "description": "The name of the associated group." | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "The ID used to uniquely identify the search to group association." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The flag indicating if the association should be deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "Representation of the search to group association." | |
| }, | |
| "DatasourcePropertyDTO": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the datasource property." | |
| }, | |
| "value": { | |
| "type": "array", | |
| "description": "The value of the datasource property.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the datasource property." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The datasource id of the datasource property." | |
| }, | |
| "displayName": { | |
| "type": "string", | |
| "description": "The display name of the datasource property." | |
| }, | |
| "displayValue": { | |
| "type": "string", | |
| "description": "The display value of the datasource property." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The deleted flag of the datasource property.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The definition of a data source properties." | |
| }, | |
| "DocumentTypeScanSetting": { | |
| "type": "object", | |
| "required": [ | |
| "documentType", | |
| "scanSetting" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "documentType": { | |
| "$ref": "#/definitions/DocumentType" | |
| }, | |
| "scanSetting": { | |
| "$ref": "#/definitions/ScanSetting" | |
| }, | |
| "documentTypeId": { | |
| "type": "string" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "ValidatorPropertyDTO": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "description": "An object representing the name of the validator property." | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "An object representing the value of the validator property." | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "An object representing the ID of the validator property." | |
| }, | |
| "validatorId": { | |
| "type": "string", | |
| "description": "An object representing the ID of the validator associated to this property." | |
| }, | |
| "displayName": { | |
| "type": "string", | |
| "description": "An object representing the display name of the validator property." | |
| }, | |
| "displayValue": { | |
| "type": "string", | |
| "description": "An object representing the display value of the validator property." | |
| } | |
| }, | |
| "description": "An object representing the validator type-specific properties." | |
| }, | |
| "SearchResultLinkedMetadataDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The unique identifier of the search result linked output column." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The ID of the datasource associated with the linked output column." | |
| }, | |
| "columnName": { | |
| "type": "string", | |
| "description": "The name of the linked output column." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The indication of the intent to delete the search result linked output column.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The representation of the search result linked output column." | |
| }, | |
| "DocumentPreviewSearchResults": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/DocumentPreviewDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "DocumentTypeMetadataDependent": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "documentTypeMetadata": { | |
| "$ref": "#/definitions/DocumentTypeMetadata" | |
| }, | |
| "dependentDocumentTypeMetadata": { | |
| "$ref": "#/definitions/DocumentTypeMetadata" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "HsmDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "xml": { | |
| "name": "result" | |
| }, | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/HsmDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "MacroDashboardInputDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/DashboardInputDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DashboardInput." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The input name, must be unique per dashboard." | |
| }, | |
| "value": { | |
| "type": "object" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of input.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "DASHBOARD_PROMPT" | |
| ] | |
| }, | |
| "dashboardId": { | |
| "type": "string", | |
| "description": "The ID of the dashboard that owns this input." | |
| }, | |
| "dashboardName": { | |
| "type": "string", | |
| "description": "The name of the dashboard that owns this input." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The ID of the datasource used by this input." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "The name of the datasource used by this input." | |
| }, | |
| "datasourceResults": { | |
| "type": "array", | |
| "description": "The results from executing the datasource.", | |
| "items": { | |
| "$ref": "#/definitions/DataValue" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "responsibilityMapping": { | |
| "type": "array", | |
| "description": "The responsibility mapping for executing dependent inputs.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "dashboardInputDatasourceInputs": { | |
| "type": "array", | |
| "description": "The inputs needed for the datasource for this input.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardInputDatasourceInputDTO" | |
| } | |
| }, | |
| "macroString": { | |
| "type": "string", | |
| "description": "The macro string." | |
| } | |
| }, | |
| "description": "A hidden macro datasource input." | |
| } | |
| ] | |
| }, | |
| "SystemTransferStatusDTO": { | |
| "type": "object", | |
| "required": [ | |
| "running" | |
| ], | |
| "properties": { | |
| "progress": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "The percentage complete of the system transfer import." | |
| }, | |
| "running": { | |
| "type": "boolean", | |
| "description": "Whether or not something is importing on this node.", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "Group": { | |
| "type": "object", | |
| "required": [ | |
| "description", | |
| "groupStatus", | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "featureRights": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FeatureRight" | |
| } | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "groupStatus": { | |
| "type": "string", | |
| "enum": [ | |
| "ACTIVE", | |
| "INACTIVE", | |
| "INTERNAL", | |
| "DELETED" | |
| ] | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "objectGuid": { | |
| "type": "string" | |
| }, | |
| "modifiedTimeStamp": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "members": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/GroupMember" | |
| } | |
| }, | |
| "formGroups": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormGroup" | |
| } | |
| }, | |
| "deviceGroups": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DeviceGroup" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "users": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/User" | |
| } | |
| }, | |
| "originalName": { | |
| "type": "string" | |
| }, | |
| "groupFeatureRights": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/GroupFeatureRight" | |
| } | |
| }, | |
| "nameChanged": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "groupAssociationLevel": { | |
| "type": "string", | |
| "enum": [ | |
| "ALL", | |
| "PARTIAL", | |
| "NONE" | |
| ] | |
| }, | |
| "validateGroupNameLength": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "GenericScheduleDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "Gets the id attribute of the GenericScheduleDTO object." | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "Gets the type attribute of the GenericScheduleDTO object.", | |
| "enum": [ | |
| "LDAP", | |
| "IMPORTER", | |
| "RETENTION_POLICY" | |
| ] | |
| }, | |
| "target": { | |
| "type": "string", | |
| "description": "Gets the target attribute of the GenericScheduleDTO object." | |
| }, | |
| "enabled": { | |
| "type": "boolean", | |
| "description": "Gets the enabled attribute of the GenericScheduleDTO object.", | |
| "default": false | |
| }, | |
| "occurrenceType": { | |
| "type": "string", | |
| "description": "Gets the occurrenceType attribute of the GenericScheduleDTO object.", | |
| "enum": [ | |
| "DAILY", | |
| "WEEKLY", | |
| "MONTHLY" | |
| ] | |
| }, | |
| "times": { | |
| "type": "array", | |
| "description": "Gets the times attribute of the GenericScheduleDTO object.", | |
| "items": { | |
| "$ref": "#/definitions/GenericScheduledTimeDTO" | |
| } | |
| } | |
| }, | |
| "description": "DTO for a GenericSchedule entity." | |
| }, | |
| "Metadata": { | |
| "type": "object", | |
| "required": [ | |
| "currencyLocale", | |
| "description", | |
| "isCollection", | |
| "isCurrency", | |
| "name", | |
| "shortName" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "markedForRecreate": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "shortName": { | |
| "type": "string" | |
| }, | |
| "isCollection": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "isCurrency": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "decimalPrecision": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "currencyLocale": { | |
| "type": "string" | |
| }, | |
| "documentTypeMetadatas": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeMetadata" | |
| } | |
| }, | |
| "searchMetadatas": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchParameter" | |
| } | |
| }, | |
| "searchResultMetadatas": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchResultColumn" | |
| } | |
| }, | |
| "searchSortOrderMetadatas": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchSortOrder" | |
| } | |
| }, | |
| "securityFilters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SecurityFilter" | |
| } | |
| }, | |
| "dispositionConditions": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/DispositionCondition" | |
| } | |
| }, | |
| "collectionBased": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "metadataType": { | |
| "type": "string", | |
| "enum": [ | |
| "DATE", | |
| "INTEGER", | |
| "DECIMAL", | |
| "STRING_VARIABLE" | |
| ] | |
| }, | |
| "validateReservedPrefix": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "PermissionClassificationDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The permission classification ID." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The permission classification name." | |
| } | |
| }, | |
| "description": "A grouping category for feature rights." | |
| }, | |
| "DropDownListDashboardPromptDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/DatasourceRequiredDashboardPromptDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DashboardInput." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The input name, must be unique per dashboard." | |
| }, | |
| "value": { | |
| "type": "object" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of input.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "DASHBOARD_PROMPT" | |
| ] | |
| }, | |
| "dashboardId": { | |
| "type": "string", | |
| "description": "The ID of the dashboard that owns this input." | |
| }, | |
| "dashboardName": { | |
| "type": "string", | |
| "description": "The name of the dashboard that owns this input." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The ID of the datasource used by this input." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "The name of the datasource used by this input." | |
| }, | |
| "datasourceResults": { | |
| "type": "array", | |
| "description": "The results from executing the datasource.", | |
| "items": { | |
| "$ref": "#/definitions/DataValue" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "responsibilityMapping": { | |
| "type": "array", | |
| "description": "The responsibility mapping for executing dependent inputs.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "dashboardInputDatasourceInputs": { | |
| "type": "array", | |
| "description": "The inputs needed for the datasource for this input.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardInputDatasourceInputDTO" | |
| } | |
| }, | |
| "label": { | |
| "type": "string", | |
| "description": "The prompt label." | |
| }, | |
| "promptType": { | |
| "type": "string", | |
| "description": "The prompt type.", | |
| "enum": [ | |
| "SWITCH", | |
| "DATE", | |
| "TEXT", | |
| "DROP_DOWN_LIST" | |
| ] | |
| }, | |
| "required": { | |
| "type": "boolean", | |
| "description": "Whether the input is required.", | |
| "default": false | |
| }, | |
| "defaultValueType": { | |
| "type": "string", | |
| "description": "The default value type.", | |
| "enum": [ | |
| "STATIC", | |
| "MACRO", | |
| "DATASOURCE", | |
| "FIRST", | |
| "SPECIFIC", | |
| "PROMPT" | |
| ] | |
| }, | |
| "isEditable": { | |
| "type": "boolean", | |
| "description": "Whether the list is editable.", | |
| "default": false | |
| }, | |
| "specificValue": { | |
| "type": "string", | |
| "description": "The specific default value, used when defaultValueType is SPECIFIC." | |
| }, | |
| "prompt": { | |
| "type": "string", | |
| "description": "The prompt value, used when defaultValueType is PROMPT." | |
| } | |
| }, | |
| "description": "A drop down list prompt." | |
| } | |
| ] | |
| }, | |
| "StaticStringDashboardInputDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/StaticDashboardInputDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DashboardInput." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The input name, must be unique per dashboard." | |
| }, | |
| "value": { | |
| "type": "object" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of input.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "DASHBOARD_PROMPT" | |
| ] | |
| }, | |
| "dashboardId": { | |
| "type": "string", | |
| "description": "The ID of the dashboard that owns this input." | |
| }, | |
| "dashboardName": { | |
| "type": "string", | |
| "description": "The name of the dashboard that owns this input." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The ID of the datasource used by this input." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "The name of the datasource used by this input." | |
| }, | |
| "datasourceResults": { | |
| "type": "array", | |
| "description": "The results from executing the datasource.", | |
| "items": { | |
| "$ref": "#/definitions/DataValue" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "responsibilityMapping": { | |
| "type": "array", | |
| "description": "The responsibility mapping for executing dependent inputs.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "dashboardInputDatasourceInputs": { | |
| "type": "array", | |
| "description": "The inputs needed for the datasource for this input.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardInputDatasourceInputDTO" | |
| } | |
| }, | |
| "staticType": { | |
| "type": "string", | |
| "description": "The type of static input.", | |
| "enum": [ | |
| "BOOLEAN", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "STRING" | |
| ] | |
| }, | |
| "stringValue": { | |
| "type": "string", | |
| "description": "The static string value." | |
| } | |
| }, | |
| "description": "A static hidden string input." | |
| } | |
| ] | |
| }, | |
| "ChartVariableDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The chart variable ID." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal of the variable." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the variable." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type of the variable.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "testValue": { | |
| "type": "string", | |
| "description": "A test value for the variable." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether the variable should be deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "A variable exposed as required input to a chart." | |
| }, | |
| "SearchSubSearchParameterDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the parameter associated with the search." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The indication as to whether or not to delete this parameter from the search.", | |
| "default": false | |
| }, | |
| "attributeId": { | |
| "type": "string", | |
| "description": "The ID of the attribute (data) associated with this parameter. If the data is non-metadata, then this ID will be NULL." | |
| }, | |
| "attributeName": { | |
| "type": "string", | |
| "description": "The name of the attribute (data) associated with this parameter." | |
| }, | |
| "metadataType": { | |
| "type": "string", | |
| "description": "The type of the metadata associated with this parameter. If the parameter is not associated to metadata, then this field will be NULL.", | |
| "enum": [ | |
| "DATE", | |
| "INTEGER", | |
| "DECIMAL", | |
| "STRING_VARIABLE" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal of this parameter with respect to other parameters in the search." | |
| }, | |
| "sortOrder": { | |
| "type": "string", | |
| "description": "The sort order associated with this parameter. NOTE: This value is no longer used because of SearchSortOrder.", | |
| "enum": [ | |
| "ASC", | |
| "DESC", | |
| "CUSTOM" | |
| ] | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of the parameter, indicating what needs to be associated to the parameter. Static static parameter will associate a static value with the parameter. A prompted parameter will require input from a user prompt. A custom parameter will require input from multiple sources to do a sub-select query from other tables to retrieve values to use in the search.", | |
| "enum": [ | |
| "PROMPTED", | |
| "STATIC", | |
| "MACRO", | |
| "CUSTOM" | |
| ] | |
| }, | |
| "attributeType": { | |
| "type": "string", | |
| "description": "The type of the attribute used by the parameter.", | |
| "enum": [ | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "FULL_TEXT", | |
| "DIARY", | |
| "METADATA", | |
| "OTHER", | |
| "STORED_PROC_PARAM", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES", | |
| "FILE_TYPE", | |
| "HIDDEN", | |
| "HIDDEN_DATE", | |
| "HIDDEN_INTEGER", | |
| "HIDDEN_DECIMAL" | |
| ] | |
| }, | |
| "comparatorType": { | |
| "type": "string", | |
| "description": "The comparator operator used in the execution and resolution of this parameter.", | |
| "enum": [ | |
| "EQUALS", | |
| "NOT_EQUALS", | |
| "GREATER_THAN", | |
| "LESS_THAN", | |
| "GREATER_THAN_EQUALS", | |
| "LESS_THAN_EQUALS", | |
| "CONTAINS", | |
| "NOT_CONTAINS", | |
| "IN" | |
| ] | |
| }, | |
| "connectiveType": { | |
| "type": "string", | |
| "description": "The connector that is used to connect this parameter and the parameter that occurs directly before this parameter when ordered by their parameter ordinal values within the search.", | |
| "enum": [ | |
| "AND", | |
| "OR" | |
| ] | |
| }, | |
| "dateValue": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "The date value of the parameter, when the parameter is a DATE data type. If the data type of the parameter is not a date, this value should be NULL." | |
| }, | |
| "decimalValue": { | |
| "type": "number", | |
| "format": "double", | |
| "description": "The decimal value of the parameter, when the parameter is a DECIMAL data type. If the data type of the parameter is not a decimal, this value should be NULL." | |
| }, | |
| "numericValue": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The numeric value of the parameter, when the parameter is a INTEGER data type. If the data type of the parameter is not a integer, this value should be NULL." | |
| }, | |
| "openingParen": { | |
| "type": "string", | |
| "description": "The representation of opening parenthesis that will begin groupings of parameters for execution purposes. If no parenthesis are associated with this parameter, then this value should be NULL." | |
| }, | |
| "closingParen": { | |
| "type": "string", | |
| "description": "The representation of closing parenthesis that will end groupings of parameters for execution purposes. If no parenthesis are associated with this parameter, then this value should be NULL." | |
| }, | |
| "searchPromptId": { | |
| "type": "string", | |
| "description": "The ID of the search prompt used in the execution of this parameter. This is the unique identifier of the search prompt to which this parameter is associated. If this parameter does not used a prompt, then this value should be NULL." | |
| }, | |
| "searchPromptName": { | |
| "type": "string", | |
| "description": "The name of the search prompt used in the execution of this parameter. This is the unique identifier (with a particular search) of the search prompt to which this parameter is associated. If this parameter does not used a prompt, then this value should be NULL." | |
| }, | |
| "strValue": { | |
| "type": "string", | |
| "description": "The string value of the parameter, when the parameter is a STRING data type. If the data type of the parameter is not a string, this value should be NULL." | |
| } | |
| }, | |
| "description": "The representation of the parameter objects associated with a subsearch." | |
| }, | |
| "Statement": { | |
| "type": "object", | |
| "properties": { | |
| "closed": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "maxFieldSize": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxRows": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "connection": { | |
| "$ref": "#/definitions/Connection" | |
| }, | |
| "queryTimeout": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "resultSet": { | |
| "$ref": "#/definitions/ResultSet" | |
| }, | |
| "updateCount": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "moreResults": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "fetchDirection": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "fetchSize": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "resultSetConcurrency": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "resultSetType": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "generatedKeys": { | |
| "$ref": "#/definitions/ResultSet" | |
| }, | |
| "resultSetHoldability": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "poolable": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "closeOnCompletion": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "largeUpdateCount": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "largeMaxRows": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "warnings": { | |
| "$ref": "#/definitions/SQLWarning" | |
| } | |
| } | |
| }, | |
| "Connection": { | |
| "type": "object", | |
| "properties": { | |
| "readOnly": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "autoCommit": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "transactionIsolation": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "catalog": { | |
| "type": "string" | |
| }, | |
| "closed": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "metaData": { | |
| "$ref": "#/definitions/DatabaseMetaData" | |
| }, | |
| "typeMap": { | |
| "type": "object" | |
| }, | |
| "holdability": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "clientInfo": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| }, | |
| "networkTimeout": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "warnings": { | |
| "$ref": "#/definitions/SQLWarning" | |
| } | |
| } | |
| }, | |
| "WindowSetting": { | |
| "type": "object", | |
| "required": [ | |
| "parentWindow", | |
| "showingMenuBar", | |
| "user", | |
| "windowGroup", | |
| "windowName", | |
| "windowPosition", | |
| "windowState" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/User" | |
| }, | |
| "windowName": { | |
| "type": "string" | |
| }, | |
| "parentWindow": { | |
| "type": "string" | |
| }, | |
| "windowGroup": { | |
| "type": "string" | |
| }, | |
| "windowPosition": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "showingMenuBar": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "x": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "y": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "cx": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "cy": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "percentX": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "percentY": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "percentCX": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "percentCY": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "width": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "height": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "scaleX": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "scaleY": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "windowState": { | |
| "type": "string", | |
| "enum": [ | |
| "MAXIMIZE", | |
| "MINIMIZE", | |
| "NORMAL" | |
| ] | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "OperationDTO": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "parameters": { | |
| "type": "array", | |
| "xml": { | |
| "name": "parameter" | |
| }, | |
| "items": { | |
| "$ref": "#/definitions/ParameterDTO" | |
| } | |
| }, | |
| "returnObjects": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ParameterDTO" | |
| } | |
| } | |
| } | |
| }, | |
| "SystemMessageUserPreference": { | |
| "type": "object", | |
| "required": [ | |
| "origin", | |
| "priority", | |
| "user" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/User" | |
| }, | |
| "origin": { | |
| "type": "string", | |
| "enum": [ | |
| "BPM_SERVER", | |
| "INDEXING_SERVER", | |
| "HSM_SERVER", | |
| "IMPORTER_SERVER", | |
| "EFORMS_SERVER", | |
| "REPOSITORIES_SERVER", | |
| "LICENSING_SERVER", | |
| "BPM", | |
| "INDEXING", | |
| "FORMS", | |
| "EDITING", | |
| "EXPORTER", | |
| "PRINTING", | |
| "FAXING", | |
| "RECORDS_MANAGEMENT", | |
| "SYSTEM_TRANSFER", | |
| "DASHBOARDS" | |
| ] | |
| }, | |
| "priority": { | |
| "type": "string", | |
| "enum": [ | |
| "ERROR", | |
| "WARNING", | |
| "INFO" | |
| ] | |
| }, | |
| "userId": { | |
| "type": "string" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "PagedCollectionFormMonitoringDTO": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/FormMonitoringDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "CheckOutJobResultDTO": { | |
| "type": "object", | |
| "properties": { | |
| "autoCompleteJob": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "successful": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "errorCode": { | |
| "type": "string" | |
| }, | |
| "errorMessage": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "MultipartBody": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "$ref": "#/definitions/MediaType" | |
| }, | |
| "allAttachments": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Attachment" | |
| } | |
| }, | |
| "childAttachments": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Attachment" | |
| } | |
| }, | |
| "rootAttachment": { | |
| "$ref": "#/definitions/Attachment" | |
| } | |
| } | |
| }, | |
| "DocumentHierarchyDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "INTERNAL", | |
| "STANDARD", | |
| "DELETED" | |
| ] | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "categoryId": { | |
| "type": "string" | |
| }, | |
| "categoryName": { | |
| "type": "string" | |
| }, | |
| "hasChildren": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "parentId": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "SearchSortOrderDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the sort order." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The indication as to whether or not to delete this sort order from the search.", | |
| "default": false | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal of this sort order with respect to other sort order in the search." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the sort order." | |
| }, | |
| "attributeType": { | |
| "type": "string", | |
| "description": "The type of the attributed used in the sort.", | |
| "enum": [ | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "FULL_TEXT", | |
| "DIARY", | |
| "METADATA", | |
| "OTHER", | |
| "STORED_PROC_PARAM", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES", | |
| "FILE_TYPE", | |
| "HIDDEN", | |
| "HIDDEN_DATE", | |
| "HIDDEN_INTEGER", | |
| "HIDDEN_DECIMAL" | |
| ] | |
| }, | |
| "attributeId": { | |
| "type": "string", | |
| "description": "The ID of the attribute used in the sort. This field is only applicable when the attribute is a metadata type. Any other attribute type will return a value of NULL for the ID." | |
| }, | |
| "attributeName": { | |
| "type": "string", | |
| "description": "The name of the attribute used in the sort. This field is only applicable when the attribute is a metadata type. Any other attribute type will return a value of NULL for the name." | |
| }, | |
| "attributeDataType": { | |
| "type": "string", | |
| "description": "The data type of the attribute used in the sort.", | |
| "enum": [ | |
| "DATE", | |
| "INTEGER", | |
| "DECIMAL", | |
| "STRING_VARIABLE" | |
| ] | |
| }, | |
| "orderType": { | |
| "type": "string", | |
| "description": "The order of the sort (ASC, DESC, or CUSTOM) for this sort order.", | |
| "enum": [ | |
| "ASC", | |
| "DESC", | |
| "CUSTOM" | |
| ] | |
| }, | |
| "customValues": { | |
| "type": "array", | |
| "description": "The array of custom values to use in the sort order, when ascending or descending order is not sufficient.", | |
| "items": { | |
| "$ref": "#/definitions/SearchSortOrderCustomDTO" | |
| } | |
| } | |
| }, | |
| "description": "The representation of the sorting to apply to the search results." | |
| }, | |
| "HotKeyDTO": { | |
| "type": "object", | |
| "properties": { | |
| "description": { | |
| "type": "string", | |
| "description": "Gets the description attribute of the HotKeyDTO object." | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "Gets the id attribute of the HotKeyDTO object." | |
| }, | |
| "keyCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Gets the keyCode attribute of the HotKeyDTO object." | |
| }, | |
| "keyGroup": { | |
| "type": "string", | |
| "description": "Gets the keyGroup attribute of the HotKeyDTO object.", | |
| "enum": [ | |
| "GENERAL", | |
| "INDEXING", | |
| "VIEWER", | |
| "DESIGNER", | |
| "BPM", | |
| "BPM_MONITORING", | |
| "SCANNING" | |
| ] | |
| }, | |
| "modifier": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Gets the modifier attribute of the HotKeyDTO object." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Gets the name attribute of the HotKeyDTO object." | |
| } | |
| }, | |
| "description": "A representation of the HotKey entity for use by the web service layer." | |
| }, | |
| "HsmActionDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the HSM action." | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of the HSM action." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal of the HSM action." | |
| }, | |
| "keyName": { | |
| "type": "string", | |
| "description": "The key name of the HSM action." | |
| }, | |
| "keyValue": { | |
| "type": "string", | |
| "description": "The key value of the HSM action." | |
| }, | |
| "label": { | |
| "type": "string", | |
| "description": "The label of the HSM action." | |
| }, | |
| "properties": { | |
| "type": "array", | |
| "description": "The properties associated with the HSM action.", | |
| "items": { | |
| "$ref": "#/definitions/HsmActionPropertyDTO" | |
| } | |
| } | |
| }, | |
| "description": "The action of HSM configuration." | |
| }, | |
| "GroupMemberAssociationDTO": { | |
| "type": "object", | |
| "properties": { | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The start index for paging." | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The max results for a page." | |
| }, | |
| "groupIds": { | |
| "type": "array", | |
| "description": "The group IDs.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "filters": { | |
| "description": "The filters.", | |
| "$ref": "#/definitions/Filters" | |
| }, | |
| "sorts": { | |
| "type": "array", | |
| "description": "Any sorts to apply.", | |
| "items": { | |
| "$ref": "#/definitions/Sort" | |
| } | |
| } | |
| }, | |
| "description": "An object representing a query for group members." | |
| }, | |
| "DrillDownDashboardDTO": { | |
| "type": "object", | |
| "properties": { | |
| "dashboardId": { | |
| "type": "string", | |
| "description": "The ID of the target dashboard." | |
| }, | |
| "dashboardName": { | |
| "type": "string", | |
| "description": "The name of the target dashboard." | |
| }, | |
| "isUserAssigned": { | |
| "type": "boolean", | |
| "description": "Whether the current user is assigned group access to the target dashboard.", | |
| "default": false | |
| }, | |
| "prompts": { | |
| "type": "array", | |
| "description": "The prompt values for the target dashboard.", | |
| "items": { | |
| "$ref": "#/definitions/KeyValuePair" | |
| } | |
| } | |
| }, | |
| "description": "An object containing the information needed to render a drill down to a dashboard." | |
| }, | |
| "Validator": { | |
| "type": "object", | |
| "required": [ | |
| "errorLevel", | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "errorLevel": { | |
| "type": "string", | |
| "enum": [ | |
| "ERROR", | |
| "WARNING" | |
| ] | |
| }, | |
| "properties": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ValidatorProperty" | |
| } | |
| }, | |
| "parameterNames": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "validatorType": { | |
| "type": "string" | |
| }, | |
| "validatorPluginDTO": { | |
| "$ref": "#/definitions/ValidatorPluginDTO" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "StaticBooleanDashboardInputDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/StaticDashboardInputDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DashboardInput." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The input name, must be unique per dashboard." | |
| }, | |
| "value": { | |
| "type": "object" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of input.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "DASHBOARD_PROMPT" | |
| ] | |
| }, | |
| "dashboardId": { | |
| "type": "string", | |
| "description": "The ID of the dashboard that owns this input." | |
| }, | |
| "dashboardName": { | |
| "type": "string", | |
| "description": "The name of the dashboard that owns this input." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The ID of the datasource used by this input." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "The name of the datasource used by this input." | |
| }, | |
| "datasourceResults": { | |
| "type": "array", | |
| "description": "The results from executing the datasource.", | |
| "items": { | |
| "$ref": "#/definitions/DataValue" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "responsibilityMapping": { | |
| "type": "array", | |
| "description": "The responsibility mapping for executing dependent inputs.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "dashboardInputDatasourceInputs": { | |
| "type": "array", | |
| "description": "The inputs needed for the datasource for this input.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardInputDatasourceInputDTO" | |
| } | |
| }, | |
| "staticType": { | |
| "type": "string", | |
| "description": "The type of static input.", | |
| "enum": [ | |
| "BOOLEAN", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "STRING" | |
| ] | |
| }, | |
| "booleanValue": { | |
| "type": "boolean", | |
| "description": "The static boolean value.", | |
| "default": false | |
| } | |
| }, | |
| "description": "A static hidden boolean input." | |
| } | |
| ] | |
| }, | |
| "DataValue": { | |
| "type": "object", | |
| "properties": { | |
| "value": { | |
| "type": "object", | |
| "description": "The value of the data value." | |
| }, | |
| "key": { | |
| "type": "string", | |
| "description": "The key of the data value." | |
| }, | |
| "comparableValue": { | |
| "$ref": "#/definitions/ComparableObject" | |
| } | |
| }, | |
| "description": "Data value used to represent a generic key value pair." | |
| }, | |
| "SubSearchResultsDTO": { | |
| "type": "object", | |
| "properties": { | |
| "items": { | |
| "type": "array", | |
| "description": "The collection of items.", | |
| "items": { | |
| "$ref": "#/definitions/SearchResultRowDTO" | |
| } | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "The group name." | |
| }, | |
| "results": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "required": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| }, | |
| "description": "A generic object that holds a collection of grouped items to be returned via JSON. Generally used when retrieving items in conjunction with a Kendo DataSource grouped by a String name." | |
| }, | |
| "QueueGroupDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id for the ViewQueueGroup object." | |
| }, | |
| "viewId": { | |
| "type": "string", | |
| "description": "The view id for the ViewQueueGroup object." | |
| }, | |
| "groupName": { | |
| "type": "string", | |
| "description": "The group name for the ViewQueueGroup object." | |
| } | |
| }, | |
| "description": "Configuration data for job view filter based on groups." | |
| }, | |
| "ResultSetMetaData": { | |
| "type": "object", | |
| "properties": { | |
| "columnCount": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "RetentionPolicyCustodian": { | |
| "type": "object", | |
| "required": [ | |
| "retentionPolicy", | |
| "user" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "retentionPolicy": { | |
| "$ref": "#/definitions/RetentionPolicy" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/User" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": 0 | |
| }, | |
| "delete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "create": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "ViewDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the view configuration data." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the view configuration data." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description of the view configuration data." | |
| }, | |
| "processModelType": { | |
| "type": "string", | |
| "description": "The process model type associated with the view.", | |
| "enum": [ | |
| "ALL", | |
| "EXPLICIT" | |
| ] | |
| }, | |
| "processModelNameDtos": { | |
| "type": "array", | |
| "description": "The process model names associated with the view configuration data.", | |
| "items": { | |
| "$ref": "#/definitions/ProcessModelNameDTO" | |
| } | |
| }, | |
| "queueGroupType": { | |
| "type": "string", | |
| "description": "The queue group type associated with the view.", | |
| "enum": [ | |
| "ALL", | |
| "MEMBER", | |
| "EXPLICIT" | |
| ] | |
| }, | |
| "queueGroups": { | |
| "type": "array", | |
| "description": "The view queue groups associated with the view.", | |
| "items": { | |
| "$ref": "#/definitions/QueueGroupDTO" | |
| } | |
| }, | |
| "queueType": { | |
| "type": "string", | |
| "description": "The queue type the view configuration data.", | |
| "enum": [ | |
| "PERSONAL", | |
| "COMMON" | |
| ] | |
| }, | |
| "jobFilters": { | |
| "type": "array", | |
| "description": "The job filters associated the view configuration data.", | |
| "items": { | |
| "$ref": "#/definitions/JobFilterDTO" | |
| } | |
| }, | |
| "releasable": { | |
| "type": "boolean", | |
| "description": "Whether the view is releasable or not.", | |
| "default": false | |
| }, | |
| "spoonFeed": { | |
| "type": "boolean", | |
| "description": "Whether the view is spoonfed or not.", | |
| "default": false | |
| }, | |
| "viewColumns": { | |
| "type": "array", | |
| "description": "The view columns associated with the view.", | |
| "items": { | |
| "$ref": "#/definitions/ViewColumnDTO" | |
| } | |
| }, | |
| "sortColumns": { | |
| "type": "array", | |
| "description": "The sort columns associated with the view.", | |
| "items": { | |
| "$ref": "#/definitions/SortColumnDTO" | |
| } | |
| }, | |
| "viewPrompts": { | |
| "type": "array", | |
| "description": "The prompts associated with the view.", | |
| "items": { | |
| "$ref": "#/definitions/ViewPromptDTO" | |
| } | |
| }, | |
| "readOnly": { | |
| "type": "boolean", | |
| "description": "Flag to indicate if view is read only.", | |
| "default": false | |
| }, | |
| "viewUserType": { | |
| "type": "string", | |
| "description": "The view user type associated with the view.", | |
| "enum": [ | |
| "ALL", | |
| "CURRENT_USER", | |
| "EXPLICIT_GROUPS" | |
| ] | |
| }, | |
| "viewUserGroupNames": { | |
| "type": "array", | |
| "description": "The view user group names associated with the view.", | |
| "items": { | |
| "$ref": "#/definitions/ViewUserGroupNameDTO" | |
| } | |
| } | |
| }, | |
| "description": "View data used to configure job views for the system." | |
| }, | |
| "ShiftDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "Gets the id attribute of the ShiftDTO object." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Gets the name attribute of the ShiftDTO object." | |
| }, | |
| "shiftParts": { | |
| "type": "array", | |
| "description": "Gets the shiftParts attribute of the ShiftDTO object.", | |
| "items": { | |
| "$ref": "#/definitions/ShiftPartDTO" | |
| } | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "Gets the description attribute of the ShiftDTO object." | |
| }, | |
| "shiftMembers": { | |
| "type": "array", | |
| "description": "Gets the shiftMembers attribute of the ShiftDTO object.", | |
| "items": { | |
| "$ref": "#/definitions/ShiftMemberDTO" | |
| } | |
| } | |
| }, | |
| "description": "The DTO object for a Shift." | |
| }, | |
| "Search": { | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "searchType" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "searchType": { | |
| "type": "string", | |
| "enum": [ | |
| "TEMPLATE", | |
| "CATEGORY", | |
| "CHECKLIST", | |
| "STORED_PROCEDURE", | |
| "HSM" | |
| ] | |
| }, | |
| "formDesignName": { | |
| "type": "string" | |
| }, | |
| "formEditable": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "searchDocIndexing": { | |
| "$ref": "#/definitions/SearchDocIndexing" | |
| }, | |
| "searchStoredProcedure": { | |
| "$ref": "#/definitions/SearchStoredProcedure" | |
| }, | |
| "searchGroups": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchGroup" | |
| } | |
| }, | |
| "searchParameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchParameter" | |
| } | |
| }, | |
| "searchSubSearches": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchChecklistSubSearch" | |
| } | |
| }, | |
| "searchPrompts": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchPrompt" | |
| } | |
| }, | |
| "searchResultColumns": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchResultColumn" | |
| } | |
| }, | |
| "searchSortOrders": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchSortOrder" | |
| } | |
| }, | |
| "searchFormData": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/SearchFormData" | |
| } | |
| }, | |
| "searchTreeFilter": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchTreeFilter" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "documentsExist": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "allCategories": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Category" | |
| } | |
| }, | |
| "allDocumentTypeIds": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "allDocumentTypes": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DocumentType" | |
| } | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "FormAction": { | |
| "type": "object", | |
| "required": [ | |
| "event", | |
| "ordinal", | |
| "type" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "condition": { | |
| "type": "string" | |
| }, | |
| "event": { | |
| "type": "string" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "properties": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormActionProperty" | |
| } | |
| }, | |
| "formControlStep": { | |
| "$ref": "#/definitions/FormControlStep" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "LegalHold": { | |
| "type": "object", | |
| "required": [ | |
| "dateCreated", | |
| "document", | |
| "legalHoldCase", | |
| "user" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "document": { | |
| "$ref": "#/definitions/Document" | |
| }, | |
| "legalHoldCase": { | |
| "$ref": "#/definitions/LegalHoldCase" | |
| }, | |
| "dateCreated": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "user": { | |
| "$ref": "#/definitions/User" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "DatasourceIntentDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the datasource intent." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The datasource id of the datasource intent." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "The datasource name of the datasource intent." | |
| }, | |
| "intent": { | |
| "type": "string", | |
| "description": "The datasource intent type.", | |
| "enum": [ | |
| "COMPLEX_TABLE", | |
| "SIMPLE" | |
| ] | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "The deleted flag of the datasource intent.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The intent of a data source." | |
| }, | |
| "ViewColumnDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "View column id information." | |
| }, | |
| "columnVariable": { | |
| "type": "string", | |
| "description": "View column variable information." | |
| }, | |
| "columnDisplayValue": { | |
| "type": "string", | |
| "description": "View column display value information." | |
| }, | |
| "columnDataType": { | |
| "type": "string", | |
| "description": "View column data type information.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "columnType": { | |
| "type": "string", | |
| "description": "View column type information.", | |
| "enum": [ | |
| "JOB_PROPERTY", | |
| "PROCESS_INSTANCE_VARIABLE", | |
| "PACKAGE_ITEM_PROPERTY" | |
| ] | |
| }, | |
| "columnTypeProperty": { | |
| "type": "string", | |
| "description": "View column type property information." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "View column ordinal information." | |
| } | |
| }, | |
| "description": "View column configuration data" | |
| }, | |
| "TableChartDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/ChartableDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "INTERNAL", | |
| "STANDARD" | |
| ] | |
| }, | |
| "isLocked": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "lockOwner": { | |
| "type": "string" | |
| }, | |
| "lockOwnerFirstName": { | |
| "type": "string" | |
| }, | |
| "lockOwnerLastName": { | |
| "type": "string" | |
| }, | |
| "dateModified": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "properties": { | |
| "$ref": "#/definitions/ChartablePropertiesDTO" | |
| }, | |
| "datasourceId": { | |
| "type": "string" | |
| }, | |
| "datasourceName": { | |
| "type": "string" | |
| }, | |
| "datasourceParameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DatasourceArgumentDTO" | |
| } | |
| }, | |
| "refreshInterval": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "isValid": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "variables": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartVariableDTO" | |
| } | |
| }, | |
| "datasourceInputs": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartDatasourceInputDTO" | |
| } | |
| }, | |
| "dashboardCount": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "overrideErrorsOnSave": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "columns": { | |
| "type": "array", | |
| "description": "The table columns.", | |
| "items": { | |
| "$ref": "#/definitions/TableChartColumnDTO" | |
| } | |
| }, | |
| "sortColumns": { | |
| "type": "array", | |
| "description": "The sortable columns.", | |
| "items": { | |
| "$ref": "#/definitions/TableChartColumnDTO" | |
| } | |
| } | |
| }, | |
| "description": "A table chart." | |
| } | |
| ] | |
| }, | |
| "DashboardChartableInputDTO": { | |
| "type": "object", | |
| "required": [ | |
| "chartVariableId" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DashboardChartableInput." | |
| }, | |
| "dashboardChartableId": { | |
| "type": "string", | |
| "description": "The ID of the DashboardChartable that owns this input." | |
| }, | |
| "chartVariableId": { | |
| "type": "string", | |
| "description": "The ID of the ChartVariable used in the mapping." | |
| }, | |
| "chartVariableName": { | |
| "type": "string", | |
| "description": "The name of the ChartVariable used in the mapping." | |
| }, | |
| "dashboardInputId": { | |
| "type": "string", | |
| "description": "The ID of the DashboardInput used in the input mapping. If null, we will check dashboardInputName." | |
| }, | |
| "dashboardInputName": { | |
| "type": "string", | |
| "description": "The name of the DashboardInput used in the mapping." | |
| } | |
| }, | |
| "description": "An input to a chart on a dashboard." | |
| }, | |
| "DocumentTypeMetadata": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "documentType": { | |
| "$ref": "#/definitions/DocumentType" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Metadata" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "required": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "oldRequiredValue": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "editable": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "oldEditableValue": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "isDefault": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "documentTypeMetadataDatasource": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeMetadataDatasource" | |
| } | |
| }, | |
| "documentTypeMetadataDependentDependee": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeMetadataDependent" | |
| } | |
| }, | |
| "documentTypeMetadataDependentDependor": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeMetadataDependent" | |
| } | |
| }, | |
| "documentTypeMetadataIndexings": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeMetadataIndexing" | |
| } | |
| }, | |
| "documentTypeMetadataValidators": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeMetadataValidator" | |
| } | |
| }, | |
| "documentTypeChecklistIndexing": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeMetadataChecklist" | |
| } | |
| }, | |
| "userViewerSettings": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/UserViewerSetting" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "SeriesColorDTO": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "description": "The series name." | |
| }, | |
| "color": { | |
| "type": "string", | |
| "description": "The series color." | |
| } | |
| }, | |
| "description": "A series color for a chart." | |
| }, | |
| "DatabaseMetaData": { | |
| "type": "object", | |
| "properties": { | |
| "url": { | |
| "type": "string" | |
| }, | |
| "readOnly": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "maxConnections": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "driverName": { | |
| "type": "string" | |
| }, | |
| "userName": { | |
| "type": "string" | |
| }, | |
| "connection": { | |
| "$ref": "#/definitions/Connection" | |
| }, | |
| "resultSetHoldability": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "databaseProductName": { | |
| "type": "string" | |
| }, | |
| "databaseProductVersion": { | |
| "type": "string" | |
| }, | |
| "driverVersion": { | |
| "type": "string" | |
| }, | |
| "driverMajorVersion": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "driverMinorVersion": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "identifierQuoteString": { | |
| "type": "string" | |
| }, | |
| "sqlkeywords": { | |
| "type": "string" | |
| }, | |
| "numericFunctions": { | |
| "type": "string" | |
| }, | |
| "stringFunctions": { | |
| "type": "string" | |
| }, | |
| "systemFunctions": { | |
| "type": "string" | |
| }, | |
| "timeDateFunctions": { | |
| "type": "string" | |
| }, | |
| "searchStringEscape": { | |
| "type": "string" | |
| }, | |
| "extraNameCharacters": { | |
| "type": "string" | |
| }, | |
| "schemaTerm": { | |
| "type": "string" | |
| }, | |
| "procedureTerm": { | |
| "type": "string" | |
| }, | |
| "catalogTerm": { | |
| "type": "string" | |
| }, | |
| "catalogAtStart": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "catalogSeparator": { | |
| "type": "string" | |
| }, | |
| "maxBinaryLiteralLength": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxCharLiteralLength": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxColumnNameLength": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxColumnsInGroupBy": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxColumnsInIndex": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxColumnsInOrderBy": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxColumnsInSelect": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxColumnsInTable": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxCursorNameLength": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxIndexLength": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxSchemaNameLength": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxProcedureNameLength": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxCatalogNameLength": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxRowSize": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxStatementLength": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxStatements": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxTableNameLength": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxTablesInSelect": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "maxUserNameLength": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "schemas": { | |
| "$ref": "#/definitions/ResultSet" | |
| }, | |
| "catalogs": { | |
| "$ref": "#/definitions/ResultSet" | |
| }, | |
| "tableTypes": { | |
| "$ref": "#/definitions/ResultSet" | |
| }, | |
| "typeInfo": { | |
| "$ref": "#/definitions/ResultSet" | |
| }, | |
| "databaseMajorVersion": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "databaseMinorVersion": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "jdbcmajorVersion": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "jdbcminorVersion": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "sqlstateType": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "rowIdLifetime": { | |
| "type": "string", | |
| "enum": [ | |
| "ROWID_UNSUPPORTED", | |
| "ROWID_VALID_OTHER", | |
| "ROWID_VALID_SESSION", | |
| "ROWID_VALID_TRANSACTION", | |
| "ROWID_VALID_FOREVER" | |
| ] | |
| }, | |
| "clientInfoProperties": { | |
| "$ref": "#/definitions/ResultSet" | |
| }, | |
| "maxLogicalLobSize": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "defaultTransactionIsolation": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "RuleSetAssignmentDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the rule set assignment." | |
| }, | |
| "metadataId": { | |
| "type": "string", | |
| "description": "The metadata id to be assigned a value." | |
| }, | |
| "metadataName": { | |
| "type": "string", | |
| "description": "The metadata name that must be assigned a value during the import process." | |
| }, | |
| "assignment": { | |
| "type": "string", | |
| "description": "The value to assign to the metadata - either a macro, variable reference or static value." | |
| }, | |
| "assignmentType": { | |
| "type": "string", | |
| "description": "The type of value for the assignment.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "VARIABLE", | |
| "MIXED" | |
| ] | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type of the metadata object used in the assignment (read-only)." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Ordinal of the rule set assignment object." | |
| }, | |
| "ruleSetId": { | |
| "type": "string", | |
| "description": "The rule set id associated with the rule set assignment object." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Flag indicating the rule set assignment object is to be deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "Configuration data for assignments to be made during the import process." | |
| }, | |
| "ActorDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the actor (not a User ID)." | |
| }, | |
| "roleId": { | |
| "type": "string", | |
| "description": "The ID of the role that holds this Actor." | |
| }, | |
| "actor": { | |
| "type": "string", | |
| "description": "The user name of the actor (not the User ID)." | |
| }, | |
| "firstName": { | |
| "type": "string", | |
| "description": "The first name of the actor." | |
| }, | |
| "lastName": { | |
| "type": "string", | |
| "description": "The last name of the actor." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal of the actor in the role, controls distribution order." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this actor should be deleted from this role.", | |
| "default": false | |
| } | |
| }, | |
| "description": "A user who is assigned to a specific order in a role." | |
| }, | |
| "VariableDTO": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the value to send in." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type of the value to send in.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DAY", | |
| "NUMBER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "NUMBER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "stringValue": { | |
| "type": "string", | |
| "description": "The string value to send in." | |
| }, | |
| "dateValue": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "The date value to send in." | |
| }, | |
| "numericValue": { | |
| "type": "number", | |
| "format": "double", | |
| "description": "The numeric value to send in." | |
| }, | |
| "booleanValue": { | |
| "type": "boolean", | |
| "description": "The boolean value to send in.", | |
| "default": false | |
| }, | |
| "stringArrayValue": { | |
| "type": "array", | |
| "description": "The string value array to send in.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "dateArrayValue": { | |
| "type": "array", | |
| "description": "The date value array to send in.", | |
| "items": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "numericArrayValue": { | |
| "type": "array", | |
| "description": "The double value array to send in.", | |
| "items": { | |
| "type": "number", | |
| "format": "double" | |
| } | |
| }, | |
| "booleanArrayValue": { | |
| "type": "array", | |
| "description": "The boolean value array to send in.", | |
| "items": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "momentInTime": { | |
| "type": "boolean", | |
| "description": "Flag if data type is DATE and is a moment in time. Note that this field defaults to true for any data type.", | |
| "default": false | |
| }, | |
| "value": { | |
| "type": "object" | |
| } | |
| }, | |
| "description": "Configuration informaton to send a value through webservices." | |
| }, | |
| "SearchResultLinkedMetadata": { | |
| "type": "object", | |
| "required": [ | |
| "columnName", | |
| "datasource", | |
| "searchResultMetadata" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "searchResultMetadata": { | |
| "$ref": "#/definitions/SearchResultColumn" | |
| }, | |
| "datasource": { | |
| "$ref": "#/definitions/Datasource" | |
| }, | |
| "columnName": { | |
| "type": "string" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "SearchPromptDatasourceParam": { | |
| "type": "object", | |
| "required": [ | |
| "searchPromptDatasource" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "searchPromptDatasource": { | |
| "$ref": "#/definitions/SearchPromptDatasource" | |
| }, | |
| "datasourceParameterName": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "NONE", | |
| "STATIC", | |
| "MACRO", | |
| "PROMPT" | |
| ] | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "UserSettingDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "settingName": { | |
| "type": "string" | |
| }, | |
| "settingValue": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "DatasourceTestingDTO": { | |
| "type": "object", | |
| "properties": { | |
| "datasourceDto": { | |
| "description": "Representation of the datasource.", | |
| "$ref": "#/definitions/DatasourceDTO" | |
| }, | |
| "parameters": { | |
| "type": "array", | |
| "description": "Array of parameters to use during testing.", | |
| "items": { | |
| "$ref": "#/definitions/DatasourceArgumentDTO" | |
| } | |
| } | |
| }, | |
| "description": "An object representing a datasource and data to test." | |
| }, | |
| "BatchDTO": { | |
| "type": "object", | |
| "properties": { | |
| "batchGroupNames": { | |
| "type": "array", | |
| "description": "The names of all groups assigned access to this batch. Read-only.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "batchGroupIds": { | |
| "type": "array", | |
| "description": "The IDs of the groups who have access to this batch. You must specify one ore more group IDs when creating a new batch.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "checkedInDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "The date/time that this batch was last checked in." | |
| }, | |
| "checkedOut": { | |
| "type": "boolean", | |
| "description": "Whether this batch is currently checked out.", | |
| "default": false | |
| }, | |
| "checkedOutBy": { | |
| "type": "string", | |
| "description": "The username of the user who has this batch checked out." | |
| }, | |
| "checkedOutByFirstName": { | |
| "type": "string", | |
| "description": "The first name of the user who has this batch checked out." | |
| }, | |
| "checkedOutByLastName": { | |
| "type": "string", | |
| "description": "The last name of the user who has this batch checked out." | |
| }, | |
| "checkedOutDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "The date/time that this batch was checked out." | |
| }, | |
| "createdBy": { | |
| "type": "string", | |
| "description": "The username of the user who created this batch." | |
| }, | |
| "createdOn": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "The date/time that this batch was created." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description of the batch." | |
| }, | |
| "documentCount": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "The number of documents in the batch." | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the batch." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the batch. When creating batches, you can omit this field to have the name generated automatically." | |
| }, | |
| "nameUserDefined": { | |
| "type": "string", | |
| "description": "When automatically generating names, this field represents the user defined text portion of the batch name." | |
| }, | |
| "documentIds": { | |
| "type": "array", | |
| "description": "The IDs of unindexed documents to add to this batch.", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "description": "A batch of documents." | |
| }, | |
| "SearchSortOrderCustomDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the custom search sort order associated with the search." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The indication as to whether or not to delete this custom sort order from the search.", | |
| "default": false | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "The value of this custom sort in the search." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal of this custom sort order with respect to other custom sort orders in the search." | |
| }, | |
| "metadataType": { | |
| "type": "string", | |
| "description": "The type of the metadata associated with this sort order. If the sort order is not associated to metadata, then this field will be NULL.", | |
| "enum": [ | |
| "DATE", | |
| "INTEGER", | |
| "DECIMAL", | |
| "STRING_VARIABLE" | |
| ] | |
| }, | |
| "dateValue": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "The date value of the sort order, when the sort order is a DATE data type. If the data type of the sort order is not a date, this value should be NULL." | |
| }, | |
| "decimalValue": { | |
| "type": "number", | |
| "format": "double", | |
| "description": "The decimal value of the sort order, when the sort order is a DECIMAL data type. If the data type of the sort order is not a decimal, this value should be NULL." | |
| }, | |
| "numericValue": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The numeric value of the sort order, when the sort order is an INTEGER data type. If the data type of the sort order is not an integer, this value should be NULL." | |
| }, | |
| "strValue": { | |
| "type": "string", | |
| "description": "The string value of the sort order, when the sort order is a STRING data type. If the data type of the sort order is not a string, this value should be NULL." | |
| } | |
| }, | |
| "description": "The representation of the custom search sort order when ascending or descending order is not sufficient." | |
| }, | |
| "AreaChartDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/ChartDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "INTERNAL", | |
| "STANDARD" | |
| ] | |
| }, | |
| "isLocked": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "lockOwner": { | |
| "type": "string" | |
| }, | |
| "lockOwnerFirstName": { | |
| "type": "string" | |
| }, | |
| "lockOwnerLastName": { | |
| "type": "string" | |
| }, | |
| "dateModified": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "properties": { | |
| "$ref": "#/definitions/ChartablePropertiesDTO" | |
| }, | |
| "datasourceId": { | |
| "type": "string" | |
| }, | |
| "datasourceName": { | |
| "type": "string" | |
| }, | |
| "datasourceParameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DatasourceArgumentDTO" | |
| } | |
| }, | |
| "refreshInterval": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "isValid": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "variables": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartVariableDTO" | |
| } | |
| }, | |
| "datasourceInputs": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartDatasourceInputDTO" | |
| } | |
| }, | |
| "dashboardCount": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "overrideErrorsOnSave": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "chartType": { | |
| "type": "string", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "labelColumn": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| }, | |
| "seriesColumn": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| }, | |
| "dataColumns": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| } | |
| } | |
| }, | |
| "description": "An area chart." | |
| } | |
| ] | |
| }, | |
| "ExporterProfileDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "xml": { | |
| "name": "result" | |
| }, | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/ExporterProfileDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "AuditingTypeDTO": { | |
| "type": "object", | |
| "required": [ | |
| "auditCategoryType", | |
| "auditType", | |
| "description", | |
| "enabled", | |
| "includedInDocInfo", | |
| "includedInRecordInfo" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the auditing configuration data." | |
| }, | |
| "auditCategoryType": { | |
| "type": "string", | |
| "description": "The auditing category, used for organizational purposes.", | |
| "enum": [ | |
| "ADMINISTRATION", | |
| "ALERTS", | |
| "AUTHENTICATION", | |
| "BATCH_ACTIONS", | |
| "BPM_ACTIONS", | |
| "DASHBOARDS", | |
| "DOCUMENT_ACTIONS", | |
| "DOCUMENT_CHANGES", | |
| "DOCUMENT_VIEWING", | |
| "EMAIL", | |
| "EXPORT", | |
| "EFORMS", | |
| "HSM", | |
| "LICENSE", | |
| "RECORDS_MANAGEMENT", | |
| "SEARCH_ACTIONS", | |
| "SECURITY_CHANGE" | |
| ] | |
| }, | |
| "auditType": { | |
| "type": "string", | |
| "description": "The auditing event type, recorded in the AuditMessages table as the audit.", | |
| "enum": [ | |
| "AUTHENTICATE_SUCCESS", | |
| "AUTHENTICATE_FAIL", | |
| "AUTHENTICATE_EXPIRE", | |
| "BATCH_COMMIT", | |
| "BATCH_CREATE", | |
| "BATCH_UPDATE", | |
| "BATCH_DELETE", | |
| "BATCH_CHECK_IN", | |
| "BATCH_CHECK_OUT", | |
| "BATCH_DOCUMENT_CREATE", | |
| "BATCH_DOCUMENT_DELETE", | |
| "BATCH_GROUP_ACCESS_CREATE", | |
| "BATCH_GROUP_ACCESS_DELETE", | |
| "BPM_ABSENCE_CREATE", | |
| "BPM_ABSENCE_DELETE", | |
| "BPM_BUSINESS_HOURS_CREATE", | |
| "BPM_BUSINESS_HOURS_UPDATE", | |
| "BPM_BUSINESS_HOURS_DELETE", | |
| "BPM_DOCUMENT_TYPE_PROCESS_MODEL_CREATE", | |
| "BPM_DOCUMENT_TYPE_PROCESS_MODEL_UPDATE", | |
| "BPM_DOCUMENT_TYPE_PROCESS_MODEL_DELETE", | |
| "BPM_HOLIDAY_CREATE", | |
| "BPM_HOLIDAY_UPDATE", | |
| "BPM_HOLIDAY_DELETE", | |
| "BPM_JOB_CREATE", | |
| "BPM_JOB_READ", | |
| "BPM_JOB_UPDATE", | |
| "BPM_JOB_DELETE", | |
| "BPM_JOB_CHECK_OUT", | |
| "BPM_JOB_RELEASE", | |
| "BPM_JOB_RETURN", | |
| "BPM_JOB_REDISTRIBUTE", | |
| "BPM_JOB_MOVE", | |
| "BPM_JOB_SET_DUE_DATE", | |
| "BPM_JOB_COMPLETE", | |
| "BPM_JOB_DISTRIBUTE", | |
| "BPM_JOB_ACTOR_UPDATE", | |
| "BPM_LIBRARY_ENTITY_CREATE", | |
| "BPM_LIBRARY_ENTITY_DELETE", | |
| "BPM_SUBPROCESS_CREATE", | |
| "BPM_PROCESS_CREATE", | |
| "BPM_PROCESS_DELETE", | |
| "BPM_PROCESS_CLEAN", | |
| "BPM_PROCESS_START", | |
| "BPM_PROCESS_ADD_PACKAGE_ITEM", | |
| "BPM_PROCESS_END", | |
| "BPM_PROCESS_STEP_FORWARD", | |
| "BPM_COMPLETE_NODE", | |
| "BPM_PROCESS_MIGRATE", | |
| "BPM_PROCESS_MODEL_UPDATE", | |
| "BPM_PROCESS_MODEL_DELETE", | |
| "BPM_PROCESS_MODEL_EXPORT", | |
| "BPM_PROCESS_MODEL_IMPORT", | |
| "BPM_PROCESS_MODEL_ACTIVATE", | |
| "BPM_PROCESS_MODEL_DEACTIVATE", | |
| "BPM_PROCESS_MODEL_CHECK_IN", | |
| "BPM_PROCESS_MODEL_CHECK_OUT", | |
| "BPM_PROCESS_MODEL_UNLOCK", | |
| "BPM_PROCESS_MODEL_GROUP_ADD", | |
| "BPM_PROCESS_MODEL_GROUP_DELETE", | |
| "BPM_NODE_ENTER", | |
| "BPM_NODE_LEAVE", | |
| "BPM_QUEUE_MOVE_TO_PERSONAL", | |
| "BPM_ROLE_CREATE", | |
| "BPM_ROLE_UPDATE", | |
| "BPM_ROLE_DELETE", | |
| "BPM_SHIFT_CREATE", | |
| "BPM_SHIFT_UPDATE", | |
| "BPM_SHIFT_DELETE", | |
| "BPM_TASK_COMPLETE", | |
| "BPM_TASK_INCOMPLETE", | |
| "BPM_SERVICE_TASK_COMPLETE", | |
| "BPM_SERVICE_TASK_FAILED", | |
| "BPM_VIEW_CREATE", | |
| "BPM_VIEW_UPDATE", | |
| "BPM_VIEW_DELETE", | |
| "CALCULATED_PROPERTY_CREATE", | |
| "CALCULATED_PROPERTY_UPDATE", | |
| "CALCULATED_PROPERTY_DELETE", | |
| "CALCULATED_PROPERTY_DATASOURCE_PARAMETER_CREATE", | |
| "CALCULATED_PROPERTY_DATASOURCE_PARAMETER_UPDATE", | |
| "CALCULATED_PROPERTY_DATASOURCE_PARAMETER_DELETE", | |
| "CHART_CREATE", | |
| "CHART_UPDATE", | |
| "CHART_DELETE", | |
| "CHART_OVERWRITE", | |
| "CHART_IMPORT", | |
| "CHART_EXPORT", | |
| "CHART_DATA_GRID_CREATE", | |
| "CHART_DATA_GRID_UPDATE", | |
| "CHART_DATA_GRID_DELETE", | |
| "CHART_TEXT_CREATE", | |
| "CHART_TEXT_UPDATE", | |
| "CHART_TEXT_DELETE", | |
| "CHECKLIST_UPDATE", | |
| "CHECKLIST_DELETE", | |
| "CHECKLIST_DYNAMIC_SUBSEARCH_CREATE", | |
| "CHECKLIST_DYNAMIC_SUBSEARCH_DELETE", | |
| "CHECKLIST_DYNAMIC_SUBSEARCH_UPDATE", | |
| "CHECKLIST_SUBSEARCH_CREATE", | |
| "CHECKLIST_SUBSEARCH_DELETE", | |
| "CHECKLIST_SUBSEARCH_UPDATE", | |
| "CHECKLIST_DYNAMIC_PARAMETER_CREATE", | |
| "CHECKLIST_DYNAMIC_PARAMETER_DELETE", | |
| "CHECKLIST_DYNAMIC_PARAMETER_UPDATE", | |
| "CHECKLIST_SUBSEARCH_PARAMETER_CREATE", | |
| "CHECKLIST_SUBSEARCH_PARAMETER_DELETE", | |
| "CHECKLIST_SUBSEARCH_PARAMETER_UPDATE", | |
| "SEARCH_DOC_INDEXING_CREATE", | |
| "SEARCH_DOC_INDEXING_DELETE", | |
| "SEARCH_DOC_INDEXING_UPDATE", | |
| "SEARCH_DOC_INDEXING_METADATA_CREATE", | |
| "SEARCH_DOC_INDEXING_METADATA_DELETE", | |
| "SEARCH_DOC_INDEXING_METADATA_UPDATE", | |
| "DASHBOARD_CATEGORY_CREATE", | |
| "DASHBOARD_CATEGORY_UPDATE", | |
| "DASHBOARD_CATEGORY_DELETE", | |
| "DASHBOARD_CREATE", | |
| "DASHBOARD_DELETE", | |
| "DASHBOARD_UPDATE", | |
| "DASHBOARD_OVERWRITE", | |
| "DASHBOARD_CHECK_IN", | |
| "DASHBOARD_CHECK_OUT", | |
| "CHART_CHECK_IN", | |
| "CHART_CHECK_OUT", | |
| "DASHBOARD_GROUP_ADD", | |
| "DASHBOARD_GROUP_DELETE", | |
| "DASHBOARD_IMPORT", | |
| "DASHBOARD_EXPORT", | |
| "DATA_STORE_CREATE", | |
| "DATA_STORE_UPDATE", | |
| "DATA_STORE_DELETE", | |
| "DATABASE_CONNECTION_CREATE", | |
| "DATABASE_CONNECTION_UPDATE", | |
| "DATABASE_CONNECTION_DELETE", | |
| "DATASOURCE_CREATE", | |
| "DATASOURCE_UPDATE", | |
| "DATASOURCE_DELETE", | |
| "DIARY_ENTRY_CREATE", | |
| "DOCUMENT_UPDATE", | |
| "DOCUMENT_UPLOAD", | |
| "DOCUMENT_CREATE", | |
| "DOCUMENT_CREATE_PRINT_TO", | |
| "DOCUMENT_CREATE_SEND_TO", | |
| "DOCUMENT_CREATE_SCAN_TO", | |
| "DOCUMENT_CREATE_IMPORT", | |
| "DOCUMENT_CREATE_SCAN", | |
| "DOCUMENT_CREATE_BPM", | |
| "DOCUMENT_CREATE_FILE_UPLOAD", | |
| "DOCUMENT_CREATE_OFFICE", | |
| "DOCUMENT_CREATE_FORM", | |
| "DOCUMENT_CREATE_POINTER", | |
| "POINTER_CREATE", | |
| "DOCUMENT_CREATE_SAVE_SEARCH", | |
| "DOCUMENT_CREATE_EDITING", | |
| "CHECKLIST_CREATE", | |
| "CLIPBOARD_ITEM_ADD", | |
| "DOCUMENT_DELETE", | |
| "DOCUMENT_PURGE", | |
| "DOCUMENT_MOVE", | |
| "DOCUMENT_PARTIAL_PURGE", | |
| "DOCUMENT_RESTORE", | |
| "DOCUMENT_VIEW", | |
| "DOCUMENT_THUMBNAIL_VIEW", | |
| "DOCUMENT_DOWNLOAD", | |
| "DOCUMENT_FILE_REPLACE", | |
| "DOCUMENT_CATEGORY_CREATE", | |
| "DOCUMENT_CATEGORY_UPDATE", | |
| "DOCUMENT_CATEGORY_DELETE", | |
| "DOCUMENT_SECURITY_CREATE", | |
| "DOCUMENT_SECURITY_UPDATE", | |
| "DOCUMENT_SECURITY_DELETE", | |
| "DOCUMENT_TYPE_CREATE", | |
| "DOCUMENT_TYPE_UPDATE", | |
| "DOCUMENT_TYPE_DELETE", | |
| "DOCUMENT_TYPE_GROUP_CREATE", | |
| "DOCUMENT_TYPE_GROUP_UPDATE", | |
| "DOCUMENT_TYPE_GROUP_DELETE", | |
| "DOCUMENT_TYPE_METADATA_ASSIGN", | |
| "DOCUMENT_TYPE_METADATA_REMOVE", | |
| "DOCUMENT_TYPE_OVERLAY_CREATE", | |
| "DOCUMENT_TYPE_OVERLAY_DELETE", | |
| "DOCUMENT_TYPE_SCAN_SETTING_CREATE", | |
| "DOCUMENT_TYPE_SCAN_SETTING_UPDATE", | |
| "DOCUMENT_TYPE_SCAN_SETTING_DELETE", | |
| "EDITING_CHECKOUT_DOCUMENT", | |
| "EDITING_ADMIN_CANCEL_EDIT", | |
| "EDITING_CANCEL_EDIT", | |
| "EDITING_CHECKIN_DOCUMENT", | |
| "EDITING_COMMIT_DOCUMENT", | |
| "EDITING_PAGE_ADDED", | |
| "EMAIL_SENT", | |
| "EMAIL_SENT_OUTLOOK", | |
| "FAX_TAKE_FAX_SERVICES_OFFLINE", | |
| "FAX_BRING_FAX_SERVICES_ONLINE", | |
| "FAX_FAX_SERVICE_GROUPS_ADD", | |
| "FAX_FAX_SERVICE_GROUPS_DELETE", | |
| "FORM_DESIGN_CREATE", | |
| "FORM_DESIGN_UPDATE", | |
| "FORM_DESIGN_DELETE", | |
| "FORM_DESIGN_IMPORT", | |
| "FORM_DESIGN_EXPORT", | |
| "FORM_DESIGN_ACTIVATE", | |
| "FORM_DESIGN_DEACTIVATE", | |
| "FORM_DESIGN_CHECK_IN", | |
| "FORM_DESIGN_CHECK_OUT", | |
| "FORM_DESIGN_OVERWRITE", | |
| "FORM_INSTANCE_ADD", | |
| "FORM_INSTANCE_UPDATE", | |
| "FORM_INSTANCE_DELETE", | |
| "FORM_INSTANCE_SUBMIT", | |
| "FORM_INSTANCE_CHECK_IN", | |
| "FORM_INSTANCE_CHECK_OUT", | |
| "FORM_INSTANCE_UNLOCK", | |
| "FORM_GROUP_ADD", | |
| "FORM_GROUP_DELETE", | |
| "GROUP_DELETE", | |
| "GROUP_FEATURE_RIGHT_CREATE", | |
| "GROUP_FEATURE_RIGHT_DELETE", | |
| "HOTKEY_RESET", | |
| "HOTKEY_UPDATE", | |
| "IMPORTER_CONFIGURATION_EXPORT", | |
| "IMPORTER_CREATE", | |
| "IMPORTER_UPDATE", | |
| "IMPORTER_DELETE", | |
| "IMPORTER_SCHEDULE_ENABLED", | |
| "IMPORTER_SCHEDULE_DISABLED", | |
| "IMPORTER_START", | |
| "IMPORTER_STOP", | |
| "INDEXING_CREATE", | |
| "INDEXING_UPDATE", | |
| "INDEXING_CONFIG_UPDATE", | |
| "INDEXING_CONFIG_DELETE", | |
| "LDAP_SYNC_START", | |
| "LDAP_SYNC_END", | |
| "LDAP_SYNC", | |
| "LDAP_SYNC_SCHEDULE_ENABLED", | |
| "LDAP_SYNC_SCHEDULE_DISABLED", | |
| "LDAP_CONFIGURED", | |
| "LDAP_DELETED", | |
| "LEGAL_HOLD_CREATE", | |
| "LEGAL_HOLD_RELEASE", | |
| "LEGAL_HOLD_CASE_CREATE", | |
| "LEGAL_HOLD_CASE_DELETE", | |
| "LEGAL_HOLD_CASE_UPDATE", | |
| "LEGAL_HOLD_CASE_CLOSE", | |
| "LEGAL_HOLD_CASE_REMOVE_ALL_HOLDS", | |
| "LEGAL_HOLD_CUSTODIAN_CREATE", | |
| "LEGAL_HOLD_CUSTODIAN_DELETE", | |
| "LICENSE_DEDICATED_CREATE", | |
| "LICENSE_DEDICATED_DELETE", | |
| "LICENSE_EMAIL_CONFIGURED", | |
| "LICENSE_POOL_GROUP_CREATE", | |
| "LICENSE_POOL_GROUP_UPDATE", | |
| "LICENSE_POOL_GROUP_DELETE", | |
| "LICENSE_FILE_UPLOAD", | |
| "LICENSE_REVOKED", | |
| "LICENSE_DENIED", | |
| "LOGOUT_SUCCESS", | |
| "METADATA_CREATE", | |
| "METADATA_UPDATE", | |
| "METADATA_DELETE", | |
| "METADATA_VALUE_CREATE", | |
| "METADATA_VALUE_UPDATE", | |
| "METADATA_VALUE_DELETE", | |
| "MARKUP_CREATE", | |
| "MARKUP_UPDATE", | |
| "MARKUP_DELETE", | |
| "STAMP_TEXT_CREATE", | |
| "STAMP_TEXT_DELETE", | |
| "STAMP_TEXT_UPDATE", | |
| "OVERLAY_CREATE", | |
| "OVERLAY_UPDATE", | |
| "OVERLAY_UPLOAD", | |
| "OVERLAY_DELETE", | |
| "PRINTFAX_ENQUEUE_PRINT_JOB", | |
| "PRINTFAX_ENQUEUE_FAX_JOB", | |
| "PRINTFAX_CANCEL_JOB", | |
| "PRINTFAX_DEVICES_CREATE", | |
| "PRINTFAX_DEVICES_UPDATE", | |
| "PRINTFAX_DEVICES_DELETE", | |
| "PRINTFAX_SERVERS_CREATE", | |
| "PRINTFAX_SERVERS_UPDATE", | |
| "PRINTFAX_SERVERS_DELETE", | |
| "PRINTFAX_TAKE_DEVICES_OFFLINE", | |
| "PRINTFAX_BRING_DEVICES_ONLINE", | |
| "PRINTFAX_DEVICE_GROUPS_CREATE", | |
| "PRINTFAX_DEVICE_GROUPS_DELETE", | |
| "PRINTFAX_FAX_SERVICES_CREATE", | |
| "PRINTFAX_FAX_SERVICES_UPDATE", | |
| "PRINTFAX_FAX_SERVICES_DELETE", | |
| "PROPERTY_CREATE", | |
| "PROPERTY_UPDATE", | |
| "PROPERTY_DELETE", | |
| "SCAN_SETTING_CREATE", | |
| "SCAN_SETTING_UPDATE", | |
| "SCAN_SETTING_DELETE", | |
| "SCAN_SETTING_GROUP_CREATE", | |
| "SCAN_SETTING_GROUP_UPDATE", | |
| "SCAN_SETTING_GROUP_DELETE", | |
| "SCHEDULE_CREATE", | |
| "SCHEDULE_DELETE", | |
| "REPOSITORY_CREATE", | |
| "REPOSITORY_DELETE", | |
| "REPOSITORY_UPDATE", | |
| "REPORT_IMPORTER_HEADER_LINE_PROPERTY_CREATE", | |
| "REPORT_IMPORTER_HEADER_LINE_PROPERTY_UPDATE", | |
| "REPORT_IMPORTER_HEADER_LINE_PROPERTY_DELETE", | |
| "REPORT_IMPORTER_SORT_COLUMN_CREATE", | |
| "REPORT_IMPORTER_SORT_COLUMN_UPDATE", | |
| "REPORT_IMPORTER_SORT_COLUMN_DELETE", | |
| "REPORT_IMPORTER_MERGE_FIELD_CREATE", | |
| "REPORT_IMPORTER_MERGE_FIELD_UPDATE", | |
| "REPORT_IMPORTER_MERGE_FIELD_DELETE", | |
| "REPORT_IMPORTER_COMPARE_FIELD_CREATE", | |
| "REPORT_IMPORTER_COMPARE_FIELD_UPDATE", | |
| "REPORT_IMPORTER_COMPARE_FIELD_DELETE", | |
| "RULE_SET_CREATE", | |
| "RULE_SET_UPDATE", | |
| "RULE_SET_DELETE", | |
| "RULE_SET_ASSIGNMENT_CREATE", | |
| "RULE_SET_ASSIGNMENT_UPDATE", | |
| "RULE_SET_ASSIGNMENT_DELETE", | |
| "RULE_SET_CONDITION_CREATE", | |
| "RULE_SET_CONDITION_UPDATE", | |
| "RULE_SET_CONDITION_DELETE", | |
| "RULE_SET_BATCH_GROUP_CREATE", | |
| "RULE_SET_BATCH_GROUP_UPDATE", | |
| "RULE_SET_BATCH_GROUP_DELETE", | |
| "RULE_SET_PROCESS_INSTANCE_VARIABLE_CREATE", | |
| "RULE_SET_PROCESS_INSTANCE_VARIABLE_UPDATE", | |
| "RULE_SET_PROCESS_INSTANCE_VARIABLE_DELETE", | |
| "SEARCH_CREATE", | |
| "SEARCH_UPDATE", | |
| "SEARCH_DELETE", | |
| "SEARCH_GROUP_CREATE", | |
| "SEARCH_GROUP_UPDATE", | |
| "SEARCH_GROUP_DELETE", | |
| "SEARCH_CATEGORY_CREATE", | |
| "SEARCH_CATEGORY_UPDATE", | |
| "SEARCH_CATEGORY_DELETE", | |
| "SEARCH_DOCUMENT_TYPE_CREATE", | |
| "SEARCH_DOCUMENT_TYPE_UPDATE", | |
| "SEARCH_DOCUMENT_TYPE_DELETE", | |
| "SEARCH_FORM_DATA_CREATE", | |
| "SEARCH_FORM_DATA_DELETE", | |
| "SEARCH_FORM_DATA_UPDATE", | |
| "SEARCH_TREE_FILTER_CREATE", | |
| "SEARCH_TREE_FILTER_DELETE", | |
| "SEARCH_TREE_FILTER_UPDATE", | |
| "SEARCH_PARAMETER_CREATE", | |
| "SEARCH_PARAMETER_UPDATE", | |
| "SEARCH_PARAMETER_DELETE", | |
| "SEARCH_PROMPT_CREATE", | |
| "SEARCH_PROMPT_UPDATE", | |
| "SEARCH_PROMPT_DELETE", | |
| "SEARCH_PROMPT_VALUES_CREATE", | |
| "SEARCH_PROMPT_VALUES_UPDATE", | |
| "SEARCH_PROMPT_VALUES_DELETE", | |
| "SEARCH_RESULT_CREATE", | |
| "SEARCH_RESULT_UPDATE", | |
| "SEARCH_RESULT_DELETE", | |
| "SEARCH_RESULT_LINKED_METADATA_CREATE", | |
| "SEARCH_RESULT_LINKED_METADATA_UPDATE", | |
| "SEARCH_RESULT_LINKED_METADATA_DELETE", | |
| "SEARCH_SORT_ORDER_CREATE", | |
| "SEARCH_SORT_ORDER_UPDATE", | |
| "SEARCH_SORT_ORDER_DELETE", | |
| "SEARCH_SORT_ORDER_CUSTOM_CREATE", | |
| "SEARCH_SORT_ORDER_CUSTOM_UPDATE", | |
| "SEARCH_SORT_ORDER_CUSTOM_DELETE", | |
| "SEARCH_EXECUTION_CATEGORY", | |
| "SEARCH_EXECUTION_TREE", | |
| "SEARCH_EXECUTION_TEMPLATE", | |
| "SEARCH_EXECUTION_CHECKLIST", | |
| "SEARCH_EXECUTION_STORED_PROCEDURE", | |
| "SECURITY_FILTER_CREATE", | |
| "SECURITY_FILTER_UPDATE", | |
| "SECURITY_FILTER_DELETE", | |
| "SERVER_CREATE", | |
| "SERVER_UPDATE", | |
| "SERVER_DELETE", | |
| "SERVER_ALERT_CREATE", | |
| "SERVER_ALERT_DELETE", | |
| "SYSTEM_MESSAGE_DELETE", | |
| "SYSTEM_MESSAGE_DELETE_ALL", | |
| "SYSTEM_LOG_CLEAR", | |
| "SYSTEM_SET_LOGLEVEL", | |
| "SYSTEM_SET_LOGLEVEL_ALL", | |
| "SYSTEM_PROPERTY_CREATE", | |
| "SYSTEM_PROPERTY_UPDATE", | |
| "USER_CREATE", | |
| "USER_UPDATE", | |
| "USER_DELETE", | |
| "USER_FAVORITE_CREATE", | |
| "USER_FAVORITE_UPDATE", | |
| "USER_FAVORITE_DELETE", | |
| "USER_GROUP_CREATE", | |
| "USER_GROUP_UPDATE", | |
| "USER_GROUP_MEMBER_CREATE", | |
| "USER_GROUP_MEMBER_UPDATE", | |
| "USER_GROUP_MEMBERSHIP_DELETE", | |
| "USER_PASSWORD_UPDATE", | |
| "USER_FORGOT_PASSWORD_UPDATE", | |
| "USER_LOCKED_BY_INVALID_ATTEMPTS", | |
| "VALIDATOR_CREATE", | |
| "VALIDATOR_UPDATE", | |
| "VALIDATOR_DELETE", | |
| "XSD_CREATE", | |
| "XSD_UPDATE", | |
| "XSD_DELETE", | |
| "WSDL_URL_CREATE", | |
| "WSDL_URL_UPDATE", | |
| "WSDL_URL_DELETE", | |
| "HSM_CREATE", | |
| "HSM_UPDATE", | |
| "HSM_DELETE", | |
| "HSM_START", | |
| "HSM_STOP", | |
| "HSM_SCHEDULE_ENABLED", | |
| "HSM_SCHEDULE_DISABLED", | |
| "HSM_ACTION_COPY", | |
| "HSM_ACTION_MOVE", | |
| "HSM_ACTION_PURGE", | |
| "HSM_ACTION_START_PROCESS", | |
| "HSM_ACTION_MOVE_AUDITS", | |
| "HSM_ACTION_PURGE_COMPLETED_PROCESSES", | |
| "HSM_ACTION_PURGE_FILES", | |
| "HSM_RUN_ONCE", | |
| "EXPORTER_PROFILE_CREATE", | |
| "EXPORTER_PROFILE_DELETE", | |
| "EXPORTER_PROFILE_UPDATE", | |
| "EXPORTER_PROFILE_GROUP_CREATE", | |
| "EXPORTER_PROFILE_GROUP_DELETE", | |
| "EXPORTER_PROFILE_GROUP_UPDATE", | |
| "EXPORTER_ENQUEUE_JOB", | |
| "EXPORTER_PROCESS_JOB", | |
| "EXPORTER_DELETE_JOB", | |
| "EXPORTER_CANCEL_JOB", | |
| "EXPORTER_DOWNLOAD", | |
| "EXPORTER_SERVER_CREATE", | |
| "EXPORTER_SERVER_UPDATE", | |
| "EXPORTER_SERVER_DELETE", | |
| "DOCUMENT_EXPORTED", | |
| "SEARCH_RESULT_EXPORT_QUEUE", | |
| "SEARCH_RESULT_EXPORT_DOWNLOAD", | |
| "VERSION_INITIAL", | |
| "VERSION_MAJOR", | |
| "VERSION_MINOR", | |
| "VERSION_REVERT", | |
| "PASSWORD_RULE_UPDATE", | |
| "RETENTION_POLICY_CREATE", | |
| "RETENTION_POLICY_UPDATE", | |
| "RETENTION_POLICY_DELETE", | |
| "RETENTION_POLICY_CUSTODIAN_ADD", | |
| "RETENTION_POLICY_CUSTODIAN_REMOVE", | |
| "RETENTION_POLICY_DOCUMENT_TYPE_ASSIGN", | |
| "RETENTION_POLICY_SCHEDULE_ENABLE", | |
| "RETENTION_POLICY_DISPOSITION_EXECUTION", | |
| "RETENTION_POLICY_OVERRIDE", | |
| "RETENTION_POLICY_CANCEL_OVERRIDE", | |
| "SERVER_STARTUP", | |
| "SERVER_SHUTDOWN", | |
| "AUDIT_SETTING_CHANGE", | |
| "COLD_NARRATIVE_CREATE", | |
| "COLD_NARRATIVE_UPDATE", | |
| "COLD_NARRATIVE_DELETE" | |
| ] | |
| }, | |
| "enabled": { | |
| "type": "boolean", | |
| "description": "The boolean flag indicating if the auditing event type is configured to record an audit or not.", | |
| "default": false | |
| }, | |
| "includedInDocInfo": { | |
| "type": "boolean", | |
| "description": "The boolean indication whether or not the audit type is used in DocumentHistory functionality.", | |
| "default": false | |
| }, | |
| "includedInRecordInfo": { | |
| "type": "boolean", | |
| "description": "The boolean indication whether or not the audit type is used in Records Search functionality.", | |
| "default": false | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The localized description of the audit type." | |
| } | |
| }, | |
| "description": "Auditing data used to configure auditing levels for the system." | |
| }, | |
| "DatabaseColumnDTO": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "dataType": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "columnSize": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "nullable": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "primaryKey": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "autoIncrement": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "DocumentSecurityAssignmentDTO": { | |
| "type": "object", | |
| "properties": { | |
| "documentSecurityDtos": { | |
| "type": "array", | |
| "description": "The document security configuration for this document type.", | |
| "items": { | |
| "$ref": "#/definitions/DocumentSecurityDTO" | |
| } | |
| }, | |
| "documentTypeId": { | |
| "type": "string", | |
| "description": "The document type ID to work with." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "An object that assigns document security to a group." | |
| }, | |
| "SQLException": { | |
| "type": "object", | |
| "properties": { | |
| "cause": { | |
| "$ref": "#/definitions/Throwable" | |
| }, | |
| "stackTrace": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/StackTraceElement" | |
| } | |
| }, | |
| "errorCode": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "sqlstate": { | |
| "type": "string" | |
| }, | |
| "nextException": { | |
| "$ref": "#/definitions/SQLException" | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "localizedMessage": { | |
| "type": "string" | |
| }, | |
| "suppressed": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Throwable" | |
| } | |
| } | |
| } | |
| }, | |
| "DataStoreColumnDTO": { | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "type" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the datastore column configuration data." | |
| }, | |
| "nullable": { | |
| "type": "boolean", | |
| "description": "The boolean flag to indicate if database column used by datastore is nullable.", | |
| "default": false | |
| }, | |
| "primaryKey": { | |
| "type": "boolean", | |
| "description": "The primary key flag to indicate if database column used by datastore is the primary key.", | |
| "default": false | |
| }, | |
| "autoIncrement": { | |
| "type": "boolean", | |
| "description": "The auto increment key flag to indicate if database column used by datastore is to be auto incremented.", | |
| "default": false | |
| }, | |
| "useInWhereClause": { | |
| "type": "boolean", | |
| "description": "The use in where clause flag to indicate if database column used by datastore is part of a where clause.", | |
| "default": false | |
| }, | |
| "useInInsert": { | |
| "type": "boolean", | |
| "description": "The use in insert flag to indicate that the database column must be used in an insert clause by the datastore.", | |
| "default": false | |
| }, | |
| "useInUpdate": { | |
| "type": "boolean", | |
| "description": "The use in update flag to indicate that the database column must be used in an update clause by the datastore.", | |
| "default": false | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal flag to indicate the ordinal of the datastore column object." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the database column used by the datastore." | |
| }, | |
| "type": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The type of the database column used by the datastore." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The string representation of type." | |
| } | |
| }, | |
| "description": "Database column information used by datastores." | |
| }, | |
| "ValidatorProperty": { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "validator": { | |
| "$ref": "#/definitions/Validator" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "displayName": { | |
| "type": "string" | |
| }, | |
| "displayValue": { | |
| "type": "string" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "RenderContextDTO": { | |
| "type": "object", | |
| "properties": { | |
| "dashboardChartableId": { | |
| "type": "string", | |
| "description": "The ID of the DashboardChartable to render." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The drill down ordinal, starting at 0, used when rendering a drill down. Honestly I'm not sure why we aren't passing the ID of the drill down instead." | |
| }, | |
| "values": { | |
| "description": "The values needed to render the chart, taken from dashboard inputs, chart output and parent chart input.", | |
| "$ref": "#/definitions/RenderValuesDTO" | |
| } | |
| }, | |
| "description": "An object that provides the arguments needed to render a chart on a dashboard." | |
| }, | |
| "SaveDashboardAsDTO": { | |
| "type": "object", | |
| "properties": { | |
| "dashboard": { | |
| "description": "The dashboard to be saved.", | |
| "$ref": "#/definitions/DashboardDTO" | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the new dashboard." | |
| }, | |
| "overwriteDesignId": { | |
| "type": "string", | |
| "description": "The ID of a dashboard to be overwritten with this dashboard." | |
| } | |
| }, | |
| "description": "An object containing the data needed to invoke a save as operation for a dashboard." | |
| }, | |
| "DispositionQueueItem": { | |
| "type": "object", | |
| "required": [ | |
| "dispositionQueue", | |
| "document" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "dispositionQueue": { | |
| "$ref": "#/definitions/DispositionQueue" | |
| }, | |
| "document": { | |
| "$ref": "#/definitions/Document" | |
| }, | |
| "approvals": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/DispositionQueueApproval" | |
| } | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "ImporterDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "xml": { | |
| "name": "result" | |
| }, | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/ImporterDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "ChartablePropertiesDTO": { | |
| "type": "object", | |
| "properties": { | |
| "backgroundColor": { | |
| "type": "string", | |
| "description": "The background color for the chart." | |
| }, | |
| "chart": { | |
| "description": "The chart properties.", | |
| "$ref": "#/definitions/ChartPropertiesDTO" | |
| }, | |
| "title": { | |
| "description": "The title properties.", | |
| "$ref": "#/definitions/TitlePropertiesDTO" | |
| }, | |
| "legend": { | |
| "description": "The legend properties.", | |
| "$ref": "#/definitions/LegendPropertiesDTO" | |
| }, | |
| "scale": { | |
| "description": "The scale properties.", | |
| "$ref": "#/definitions/ScalePropertiesDTO" | |
| }, | |
| "tooltips": { | |
| "description": "The tooltip properties.", | |
| "$ref": "#/definitions/TooltipsPropertiesDTO" | |
| }, | |
| "plot": { | |
| "description": "The plot properties.", | |
| "$ref": "#/definitions/PlotPropertiesDTO" | |
| } | |
| }, | |
| "description": "An object that encapsulates all of the display properties for a chart." | |
| }, | |
| "TextChartDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/ChartableDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "INTERNAL", | |
| "STANDARD" | |
| ] | |
| }, | |
| "isLocked": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "lockOwner": { | |
| "type": "string" | |
| }, | |
| "lockOwnerFirstName": { | |
| "type": "string" | |
| }, | |
| "lockOwnerLastName": { | |
| "type": "string" | |
| }, | |
| "dateModified": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "properties": { | |
| "$ref": "#/definitions/ChartablePropertiesDTO" | |
| }, | |
| "datasourceId": { | |
| "type": "string" | |
| }, | |
| "datasourceName": { | |
| "type": "string" | |
| }, | |
| "datasourceParameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DatasourceArgumentDTO" | |
| } | |
| }, | |
| "refreshInterval": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "isValid": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "variables": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartVariableDTO" | |
| } | |
| }, | |
| "datasourceInputs": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartDatasourceInputDTO" | |
| } | |
| }, | |
| "dashboardCount": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "overrideErrorsOnSave": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "label": { | |
| "type": "string", | |
| "description": "The label text." | |
| }, | |
| "labelPosition": { | |
| "type": "string", | |
| "description": "The position of the label.", | |
| "enum": [ | |
| "TOP", | |
| "BOTTOM", | |
| "LEFT", | |
| "RIGHT" | |
| ] | |
| }, | |
| "valueType": { | |
| "type": "string", | |
| "description": "The type of value for the text value.", | |
| "enum": [ | |
| "STATIC", | |
| "MACRO", | |
| "DATASOURCE", | |
| "CHART_VARIABLE" | |
| ] | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "The static text value, used when valueType is STATIC, MACRO or CHART_VARIABLE" | |
| }, | |
| "labelColor": { | |
| "type": "string", | |
| "description": "The color of the label." | |
| }, | |
| "labelSize": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The size of the label." | |
| }, | |
| "labelBold": { | |
| "type": "boolean", | |
| "description": "Whether the label is bold.", | |
| "default": false | |
| }, | |
| "valueColor": { | |
| "type": "string", | |
| "description": "The color of the value." | |
| }, | |
| "valueSize": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The size of the value." | |
| }, | |
| "valueBold": { | |
| "type": "boolean", | |
| "description": "Whether the value is bold.", | |
| "default": false | |
| }, | |
| "position": { | |
| "type": "string", | |
| "description": "The position of the text in its given space.", | |
| "enum": [ | |
| "TOP_LEFT", | |
| "TOP_CENTER", | |
| "TOP_RIGHT", | |
| "MIDDLE_LEFT", | |
| "MIDDLE_CENTER", | |
| "MIDDLE_RIGHT", | |
| "BOTTOM_LEFT", | |
| "BOTTOM_CENTER", | |
| "BOTTOM_RIGHT" | |
| ] | |
| }, | |
| "alignment": { | |
| "type": "string", | |
| "description": "The alignment of the text.", | |
| "enum": [ | |
| "LEFT", | |
| "CENTER", | |
| "RIGHT" | |
| ] | |
| } | |
| }, | |
| "description": "A text chart." | |
| } | |
| ] | |
| }, | |
| "InputStream": { | |
| "type": "object" | |
| }, | |
| "DocumentType": { | |
| "type": "object", | |
| "required": [ | |
| "description", | |
| "name", | |
| "retentionPolicy", | |
| "status" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "category": { | |
| "$ref": "#/definitions/Category" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "documents": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Document" | |
| } | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "INTERNAL", | |
| "STANDARD", | |
| "DELETED" | |
| ] | |
| }, | |
| "fullText": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "fullTextChanged": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "version": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "documentTypeMetadatas": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeMetadata" | |
| } | |
| }, | |
| "documentTypeGroups": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeGroup" | |
| } | |
| }, | |
| "documentTypeOverlays": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeOverlay" | |
| } | |
| }, | |
| "documentTypeScanSettings": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeScanSetting" | |
| } | |
| }, | |
| "documentTypeProcessModels": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeProcessModel" | |
| } | |
| }, | |
| "retentionPolicy": { | |
| "$ref": "#/definitions/RetentionPolicy" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "originalName": { | |
| "type": "string" | |
| }, | |
| "distinctiveName": { | |
| "type": "string" | |
| }, | |
| "nameChanged": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validateRetentionPolicyMetadata": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "ContentDisposition": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "parameters": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "Filter": { | |
| "type": "object", | |
| "properties": { | |
| "field": { | |
| "type": "string" | |
| }, | |
| "operator": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "DashboardPromptDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/DashboardInputDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DashboardInput." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The input name, must be unique per dashboard." | |
| }, | |
| "value": { | |
| "type": "object" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of input.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "DASHBOARD_PROMPT" | |
| ] | |
| }, | |
| "dashboardId": { | |
| "type": "string", | |
| "description": "The ID of the dashboard that owns this input." | |
| }, | |
| "dashboardName": { | |
| "type": "string", | |
| "description": "The name of the dashboard that owns this input." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The ID of the datasource used by this input." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "The name of the datasource used by this input." | |
| }, | |
| "datasourceResults": { | |
| "type": "array", | |
| "description": "The results from executing the datasource.", | |
| "items": { | |
| "$ref": "#/definitions/DataValue" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "responsibilityMapping": { | |
| "type": "array", | |
| "description": "The responsibility mapping for executing dependent inputs.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "dashboardInputDatasourceInputs": { | |
| "type": "array", | |
| "description": "The inputs needed for the datasource for this input.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardInputDatasourceInputDTO" | |
| } | |
| }, | |
| "label": { | |
| "type": "string", | |
| "description": "The prompt label." | |
| }, | |
| "promptType": { | |
| "type": "string", | |
| "description": "The prompt type.", | |
| "enum": [ | |
| "SWITCH", | |
| "DATE", | |
| "TEXT", | |
| "DROP_DOWN_LIST" | |
| ] | |
| } | |
| }, | |
| "description": "A user prompt input." | |
| } | |
| ] | |
| }, | |
| "SearchPrompt": { | |
| "type": "object", | |
| "required": [ | |
| "attributeName", | |
| "attributeType", | |
| "ordinal", | |
| "search" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "search": { | |
| "$ref": "#/definitions/Search" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "PROMPTED", | |
| "STATIC" | |
| ] | |
| }, | |
| "attributeType": { | |
| "type": "string", | |
| "enum": [ | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "FULL_TEXT", | |
| "DIARY", | |
| "METADATA", | |
| "OTHER", | |
| "STORED_PROC_PARAM", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES", | |
| "FILE_TYPE", | |
| "HIDDEN", | |
| "HIDDEN_DATE", | |
| "HIDDEN_INTEGER", | |
| "HIDDEN_DECIMAL" | |
| ] | |
| }, | |
| "attributeName": { | |
| "type": "string" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Metadata" | |
| }, | |
| "lookupList": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "valueRequired": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "label": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "searchPromptDatasource": { | |
| "$ref": "#/definitions/SearchPromptDatasource" | |
| }, | |
| "allowUserInput": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "defaultValueType": { | |
| "type": "string", | |
| "enum": [ | |
| "NONE", | |
| "STATIC", | |
| "FIRST_VALUE" | |
| ] | |
| }, | |
| "parameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchParameter" | |
| } | |
| }, | |
| "filterDocumentType": { | |
| "$ref": "#/definitions/DocumentType" | |
| }, | |
| "filterCategory": { | |
| "$ref": "#/definitions/Category" | |
| }, | |
| "allowMultipleValues": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "subSearchParameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchSubSearchParameter" | |
| } | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "UserDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/UserDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "DocumentTypeDTO": { | |
| "type": "object", | |
| "properties": { | |
| "categoryId": { | |
| "type": "string", | |
| "description": "The ID of the category the document type is associated with." | |
| }, | |
| "categoryName": { | |
| "type": "string", | |
| "description": "The name of the category the document type is associated with." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description of the document type." | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the document type." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the document type." | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "The type of document type.", | |
| "enum": [ | |
| "INTERNAL", | |
| "STANDARD", | |
| "DELETED" | |
| ] | |
| }, | |
| "fullText": { | |
| "type": "boolean", | |
| "description": "Flag to indicate document type is full texted.", | |
| "default": false | |
| }, | |
| "version": { | |
| "type": "boolean", | |
| "description": "The version of the document type.", | |
| "default": false | |
| }, | |
| "documentCount": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "The count of the documents associated with the document type." | |
| }, | |
| "retentionPolicy": { | |
| "description": "The retention policy associated with the document type.", | |
| "$ref": "#/definitions/RetentionPolicyDTO" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The flag to indicate if document type is marked for deletion.", | |
| "default": false | |
| } | |
| }, | |
| "description": "DocumentType data used to configure document types for the system." | |
| }, | |
| "LicenseDTO": { | |
| "type": "object", | |
| "properties": { | |
| "companyName": { | |
| "type": "string" | |
| }, | |
| "dateIssued": { | |
| "type": "string" | |
| }, | |
| "expirationDate": { | |
| "type": "string" | |
| }, | |
| "numberOfLicenses": { | |
| "type": "string" | |
| }, | |
| "modules": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "DocumentSecurity": { | |
| "type": "object", | |
| "required": [ | |
| "documentTypeGroup", | |
| "permissionType" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "documentTypeGroup": { | |
| "$ref": "#/definitions/DocumentTypeGroup" | |
| }, | |
| "permissionType": { | |
| "type": "string", | |
| "enum": [ | |
| "LIST", | |
| "VIEW", | |
| "DELETE", | |
| "UPDATE", | |
| "EDIT", | |
| "OVERRIDE_REDACTIONS", | |
| "VIEW_MARKUP" | |
| ] | |
| }, | |
| "securityFilters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SecurityFilter" | |
| } | |
| }, | |
| "markedForFilterDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "FormControlProperty": { | |
| "type": "object", | |
| "required": [ | |
| "propertyName", | |
| "propertyValue" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "propertyName": { | |
| "type": "string" | |
| }, | |
| "propertyValue": { | |
| "type": "string" | |
| }, | |
| "formControlStep": { | |
| "$ref": "#/definitions/FormControlStep" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "ChartPropertiesDTO": { | |
| "type": "object", | |
| "properties": { | |
| "animate": { | |
| "type": "boolean", | |
| "description": "Whether to animate when drawing the chart.", | |
| "default": false | |
| }, | |
| "orientation": { | |
| "type": "string", | |
| "description": "The chart orientation.", | |
| "enum": [ | |
| "HORIZONTAL", | |
| "VERTICAL" | |
| ] | |
| }, | |
| "border": { | |
| "description": "The chart border configuration.", | |
| "$ref": "#/definitions/ChartBorderDTO" | |
| }, | |
| "stacked": { | |
| "type": "boolean", | |
| "description": "Whether the chart data should be stacked.", | |
| "default": false | |
| }, | |
| "spline": { | |
| "type": "boolean", | |
| "description": "Whether the chart's line should be a spline.", | |
| "default": false | |
| }, | |
| "labelConnected": { | |
| "type": "boolean", | |
| "description": "Whether the labels should be connected to the chart.", | |
| "default": false | |
| }, | |
| "sortable": { | |
| "type": "boolean", | |
| "description": "Whether the chart is sortable.", | |
| "default": false | |
| }, | |
| "sortDirection": { | |
| "type": "string", | |
| "description": "The sort direction", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| }, | |
| "format": { | |
| "description": "The chart format properties.", | |
| "$ref": "#/definitions/FormatDTO" | |
| } | |
| }, | |
| "description": "An object that holds general properties for the chart." | |
| }, | |
| "RenderValuesDTO": { | |
| "type": "object", | |
| "properties": { | |
| "dashboardInputs": { | |
| "type": "array", | |
| "description": "The values of all dashboard inputs.", | |
| "items": { | |
| "$ref": "#/definitions/KeyValuePair" | |
| } | |
| }, | |
| "parentInputs": { | |
| "type": "array", | |
| "description": "The values of the inputs to the parent chart.", | |
| "items": { | |
| "$ref": "#/definitions/KeyValuePair" | |
| } | |
| }, | |
| "chartOutputs": { | |
| "type": "array", | |
| "description": "The values gathered from the output of the current chart based on where the user clicked.", | |
| "items": { | |
| "$ref": "#/definitions/DrillDownKeyValuePair" | |
| } | |
| } | |
| }, | |
| "description": "An object that holds values needed to render a chart on a dashboard." | |
| }, | |
| "IndexingValuesDTO": { | |
| "type": "object", | |
| "properties": { | |
| "indexingValuesToDelete": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/IndexingValueDTO" | |
| } | |
| }, | |
| "indexingValuesToSave": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/IndexingValueDTO" | |
| } | |
| }, | |
| "indexFlag": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "startProcess": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "ExporterOutputTypeDTO": { | |
| "type": "object", | |
| "properties": { | |
| "exportType": { | |
| "type": "string", | |
| "description": "The output type of the export.", | |
| "enum": [ | |
| "NATIVE", | |
| "PDF", | |
| "PDFA", | |
| "SINGLE_PDF" | |
| ] | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description of the output type" | |
| } | |
| }, | |
| "description": "The output types supported by the exporting process." | |
| }, | |
| "ServiceDTO": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "operations": { | |
| "type": "array", | |
| "xml": { | |
| "name": "operation" | |
| }, | |
| "items": { | |
| "$ref": "#/definitions/OperationDTO" | |
| } | |
| } | |
| } | |
| }, | |
| "DocumentTypeInclusiveDTO": { | |
| "type": "object", | |
| "properties": { | |
| "categoryId": { | |
| "type": "string", | |
| "description": "The ID of the category the document type is associated with." | |
| }, | |
| "categoryName": { | |
| "type": "string", | |
| "description": "The name of the category the document type is associated with." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description of the document type." | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the document type." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the document type." | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "The type of document type.", | |
| "enum": [ | |
| "INTERNAL", | |
| "STANDARD", | |
| "DELETED" | |
| ] | |
| }, | |
| "fullText": { | |
| "type": "boolean", | |
| "description": "Flag to indicate document type is full texted.", | |
| "default": false | |
| }, | |
| "version": { | |
| "type": "boolean", | |
| "description": "The version of the document type.", | |
| "default": false | |
| }, | |
| "documentCount": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "The count of the documents associated with the document type." | |
| }, | |
| "retentionPolicy": { | |
| "description": "The retention policy associated with the document type.", | |
| "$ref": "#/definitions/RetentionPolicyDTO" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The flag to indicate if document type is marked for deletion.", | |
| "default": false | |
| }, | |
| "documentTypeGroupDtos": { | |
| "type": "array", | |
| "description": "The array of data transfer objects representing the document type to group associations.", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeGroupDTO" | |
| } | |
| }, | |
| "documentTypeMetadataDtos": { | |
| "type": "array", | |
| "description": "The array of data transfer objects representing the document type to metadata associations.", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeMetadataDTO" | |
| } | |
| }, | |
| "documentTypeOverlayDtos": { | |
| "type": "array", | |
| "description": "The array of data transfer objects representing the document type to overlay associations.", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeOverlayDTO" | |
| } | |
| }, | |
| "scanSettingDtos": { | |
| "type": "array", | |
| "description": "The array of data transfer objects representing the scan setting configurations associated to this document types.", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeScanSettingDTO" | |
| } | |
| }, | |
| "processModelDtos": { | |
| "type": "array", | |
| "description": "The array of data transfer objects representing the process models associated to this document types.", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeProcessModelDTO" | |
| } | |
| } | |
| }, | |
| "description": "DocumentType data used to configure document types for the system." | |
| }, | |
| "GenericScheduledTimeDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "startTime": { | |
| "type": "string" | |
| }, | |
| "duration": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "weekday": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "weekdayOccurrence": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "MetadataDTO": { | |
| "type": "object", | |
| "properties": { | |
| "description": { | |
| "type": "string", | |
| "description": "The description of the metadata." | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the metadata configuration data." | |
| }, | |
| "isCollection": { | |
| "type": "boolean", | |
| "description": "The boolean flag indicates if metadata supports a collection of values.", | |
| "default": false | |
| }, | |
| "isCurrency": { | |
| "type": "boolean", | |
| "description": "The boolean flag indicates if metadata is for a currency.", | |
| "default": false | |
| }, | |
| "length": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The length of the value the metadata can hold." | |
| }, | |
| "decimalPrecision": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The decimal precision of the value the metadata can hold." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "maxLength": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum length of the value the metadata can hold." | |
| }, | |
| "metadataType": { | |
| "type": "string", | |
| "description": "The type of metadata.", | |
| "enum": [ | |
| "DATE", | |
| "INTEGER", | |
| "DECIMAL", | |
| "STRING_VARIABLE" | |
| ] | |
| }, | |
| "minLength": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The minimum length of the value the metadata can hold." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the metadata." | |
| }, | |
| "shortName": { | |
| "type": "string", | |
| "description": "The short name of the metadata." | |
| }, | |
| "currencyLocale": { | |
| "type": "string", | |
| "description": "The currency locale of the metadata." | |
| } | |
| }, | |
| "description": "Metadata data used to configure metadatas for the system." | |
| }, | |
| "ValidationResult": { | |
| "type": "object", | |
| "properties": { | |
| "errors": { | |
| "type": "array", | |
| "description": "The list of validation errors and warnings.", | |
| "items": { | |
| "$ref": "#/definitions/ValidationError" | |
| } | |
| }, | |
| "hasErrors": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "hasErrorsNotWarnings": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "hasWarnings": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| }, | |
| "description": "A validation result containing warnings and errors." | |
| }, | |
| "DocumentTypeMetadataDTO": { | |
| "type": "object", | |
| "properties": { | |
| "documentTypeId": { | |
| "type": "string", | |
| "description": "The ID of the document type." | |
| }, | |
| "documentTypeName": { | |
| "type": "string", | |
| "description": "The name of the document type." | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of this item." | |
| }, | |
| "isDefault": { | |
| "type": "boolean", | |
| "description": "Whether this piece of metadata is the default display value for the document type.", | |
| "default": false | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "metadataId": { | |
| "type": "string", | |
| "description": "The ID of the metadata object." | |
| }, | |
| "metadataName": { | |
| "type": "string", | |
| "description": "The name of the metadata object." | |
| }, | |
| "metadataType": { | |
| "type": "string", | |
| "description": "The type of the metadata object.", | |
| "enum": [ | |
| "DATE", | |
| "INTEGER", | |
| "DECIMAL", | |
| "STRING_VARIABLE" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "The ordinal of this piece of metadata on the document type." | |
| }, | |
| "isCurrency": { | |
| "type": "boolean", | |
| "description": "Whether this metadata is represents currency data.", | |
| "default": false | |
| }, | |
| "decimalPrecision": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The decimal precision of this metadata object." | |
| }, | |
| "currencyLocale": { | |
| "type": "string", | |
| "description": "The locale used for currency type metadata." | |
| }, | |
| "maxLength": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum length of data used in this metadata object." | |
| }, | |
| "minLength": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The minimum length of data used in this metadata object." | |
| }, | |
| "indexingConfigurationDto": { | |
| "description": "The indexing configuration data associated to this metadata to document type relationship.", | |
| "$ref": "#/definitions/IndexingConfigurationDTO" | |
| }, | |
| "isEditable": { | |
| "type": "boolean", | |
| "description": "Whether this piece of metadata is editable during indexing.", | |
| "default": false | |
| }, | |
| "isRequired": { | |
| "type": "boolean", | |
| "description": "Whether this piece of metadata is required to index this document type.", | |
| "default": false | |
| } | |
| }, | |
| "description": "An object representing a piece of metadata that is assigned to a specific document type." | |
| }, | |
| "ColdImporterNarrativeTestDataDTO": { | |
| "type": "object", | |
| "properties": { | |
| "narrativeTestId": { | |
| "type": "string", | |
| "description": "The narrative test id" | |
| }, | |
| "lineCount": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "The total line count" | |
| }, | |
| "headers": { | |
| "type": "array", | |
| "description": "The headers", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "startLine": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The start line for the report" | |
| }, | |
| "endLine": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The end line for the report" | |
| } | |
| }, | |
| "description": "Cold importer narrative test data results" | |
| }, | |
| "SynchronizationErrorDTO": { | |
| "type": "object", | |
| "properties": { | |
| "objectName": { | |
| "type": "string", | |
| "description": "Name of object. Context sensitive." | |
| }, | |
| "fieldName": { | |
| "type": "string", | |
| "description": "Name of field. Context sensitive." | |
| }, | |
| "message": { | |
| "type": "string", | |
| "description": "Detailed error message. May be truncated." | |
| }, | |
| "entityType": { | |
| "type": "string", | |
| "description": "Detailed error message. May be truncated.", | |
| "enum": [ | |
| "USER", | |
| "GROUP", | |
| "SYSTEM" | |
| ] | |
| } | |
| }, | |
| "description": "Detached object representation of persisted LDAP synchronization errors." | |
| }, | |
| "MetadataValueCriteria": { | |
| "type": "object", | |
| "properties": { | |
| "comparator": { | |
| "type": "string", | |
| "enum": [ | |
| "EQUALS", | |
| "NOT_EQUALS", | |
| "GREATER_THAN", | |
| "LESS_THAN", | |
| "GREATER_THAN_EQUALS", | |
| "LESS_THAN_EQUALS", | |
| "CONTAINS", | |
| "NOT_CONTAINS", | |
| "IN" | |
| ] | |
| }, | |
| "connective": { | |
| "type": "string", | |
| "enum": [ | |
| "AND", | |
| "OR" | |
| ] | |
| }, | |
| "dateValue": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "decimalValue": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "documentIds": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "documentTypeIds": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "categoryIds": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "metadataId": { | |
| "type": "string" | |
| }, | |
| "metadataShortName": { | |
| "type": "string" | |
| }, | |
| "numericValue": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "strValue": { | |
| "type": "string" | |
| }, | |
| "metadataType": { | |
| "type": "string", | |
| "enum": [ | |
| "DATE", | |
| "INTEGER", | |
| "DECIMAL", | |
| "STRING_VARIABLE" | |
| ] | |
| }, | |
| "attributeType": { | |
| "type": "string", | |
| "enum": [ | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "FULL_TEXT", | |
| "DIARY", | |
| "METADATA", | |
| "OTHER", | |
| "STORED_PROC_PARAM", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES", | |
| "FILE_TYPE", | |
| "HIDDEN", | |
| "HIDDEN_DATE", | |
| "HIDDEN_INTEGER", | |
| "HIDDEN_DECIMAL" | |
| ] | |
| }, | |
| "attributeName": { | |
| "type": "string" | |
| }, | |
| "parameterType": { | |
| "type": "string", | |
| "enum": [ | |
| "PROMPTED", | |
| "STATIC", | |
| "MACRO", | |
| "CUSTOM" | |
| ] | |
| }, | |
| "documentSecurityId": { | |
| "type": "string" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "openingParen": { | |
| "type": "string" | |
| }, | |
| "closingParen": { | |
| "type": "string" | |
| }, | |
| "searchPromptName": { | |
| "type": "string" | |
| }, | |
| "searchPromptId": { | |
| "type": "string" | |
| }, | |
| "currencyLocale": { | |
| "type": "string" | |
| }, | |
| "precision": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "isCurrency": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "customSql": { | |
| "type": "string" | |
| }, | |
| "useInSearch": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "fullTextResultId": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "object" | |
| }, | |
| "customParameterValues": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/MetadataValueCustomParameterValue" | |
| } | |
| } | |
| } | |
| }, | |
| "ProcessModelPackageItem": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "packageItemName": { | |
| "type": "string" | |
| }, | |
| "required": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "packageItemType": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "processModel": { | |
| "$ref": "#/definitions/ProcessModel" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validateName": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validateNamePackage": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "DocumentSecurityDTO": { | |
| "type": "object", | |
| "properties": { | |
| "filterDtos": { | |
| "type": "array", | |
| "description": "The filter security configuration for this security permission.", | |
| "items": { | |
| "$ref": "#/definitions/SecurityFilterDTO" | |
| } | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "The unique identifier for this security permission." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "permissionType": { | |
| "type": "string", | |
| "description": "The type of security permission.", | |
| "enum": [ | |
| "LIST", | |
| "VIEW", | |
| "DELETE", | |
| "UPDATE", | |
| "EDIT", | |
| "OVERRIDE_REDACTIONS", | |
| "VIEW_MARKUP" | |
| ] | |
| } | |
| }, | |
| "description": "An object representing one specific security permission for a document type and group." | |
| }, | |
| "SearchSubSearchWrapperDTO": { | |
| "type": "object", | |
| "properties": { | |
| "subSearchName": { | |
| "type": "string", | |
| "description": "The name of the subsearch." | |
| }, | |
| "resultsRequired": { | |
| "type": "boolean", | |
| "description": "The indication as to whether or not results are required to be returned from this subsearch.", | |
| "default": false | |
| }, | |
| "results": { | |
| "type": "array", | |
| "description": "The array of results returned by the subsearch.", | |
| "items": { | |
| "$ref": "#/definitions/SearchResultRowDTO" | |
| } | |
| } | |
| }, | |
| "description": "The representation of a subsearch for a particular search." | |
| }, | |
| "PrintFaxServerDTO": { | |
| "type": "object", | |
| "required": [ | |
| "isSecureHttp", | |
| "port", | |
| "serverName", | |
| "serverType" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The unique ID of the server." | |
| }, | |
| "serverName": { | |
| "type": "string", | |
| "description": "The physical name or IP address of the server." | |
| }, | |
| "port": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The port number used to access the server." | |
| }, | |
| "isSecureHttp": { | |
| "type": "boolean", | |
| "description": "Whether to access the server over HTTPS.", | |
| "default": false | |
| }, | |
| "serverType": { | |
| "type": "string", | |
| "description": "The server type.", | |
| "enum": [ | |
| "PRINTER", | |
| "FAX" | |
| ] | |
| } | |
| }, | |
| "description": "An object that defines print or fax server." | |
| }, | |
| "EnterpriseSearchConfigDTO": { | |
| "type": "object", | |
| "properties": { | |
| "searchServerURL": { | |
| "type": "string", | |
| "description": "Enterprise search web service URL." | |
| }, | |
| "ocrWebServiceURL": { | |
| "type": "string", | |
| "description": "OCR web service URL." | |
| }, | |
| "highlightShow": { | |
| "type": "boolean", | |
| "description": "This setting controls whether fulltext searches should display hit highlights.", | |
| "default": false | |
| }, | |
| "highlightFragSize": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "This setting controls the baseline number of characters returned in a hit fragment." | |
| }, | |
| "extractionForceMemoryPayload": { | |
| "type": "boolean", | |
| "description": "Set to true if all files should be sent as byte streams.", | |
| "default": false | |
| }, | |
| "extractionUseFastPdf": { | |
| "type": "boolean", | |
| "description": "This setting controls whether fulltext searches should use non-OCR PDF extraction.", | |
| "default": false | |
| }, | |
| "orphanNewestFirst": { | |
| "type": "boolean", | |
| "description": "This system property sets the processing order of orphaned documents.", | |
| "default": false | |
| }, | |
| "orphanWindowSize": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The window size is the number of items returned from the orphan checker process." | |
| } | |
| }, | |
| "description": "Enterprise search configuration." | |
| }, | |
| "SearchTreeFilterDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the tree filter associated with the search." | |
| }, | |
| "searchId": { | |
| "type": "string", | |
| "description": "The ID of the search." | |
| }, | |
| "attributeType": { | |
| "type": "string", | |
| "description": "The type of the tree filter attribute, describing what piece of data to which this tree filter is associated.", | |
| "enum": [ | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "FULL_TEXT", | |
| "DIARY", | |
| "METADATA", | |
| "OTHER", | |
| "STORED_PROC_PARAM", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES", | |
| "FILE_TYPE", | |
| "HIDDEN", | |
| "HIDDEN_DATE", | |
| "HIDDEN_INTEGER", | |
| "HIDDEN_DECIMAL" | |
| ] | |
| }, | |
| "attributeName": { | |
| "type": "string", | |
| "description": "The name of the attribute associated to this tree filter." | |
| }, | |
| "metadata": { | |
| "description": "The metadata object associated to this tree filter. This will be NULL if the filter is associated to a non-metadata piece of data.", | |
| "$ref": "#/definitions/MetadataDTO" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal of this filter with respect to other filters in the search." | |
| }, | |
| "sortOrder": { | |
| "type": "string", | |
| "description": "The sort order associated with this tree filter.", | |
| "enum": [ | |
| "ASC", | |
| "DESC", | |
| "CUSTOM" | |
| ] | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The indication as to whether or not to delete this tree filter from the search.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The representation of the tree filter to associate with the search." | |
| }, | |
| "SearchResultColumnDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The unique identifier of the search result column" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The indication of the intent to delete the search result column.", | |
| "default": false | |
| }, | |
| "attributeId": { | |
| "type": "string", | |
| "description": "The unique identifier of the attribute that is associated with the search result column" | |
| }, | |
| "attributeName": { | |
| "type": "string", | |
| "description": "The name of thee attribute that is associated with the search result column" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal of the result column in the context of search execution." | |
| }, | |
| "attributeType": { | |
| "type": "string", | |
| "description": "The type of attribute associatd to the search result column.", | |
| "enum": [ | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "FULL_TEXT", | |
| "DIARY", | |
| "METADATA", | |
| "OTHER", | |
| "STORED_PROC_PARAM", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES", | |
| "FILE_TYPE", | |
| "HIDDEN", | |
| "HIDDEN_DATE", | |
| "HIDDEN_INTEGER", | |
| "HIDDEN_DECIMAL" | |
| ] | |
| }, | |
| "searchResultLinkedMetadataDTO": { | |
| "description": "The metadata associatd with the search result linked output column.", | |
| "$ref": "#/definitions/SearchResultLinkedMetadataDTO" | |
| } | |
| }, | |
| "description": "The representation of a search result column." | |
| }, | |
| "DocumentTypeDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "xml": { | |
| "name": "result" | |
| }, | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "TableChartColumnDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the column." | |
| }, | |
| "dataField": { | |
| "type": "string", | |
| "description": "The column data field." | |
| }, | |
| "headerText": { | |
| "type": "string", | |
| "description": "The column header text." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The column ordinal." | |
| }, | |
| "hidden": { | |
| "type": "boolean", | |
| "description": "Whether the column is hidden.", | |
| "default": false | |
| }, | |
| "sortOrdinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The column sort ordinal." | |
| }, | |
| "sortDirection": { | |
| "type": "string", | |
| "description": "The column sort direction.", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The column data type.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "sourceType": { | |
| "type": "string", | |
| "description": "The source data type for the column. I don't think this is used anymore.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "DASHBOARD_INPUT", | |
| "DERIVED_VALUE" | |
| ] | |
| }, | |
| "gridSummaryRowType": { | |
| "type": "string", | |
| "description": "The type of summary data for the column.", | |
| "enum": [ | |
| "NONE", | |
| "SUM", | |
| "COUNT" | |
| ] | |
| }, | |
| "chartDataGridId": { | |
| "type": "string", | |
| "description": "The ID of the table chart that owns this column." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this column should be deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "A column definition for a table chart." | |
| }, | |
| "SearchResultDTO": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/SearchResultRowDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "searchId": { | |
| "type": "string" | |
| }, | |
| "searchType": { | |
| "type": "string", | |
| "enum": [ | |
| "TEMPLATE", | |
| "CATEGORY", | |
| "CHECKLIST", | |
| "STORED_PROCEDURE", | |
| "HSM" | |
| ] | |
| }, | |
| "searchDisplayName": { | |
| "type": "string" | |
| }, | |
| "allowDocCreation": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "fullTextResults": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FullTextDTO" | |
| } | |
| }, | |
| "report": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "searchFormIntegration": { | |
| "$ref": "#/definitions/SearchResultFormDTO" | |
| }, | |
| "columnHeaderDTOs": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchResultColumnHeaderDTO" | |
| } | |
| }, | |
| "subSearchWrapperResultsArray": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchSubSearchWrapperDTO" | |
| } | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "GroupAssignmentDTO": { | |
| "type": "object", | |
| "properties": { | |
| "entityType": { | |
| "type": "string", | |
| "description": "The type of entity.", | |
| "enum": [ | |
| "BATCHES", | |
| "DASHBOARDS", | |
| "EXPORT_PROFILES", | |
| "FAX", | |
| "FORMS", | |
| "JOB_VIEWS", | |
| "PRINTER", | |
| "PROCESS_MODELS", | |
| "SEARCH", | |
| "SECURITY_ACCESS", | |
| "SCAN_PROFILES", | |
| "USERS", | |
| "FEATURE_RIGHTS" | |
| ] | |
| }, | |
| "entityIds": { | |
| "type": "array", | |
| "description": "The entity IDs.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "groups": { | |
| "type": "array", | |
| "description": "The groups.", | |
| "items": { | |
| "$ref": "#/definitions/GroupDTO" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The markedForDelete flag.", | |
| "default": false | |
| } | |
| }, | |
| "description": "An object representing a group assignment." | |
| }, | |
| "EditLockDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "xml": { | |
| "name": "result" | |
| }, | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/EditLockDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "DocumentDTO": { | |
| "type": "object", | |
| "properties": { | |
| "documentTypeId": { | |
| "type": "string" | |
| }, | |
| "documentType": { | |
| "type": "string" | |
| }, | |
| "categoryId": { | |
| "type": "string" | |
| }, | |
| "category": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "indexedBy": { | |
| "type": "string" | |
| }, | |
| "indexedDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "indexed": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "pointer": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "createdBy": { | |
| "type": "string" | |
| }, | |
| "createdByFirstName": { | |
| "type": "string" | |
| }, | |
| "createdByLastName": { | |
| "type": "string" | |
| }, | |
| "createdDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "displayName": { | |
| "type": "string" | |
| }, | |
| "dateDeleted": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "deletedBy": { | |
| "type": "string" | |
| }, | |
| "deletedByFirstName": { | |
| "type": "string", | |
| "description": "The first name of the user that deleted the document." | |
| }, | |
| "deletedByLastName": { | |
| "type": "string", | |
| "description": "The last name of the user that deleted the document." | |
| }, | |
| "fileDefinitionType": { | |
| "type": "string", | |
| "enum": [ | |
| "IN_PLACE", | |
| "POINTER", | |
| "STANDARD", | |
| "FORM", | |
| "EXTERNAL", | |
| "CHECKLIST" | |
| ] | |
| }, | |
| "lastViewedDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "retentionPolicyId": { | |
| "type": "string" | |
| }, | |
| "retentionPolicyName": { | |
| "type": "string" | |
| }, | |
| "retentionPolicyOverridden": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "canEdit": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "canDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "lastModifiedDate": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "entryMethod": { | |
| "type": "string", | |
| "enum": [ | |
| "PRINT_TO", | |
| "SEND_TO", | |
| "SCAN_TO", | |
| "IMPORT", | |
| "SCAN", | |
| "BPM", | |
| "FILE_UPLOAD", | |
| "OFFICE", | |
| "FORM", | |
| "POINTER", | |
| "SAVE_SEARCH", | |
| "EDITING", | |
| "UNKNOWN" | |
| ] | |
| } | |
| } | |
| }, | |
| "RenderDashboardContentDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DashboardChartable object to render." | |
| }, | |
| "layout": { | |
| "description": "The layout position for this chart.", | |
| "$ref": "#/definitions/ChartableLayoutDTO" | |
| } | |
| } | |
| }, | |
| "SearchPromptValueDTO": { | |
| "type": "object", | |
| "required": [ | |
| "attributeName", | |
| "attributeType" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "searchPromptId": { | |
| "type": "string" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "attributeType": { | |
| "type": "string", | |
| "enum": [ | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "FULL_TEXT", | |
| "DIARY", | |
| "METADATA", | |
| "OTHER", | |
| "STORED_PROC_PARAM", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES", | |
| "FILE_TYPE", | |
| "HIDDEN", | |
| "HIDDEN_DATE", | |
| "HIDDEN_INTEGER", | |
| "HIDDEN_DECIMAL" | |
| ] | |
| }, | |
| "attributeName": { | |
| "type": "string" | |
| }, | |
| "metadataType": { | |
| "type": "string", | |
| "enum": [ | |
| "DATE", | |
| "INTEGER", | |
| "DECIMAL", | |
| "STRING_VARIABLE" | |
| ] | |
| }, | |
| "dateValue": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "decimalValue": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "numericValue": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "comparatorType": { | |
| "type": "string", | |
| "enum": [ | |
| "EQUALS", | |
| "NOT_EQUALS", | |
| "GREATER_THAN", | |
| "LESS_THAN", | |
| "GREATER_THAN_EQUALS", | |
| "LESS_THAN_EQUALS", | |
| "CONTAINS", | |
| "NOT_CONTAINS", | |
| "IN" | |
| ] | |
| }, | |
| "connectiveType": { | |
| "type": "string", | |
| "enum": [ | |
| "AND", | |
| "OR" | |
| ] | |
| }, | |
| "strValue": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "SearchChecklistInsSubSearchDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The unique identifier of the search checklist instance subsearch." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the search checklist instance subsearch." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal of the search checklist instance subsearch." | |
| }, | |
| "searchCheckListInstanceId": { | |
| "type": "string", | |
| "description": "The unique indicator of the search checklist instance to which the subsearch is associated." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The indication of the intent to delete the checklist instance subsearch.", | |
| "default": false | |
| }, | |
| "required": { | |
| "type": "boolean", | |
| "description": "The flag indicating that results are required of this search checklist instance subsearch.", | |
| "default": false | |
| }, | |
| "searchChecklistParameters": { | |
| "type": "array", | |
| "description": "The parameters associated to the search checklist instance subsearch.", | |
| "items": { | |
| "$ref": "#/definitions/SearchChecklistParameterDTO" | |
| } | |
| } | |
| }, | |
| "description": "The representation of the SearchChecklistInstanceSubSearch domain object. Note that this object works with the composition context of a Search dto." | |
| }, | |
| "ServiceInfoDTO": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "operations": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/OperationInfoDTO" | |
| } | |
| } | |
| } | |
| }, | |
| "CompleteTaskWrapperDTO": { | |
| "type": "object", | |
| "properties": { | |
| "taskId": { | |
| "type": "string" | |
| }, | |
| "runXml": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "DatasourceResult": { | |
| "type": "object", | |
| "properties": { | |
| "targetName": { | |
| "type": "string" | |
| }, | |
| "results": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DatasourceResultDTO" | |
| } | |
| } | |
| } | |
| }, | |
| "DrillDownDashboardInputDTO": { | |
| "type": "object", | |
| "required": [ | |
| "dashboardInputId" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the item." | |
| }, | |
| "drillDownId": { | |
| "type": "string", | |
| "description": "The ID of the drill down that owns this input." | |
| }, | |
| "dashboardInputId": { | |
| "type": "string", | |
| "description": "The ID of the target dashboard input." | |
| }, | |
| "dashboardInputName": { | |
| "type": "string", | |
| "description": "The name of the target dashboard input." | |
| }, | |
| "dashboardInputValue": { | |
| "type": "string", | |
| "description": "The default value of the target dashboard input." | |
| }, | |
| "inputType": { | |
| "type": "string", | |
| "description": "The type of input given to the target dashboard input.", | |
| "enum": [ | |
| "DASHBOARD_INPUT", | |
| "PARENT_INPUT", | |
| "PARENT_OUTPUT", | |
| "DEFAULT_VALUE" | |
| ] | |
| }, | |
| "inputDashboardInputId": { | |
| "type": "string", | |
| "description": "The ID of the dashboard input to send as the value for the mapping, set only when inputType is DASHBOARD_INPUT" | |
| }, | |
| "inputDashboardInputName": { | |
| "type": "string", | |
| "description": "The name of the dashboard input to send as the value for the mapping, set only when inputType is DASHBOARD_INPUT." | |
| }, | |
| "parentDrillDownChartInputId": { | |
| "type": "string", | |
| "description": "The ID of the parent input to send as the value for the mapping, set only when inputType is PARENT_INPUT." | |
| }, | |
| "parentDrillDownChartInputName": { | |
| "type": "string", | |
| "description": "The name of the parent input to send as the value for the mapping, set only when inputType is PARENT_INPUT." | |
| }, | |
| "parentOutput": { | |
| "type": "string", | |
| "description": "The type of parent output to send as the value for the mapping, set only when inputType is PARENT_OUTPUT.", | |
| "enum": [ | |
| "X_VALUE", | |
| "Y_VALUE", | |
| "R_VALUE", | |
| "SERIES_NAME", | |
| "TEXT_LABEL", | |
| "TEXT_VALUE", | |
| "CELL_VALUE", | |
| "COLUMN_HEADER", | |
| "NAMED_COLUMN_VALUE" | |
| ] | |
| }, | |
| "tableColumnName": { | |
| "type": "string", | |
| "description": "The name of the table column to send as the value for the mapping, set only when inputType is PARENT_OUTPUT and parentOutput is NAMED_COLUMN_VALUE." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "An input mapping for a drill down to a dashboard." | |
| }, | |
| "DocumentTypeMetadataCollectionDTO": { | |
| "type": "object", | |
| "properties": { | |
| "docTypeMetadataDtos": { | |
| "type": "array", | |
| "description": "The ID of the document type metadata.", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeMetadataDTO" | |
| } | |
| }, | |
| "adminDocsTypesFlag": { | |
| "type": "boolean", | |
| "description": "The flag indicating whether or not the save should perform additional administration functions on the documents and metadata if applicable. This may be expensive in terms of time so treat with caution.", | |
| "default": false | |
| }, | |
| "includeDocTypeMetadataFlag": { | |
| "type": "boolean", | |
| "description": "The flag indicating that document type to metadata relationship should be acted upon during any CRUD operations.", | |
| "default": false | |
| }, | |
| "includeIndexingConfigurationFlag": { | |
| "type": "boolean", | |
| "description": "The flag indicating that indexing configuration should be acted upon during any CRUD operations.", | |
| "default": false | |
| } | |
| }, | |
| "description": "An object representing the collection of document type to metadata associations." | |
| }, | |
| "GroupFeatureRightDTO": { | |
| "type": "object", | |
| "properties": { | |
| "classificationId": { | |
| "type": "string", | |
| "description": "The permission classification ID." | |
| }, | |
| "classificationName": { | |
| "type": "string", | |
| "description": "The classification name." | |
| }, | |
| "featureRightId": { | |
| "type": "string", | |
| "description": "The feature right ID." | |
| }, | |
| "featureRightName": { | |
| "type": "string", | |
| "description": "The feature right name." | |
| }, | |
| "featureRightDescription": { | |
| "type": "string", | |
| "description": "The feature right description." | |
| }, | |
| "permissionKey": { | |
| "type": "string", | |
| "description": "The permission key." | |
| }, | |
| "groupId": { | |
| "type": "string", | |
| "description": "The group ID." | |
| }, | |
| "groupName": { | |
| "type": "string", | |
| "description": "The group name." | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "The ID." | |
| }, | |
| "assigned": { | |
| "type": "boolean", | |
| "description": "Whether the group is assigned this right. Setting to false will remove the feature right.", | |
| "default": false | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "A single feature right assigned to a group." | |
| }, | |
| "DataFlavor": { | |
| "type": "object", | |
| "properties": { | |
| "mimeType": { | |
| "type": "string" | |
| }, | |
| "humanPresentableName": { | |
| "type": "string" | |
| }, | |
| "primaryType": { | |
| "type": "string" | |
| }, | |
| "mimeTypeSerializedObject": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "defaultRepresentationClassAsString": { | |
| "type": "string" | |
| }, | |
| "representationClassInputStream": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "representationClassReader": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "representationClassCharBuffer": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "representationClassByteBuffer": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "representationClassSerializable": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "representationClassRemote": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "flavorSerializedObjectType": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "flavorRemoteObjectType": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "flavorJavaFileListType": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "flavorTextType": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "subType": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "FormActionPropertyDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "propertyName": { | |
| "type": "string" | |
| }, | |
| "propertyValue": { | |
| "type": "string" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "ChartableLayoutDTO": { | |
| "type": "object", | |
| "properties": { | |
| "top": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The top position in percentage." | |
| }, | |
| "left": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The left position in percentage." | |
| }, | |
| "width": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The width in percentage." | |
| }, | |
| "height": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The height in percentage." | |
| } | |
| }, | |
| "description": "An object that defines the layout of a chart on a dashboard." | |
| }, | |
| "ProcessModelPackageItemDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "packageItemName": { | |
| "type": "string" | |
| }, | |
| "required": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "packageItemType": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "SearchChecklistSubSearch": { | |
| "type": "object", | |
| "required": [ | |
| "ordinal", | |
| "required", | |
| "search" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "search": { | |
| "$ref": "#/definitions/Search" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "required": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "searchParameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SearchSubSearchParameter" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "SearchParameter": { | |
| "type": "object", | |
| "required": [ | |
| "attributeName", | |
| "attributeType", | |
| "comparatorType", | |
| "ordinal", | |
| "search", | |
| "sortOrder" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "attributeType": { | |
| "type": "string", | |
| "enum": [ | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "FULL_TEXT", | |
| "DIARY", | |
| "METADATA", | |
| "OTHER", | |
| "STORED_PROC_PARAM", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES", | |
| "FILE_TYPE", | |
| "HIDDEN", | |
| "HIDDEN_DATE", | |
| "HIDDEN_INTEGER", | |
| "HIDDEN_DECIMAL" | |
| ] | |
| }, | |
| "attributeName": { | |
| "type": "string" | |
| }, | |
| "search": { | |
| "$ref": "#/definitions/Search" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Metadata" | |
| }, | |
| "sortOrder": { | |
| "type": "string", | |
| "enum": [ | |
| "ASC", | |
| "DESC", | |
| "CUSTOM" | |
| ] | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "PROMPTED", | |
| "STATIC", | |
| "MACRO", | |
| "CUSTOM" | |
| ] | |
| }, | |
| "connectiveType": { | |
| "type": "string", | |
| "enum": [ | |
| "AND", | |
| "OR" | |
| ] | |
| }, | |
| "comparatorType": { | |
| "type": "string", | |
| "enum": [ | |
| "EQUALS", | |
| "NOT_EQUALS", | |
| "GREATER_THAN", | |
| "LESS_THAN", | |
| "GREATER_THAN_EQUALS", | |
| "LESS_THAN_EQUALS", | |
| "CONTAINS", | |
| "NOT_CONTAINS", | |
| "IN" | |
| ] | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "searchPrompt": { | |
| "$ref": "#/definitions/SearchPrompt" | |
| }, | |
| "openingParen": { | |
| "type": "string" | |
| }, | |
| "closingParen": { | |
| "type": "string" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "customReferences": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "validateContains": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "RepositoryDTO": { | |
| "type": "object", | |
| "properties": { | |
| "description": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "path": { | |
| "type": "string" | |
| }, | |
| "repositoryType": { | |
| "type": "string", | |
| "enum": [ | |
| "MOUNT_POINT", | |
| "PLUGIN" | |
| ] | |
| }, | |
| "upload": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "isRenderRepository": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "isRecordsRepository": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "writeable": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "ignorePathValidation": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "totalSpace": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "freeSpace": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| }, | |
| "HsmScheduledTimeDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the HSM scheduled time." | |
| }, | |
| "startTime": { | |
| "type": "string", | |
| "description": "The start time of the HSM scheduled time." | |
| }, | |
| "duration": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The duration of the HSM scheduled time." | |
| }, | |
| "weekday": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The week day the HSM scheduled time." | |
| }, | |
| "weekdayOccurrence": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The week day occurrence of the HSM scheduled time." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal of the HSM scheduled time." | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Get the deleted flag of the HSM scheduled time.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The HSM policys scheduled time." | |
| }, | |
| "RepositoryStorageOptionDTO": { | |
| "type": "object", | |
| "properties": { | |
| "storageType": { | |
| "type": "string", | |
| "enum": [ | |
| "LEVEL_ONE", | |
| "LEVEL_TWO", | |
| "LEVEL_THREE" | |
| ] | |
| } | |
| } | |
| }, | |
| "FormDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "xml": { | |
| "name": "result" | |
| }, | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/FormDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "GroupDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "xml": { | |
| "name": "result" | |
| }, | |
| "description": "A page of group search results.", | |
| "items": { | |
| "$ref": "#/definitions/GroupDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged search result for groups." | |
| }, | |
| "WindowSettingDTO": { | |
| "type": "object", | |
| "properties": { | |
| "cx": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "cy": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "height": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "parentWindow": { | |
| "type": "string" | |
| }, | |
| "windowGroup": { | |
| "type": "string" | |
| }, | |
| "percentCX": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "percentCY": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "percentX": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "percentY": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "scaleX": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "scaleY": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "width": { | |
| "type": "number", | |
| "format": "float" | |
| }, | |
| "windowName": { | |
| "type": "string" | |
| }, | |
| "windowPosition": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "windowState": { | |
| "type": "string", | |
| "enum": [ | |
| "MAXIMIZE", | |
| "MINIMIZE", | |
| "NORMAL" | |
| ] | |
| }, | |
| "showingMenuBar": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "x": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "y": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "DocumentPermissionTypeDTO": { | |
| "type": "object", | |
| "properties": { | |
| "label": { | |
| "type": "string", | |
| "description": "A localized display value for the permission type." | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "The permission type value.", | |
| "enum": [ | |
| "LIST", | |
| "VIEW", | |
| "DELETE", | |
| "UPDATE", | |
| "EDIT", | |
| "OVERRIDE_REDACTIONS", | |
| "VIEW_MARKUP" | |
| ] | |
| } | |
| }, | |
| "description": "A document permission type." | |
| }, | |
| "DocumentTypeCriteria": { | |
| "type": "object", | |
| "properties": { | |
| "categoryId": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "categoryName": { | |
| "type": "string" | |
| }, | |
| "ids": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "excludeNames": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "sort": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Sort" | |
| } | |
| }, | |
| "statuses": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "INTERNAL", | |
| "STANDARD", | |
| "DELETED" | |
| ] | |
| } | |
| }, | |
| "groupId": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "FormInstanceDataDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "formInstanceId": { | |
| "type": "string" | |
| }, | |
| "formName": { | |
| "type": "string" | |
| }, | |
| "formControlId": { | |
| "type": "string" | |
| }, | |
| "formControlName": { | |
| "type": "string" | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "dateValue": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "decimalValue": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "integerValue": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "stringValue": { | |
| "type": "string" | |
| }, | |
| "booleanValue": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "value": { | |
| "type": "object" | |
| }, | |
| "arrayType": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "SearchTreeFilterExecutionDTO": { | |
| "type": "object", | |
| "properties": { | |
| "searchTreeFilterId": { | |
| "type": "string", | |
| "description": "The ID of the selected level associated with the tree." | |
| }, | |
| "dateValue": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "The date selected from the tree." | |
| }, | |
| "decimalValue": { | |
| "type": "number", | |
| "format": "double", | |
| "description": "The decimal value selected from the tree." | |
| }, | |
| "numericValue": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The numeric integer value selected from the tree." | |
| }, | |
| "strValue": { | |
| "type": "string", | |
| "description": "The string value selected from the tree." | |
| }, | |
| "documentCount": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The document count associated with the specific level of the tree." | |
| }, | |
| "attributeType": { | |
| "type": "string", | |
| "description": "The attribute type of the specific level of the tree.", | |
| "enum": [ | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "FULL_TEXT", | |
| "DIARY", | |
| "METADATA", | |
| "OTHER", | |
| "STORED_PROC_PARAM", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES", | |
| "FILE_TYPE", | |
| "HIDDEN", | |
| "HIDDEN_DATE", | |
| "HIDDEN_INTEGER", | |
| "HIDDEN_DECIMAL" | |
| ] | |
| }, | |
| "attributeName": { | |
| "type": "string" | |
| }, | |
| "metadata": { | |
| "description": "The metadata associated to the level of the tree.", | |
| "$ref": "#/definitions/MetadataDTO" | |
| }, | |
| "includeInCriteriaFlag": { | |
| "type": "boolean", | |
| "description": "The indication to use the selected tree filter level in the execution of the search.", | |
| "default": false | |
| }, | |
| "isLastLevelFlag": { | |
| "type": "boolean", | |
| "description": "The indication that the selected level is the last level of the tree.", | |
| "default": false | |
| }, | |
| "label": { | |
| "type": "string", | |
| "description": "The label associated to the level of the tree." | |
| }, | |
| "sortOrder": { | |
| "type": "string", | |
| "description": "The sort associated with the tree.", | |
| "enum": [ | |
| "ASC", | |
| "DESC", | |
| "CUSTOM" | |
| ] | |
| } | |
| }, | |
| "description": "An object representing the parameters and values to use during the execution of tree filters associated with the search." | |
| }, | |
| "DashboardInputDTO": { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "discriminator": "_class", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DashboardInput." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The input name, must be unique per dashboard." | |
| }, | |
| "value": { | |
| "type": "object" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of input.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "DASHBOARD_PROMPT" | |
| ] | |
| }, | |
| "dashboardId": { | |
| "type": "string", | |
| "description": "The ID of the dashboard that owns this input." | |
| }, | |
| "dashboardName": { | |
| "type": "string", | |
| "description": "The name of the dashboard that owns this input." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The ID of the datasource used by this input." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "The name of the datasource used by this input." | |
| }, | |
| "datasourceResults": { | |
| "type": "array", | |
| "description": "The results from executing the datasource.", | |
| "items": { | |
| "$ref": "#/definitions/DataValue" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "responsibilityMapping": { | |
| "type": "array", | |
| "description": "The responsibility mapping for executing dependent inputs.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "dashboardInputDatasourceInputs": { | |
| "type": "array", | |
| "description": "The inputs needed for the datasource for this input.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardInputDatasourceInputDTO" | |
| } | |
| } | |
| }, | |
| "description": "An input to a dashboard." | |
| }, | |
| "FormControlPropertyDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "propertyName": { | |
| "type": "string" | |
| }, | |
| "propertyValue": { | |
| "type": "string" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "DeviceDTO": { | |
| "type": "object", | |
| "required": [ | |
| "alias", | |
| "deviceIdentifier", | |
| "deviceType" | |
| ], | |
| "properties": { | |
| "deviceIdentifier": { | |
| "type": "string", | |
| "description": "The device unique identifier at the OS level." | |
| }, | |
| "alias": { | |
| "type": "string", | |
| "description": "The user-friendly name of the device." | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "The unique ID of the device." | |
| }, | |
| "serverDto": { | |
| "description": "The full DTO for the server where this device resides.", | |
| "$ref": "#/definitions/PrintFaxServerDTO" | |
| }, | |
| "operational": { | |
| "type": "boolean", | |
| "description": "Whether the device is currently operational.", | |
| "default": false | |
| }, | |
| "deviceType": { | |
| "type": "string", | |
| "description": "The type of device.", | |
| "enum": [ | |
| "PRINTER", | |
| "FAX" | |
| ] | |
| }, | |
| "properties": { | |
| "type": "array", | |
| "description": "The names of the properties supported by the device.", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "PRINT_PRINTER_NAME", | |
| "PRINT_DUPLEX", | |
| "PRINT_TUMBLE", | |
| "PRINT_LANDSCAPE", | |
| "PRINT_PORTRAIT", | |
| "PRINT_NUMBER_OF_COPIES", | |
| "PRINT_COLOR", | |
| "PRINT_BLACK_AND_WHITE", | |
| "PRINT_UNCOLLATED", | |
| "PRINT_COLLATED", | |
| "PRINT_JOB_SHEET", | |
| "PRINT_PAGE_RANGE", | |
| "FAX_FAX_SERVICE_NAME", | |
| "FAX_FAX_RECIPIENT_NUMBER", | |
| "FAX_TO_NAME", | |
| "FAX_FROM_NAME" | |
| ] | |
| } | |
| }, | |
| "assignedGroups": { | |
| "type": "array", | |
| "description": "The DocFinity Groups that are assigned access to this device.", | |
| "items": { | |
| "$ref": "#/definitions/DeviceGroupDTO" | |
| } | |
| }, | |
| "deviceProperties": { | |
| "type": "array", | |
| "description": "The configured properties for the device.", | |
| "items": { | |
| "$ref": "#/definitions/DevicePropertyDTO" | |
| } | |
| } | |
| }, | |
| "description": "An object that defines a print or fax device." | |
| }, | |
| "DatasourceRequiredDashboardPromptDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/DashboardPromptDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DashboardInput." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The input name, must be unique per dashboard." | |
| }, | |
| "value": { | |
| "type": "object" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of input.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "DASHBOARD_PROMPT" | |
| ] | |
| }, | |
| "dashboardId": { | |
| "type": "string", | |
| "description": "The ID of the dashboard that owns this input." | |
| }, | |
| "dashboardName": { | |
| "type": "string", | |
| "description": "The name of the dashboard that owns this input." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The ID of the datasource used by this input." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "The name of the datasource used by this input." | |
| }, | |
| "datasourceResults": { | |
| "type": "array", | |
| "description": "The results from executing the datasource.", | |
| "items": { | |
| "$ref": "#/definitions/DataValue" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "responsibilityMapping": { | |
| "type": "array", | |
| "description": "The responsibility mapping for executing dependent inputs.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "dashboardInputDatasourceInputs": { | |
| "type": "array", | |
| "description": "The inputs needed for the datasource for this input.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardInputDatasourceInputDTO" | |
| } | |
| }, | |
| "label": { | |
| "type": "string", | |
| "description": "The prompt label." | |
| }, | |
| "promptType": { | |
| "type": "string", | |
| "description": "The prompt type.", | |
| "enum": [ | |
| "SWITCH", | |
| "DATE", | |
| "TEXT", | |
| "DROP_DOWN_LIST" | |
| ] | |
| }, | |
| "required": { | |
| "type": "boolean", | |
| "description": "Whether the input is required.", | |
| "default": false | |
| }, | |
| "defaultValueType": { | |
| "type": "string", | |
| "description": "The default value type.", | |
| "enum": [ | |
| "STATIC", | |
| "MACRO", | |
| "DATASOURCE", | |
| "FIRST", | |
| "SPECIFIC", | |
| "PROMPT" | |
| ] | |
| } | |
| }, | |
| "description": "A user prompt input that allows a datasource and is required." | |
| } | |
| ] | |
| }, | |
| "FormControlDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "Gets the id attribute of the FormControlDTO object." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Gets the name attribute of the FormControlDTO object." | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "Gets the type attribute of the FormControlDTO object." | |
| }, | |
| "inputFlag": { | |
| "type": "boolean", | |
| "description": "Gets the flag indicating if this form control supports user input.", | |
| "default": false | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "Gets the dataType attribute of the FormControlDTO object.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "controlSteps": { | |
| "type": "array", | |
| "description": "Gets the controlSteps attribute of the FormControlDTO object.", | |
| "items": { | |
| "$ref": "#/definitions/FormControlStepDTO" | |
| } | |
| }, | |
| "defaultData": { | |
| "description": "Gets the defaultData attribute of the FormControlDTO object.", | |
| "$ref": "#/definitions/DatasourceResult" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "description": "Gets the deleted attribute of the FormControlDTO object.", | |
| "default": false | |
| } | |
| }, | |
| "description": "DTO object for a FormControl." | |
| }, | |
| "UserDTO": { | |
| "type": "object", | |
| "properties": { | |
| "emailAddress": { | |
| "type": "string" | |
| }, | |
| "externallyManaged": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "firstName": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "lastName": { | |
| "type": "string" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "middleName": { | |
| "type": "string" | |
| }, | |
| "passwordExpirationDays": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "phoneNumber": { | |
| "type": "string" | |
| }, | |
| "userName": { | |
| "type": "string" | |
| }, | |
| "userStatus": { | |
| "type": "string", | |
| "enum": [ | |
| "ACTIVE", | |
| "INACTIVE", | |
| "DELETED" | |
| ] | |
| }, | |
| "userType": { | |
| "type": "string", | |
| "enum": [ | |
| "INTERNAL", | |
| "EXTERNAL", | |
| "SYSTEM" | |
| ] | |
| }, | |
| "passwordForceChange": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "passwordType": { | |
| "type": "string", | |
| "enum": [ | |
| "GENERATED", | |
| "MANUAL" | |
| ] | |
| }, | |
| "emailUser": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "externalProviderId": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "externalReference": { | |
| "type": "string" | |
| }, | |
| "associationLevel": { | |
| "type": "string", | |
| "enum": [ | |
| "ALL", | |
| "PARTIAL", | |
| "NONE" | |
| ] | |
| }, | |
| "modifiedTimestamp": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| }, | |
| "SearchResultColumnHeaderDTO": { | |
| "type": "object", | |
| "properties": { | |
| "columnName": { | |
| "type": "string" | |
| }, | |
| "attributeType": { | |
| "type": "string", | |
| "enum": [ | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "FULL_TEXT", | |
| "DIARY", | |
| "METADATA", | |
| "OTHER", | |
| "STORED_PROC_PARAM", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES", | |
| "FILE_TYPE", | |
| "HIDDEN", | |
| "HIDDEN_DATE", | |
| "HIDDEN_INTEGER", | |
| "HIDDEN_DECIMAL" | |
| ] | |
| }, | |
| "attributeName": { | |
| "type": "string" | |
| }, | |
| "attributeId": { | |
| "type": "string" | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "enum": [ | |
| "DATE", | |
| "INTEGER", | |
| "DECIMAL", | |
| "STRING_VARIABLE" | |
| ] | |
| }, | |
| "columnType": { | |
| "type": "string", | |
| "enum": [ | |
| "METADATA", | |
| "LINKED_OUTPUT_COLUMN", | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES" | |
| ] | |
| } | |
| } | |
| }, | |
| "DeviceGroup": { | |
| "type": "object", | |
| "required": [ | |
| "group", | |
| "printFaxDevice" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "printFaxDevice": { | |
| "$ref": "#/definitions/PrintFaxDevice" | |
| }, | |
| "group": { | |
| "$ref": "#/definitions/Group" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "FormControlValidator": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "formControlStep": { | |
| "$ref": "#/definitions/FormControlStep" | |
| }, | |
| "validator": { | |
| "$ref": "#/definitions/Validator" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "ScanSettingGroup": { | |
| "type": "object", | |
| "required": [ | |
| "group", | |
| "scanSetting" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "group": { | |
| "$ref": "#/definitions/Group" | |
| }, | |
| "scanSetting": { | |
| "$ref": "#/definitions/ScanSetting" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "GenericResult": { | |
| "type": "object", | |
| "description": "A generic result object that can be used to return instances of List and Map." | |
| }, | |
| "LegalHoldCase": { | |
| "type": "object", | |
| "required": [ | |
| "custodians", | |
| "dateOpened", | |
| "description", | |
| "name", | |
| "openedBy" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "dateOpened": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "openedBy": { | |
| "$ref": "#/definitions/User" | |
| }, | |
| "dateClosed": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "closedBy": { | |
| "$ref": "#/definitions/User" | |
| }, | |
| "custodians": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/LegalHoldCustodian" | |
| } | |
| }, | |
| "heldRecords": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/LegalHold" | |
| } | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "SynchronizationResultDTO2": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "Unique ID." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The entity name associated with the object." | |
| }, | |
| "status": { | |
| "type": "string", | |
| "description": "The user status associated with the object.", | |
| "enum": [ | |
| "ACTIVE", | |
| "INACTIVE", | |
| "DELETED" | |
| ] | |
| }, | |
| "lastSyncAction": { | |
| "type": "string", | |
| "description": "The last action performed during synchronization.", | |
| "enum": [ | |
| "ADDED", | |
| "MODIFIED", | |
| "DELETED", | |
| "ERROR" | |
| ] | |
| }, | |
| "modifiedTimeStamp": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "The modified time stamp associated with the user." | |
| }, | |
| "entityType": { | |
| "type": "string", | |
| "description": "Describes the type of LDAP object that was synced.", | |
| "enum": [ | |
| "USER", | |
| "GROUP", | |
| "SYSTEM" | |
| ] | |
| } | |
| }, | |
| "description": "DTO describing the results of synchronization between an Ldap and DocFinity entity." | |
| }, | |
| "SearchDocIndexingMetadata": { | |
| "type": "object", | |
| "required": [ | |
| "metadata", | |
| "valueType" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Metadata" | |
| }, | |
| "valueType": { | |
| "type": "string", | |
| "enum": [ | |
| "VARIABLE", | |
| "STATIC", | |
| "DATASOURCE" | |
| ] | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "searchDocIndexing": { | |
| "$ref": "#/definitions/SearchDocIndexing" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "LicensePoolDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "userId": { | |
| "type": "string" | |
| }, | |
| "username": { | |
| "type": "string" | |
| }, | |
| "firstName": { | |
| "type": "string" | |
| }, | |
| "lastName": { | |
| "type": "string" | |
| }, | |
| "licensePoolUserId": { | |
| "type": "string" | |
| }, | |
| "groupId": { | |
| "type": "string" | |
| }, | |
| "licensePoolGroupId": { | |
| "type": "string" | |
| }, | |
| "allocatedLicenses": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "isGroupPool": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "numberOfUsersInGroup": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "Filters": { | |
| "type": "object", | |
| "properties": { | |
| "logic": { | |
| "type": "string", | |
| "description": "The conjunction logic.", | |
| "enum": [ | |
| "AND", | |
| "OR" | |
| ] | |
| }, | |
| "filters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Filter" | |
| } | |
| } | |
| }, | |
| "description": "A generic collection of filter objects that can be applied to get requests." | |
| }, | |
| "DocumentTypeProcessModel": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "documentType": { | |
| "$ref": "#/definitions/DocumentType" | |
| }, | |
| "processModel": { | |
| "$ref": "#/definitions/ProcessModel" | |
| }, | |
| "packageItemName": { | |
| "type": "string" | |
| }, | |
| "documentTypeId": { | |
| "type": "string" | |
| }, | |
| "processModelId": { | |
| "type": "string" | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "IndexingValueDTO": { | |
| "type": "object", | |
| "properties": { | |
| "documentTypeId": { | |
| "type": "string" | |
| }, | |
| "documentId": { | |
| "type": "string" | |
| }, | |
| "metadataId": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "DATE", | |
| "INTEGER", | |
| "DECIMAL", | |
| "STRING_VARIABLE" | |
| ] | |
| }, | |
| "metadataValueId": { | |
| "type": "string" | |
| }, | |
| "metadataName": { | |
| "type": "string" | |
| }, | |
| "document": { | |
| "$ref": "#/definitions/Document" | |
| }, | |
| "overrideError": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "index": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "parameterName": { | |
| "type": "string" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "runDatasource": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "SearchDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the search." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The indication of the intent to delete the search.", | |
| "default": false | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the search." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "The description of the search." | |
| }, | |
| "formDesignName": { | |
| "type": "string", | |
| "description": "The name of the form associated to the search." | |
| }, | |
| "formEditable": { | |
| "type": "boolean", | |
| "description": "The indication that the associated form of the search can be edited.", | |
| "default": false | |
| }, | |
| "searchGroups": { | |
| "type": "array", | |
| "description": "The array of groups associated to the search.", | |
| "items": { | |
| "$ref": "#/definitions/SearchGroupDTO" | |
| } | |
| }, | |
| "searchParameters": { | |
| "type": "array", | |
| "description": "The array of parameters associated to the search.", | |
| "items": { | |
| "$ref": "#/definitions/SearchParameterDTO" | |
| } | |
| }, | |
| "searchSubSearches": { | |
| "type": "array", | |
| "description": "The array of checklist sub-searches associated to the search.", | |
| "items": { | |
| "$ref": "#/definitions/SearchChecklistSubSearchDTO" | |
| } | |
| }, | |
| "searchChecklistInsSubSearches": { | |
| "type": "array", | |
| "description": "The array of sub-searches of the checklist instance associated to the search.", | |
| "items": { | |
| "$ref": "#/definitions/SearchChecklistInsSubSearchDTO" | |
| } | |
| }, | |
| "searchPrompts": { | |
| "type": "array", | |
| "description": "The array of prompts associated to the search.", | |
| "items": { | |
| "$ref": "#/definitions/SearchPromptDTO" | |
| } | |
| }, | |
| "searchResultColumns": { | |
| "type": "array", | |
| "description": "The array of columns representing the results of the search.", | |
| "items": { | |
| "$ref": "#/definitions/SearchResultColumnDTO" | |
| } | |
| }, | |
| "searchDocIndexing": { | |
| "description": "The representation of the indexing configuration to associated to this search in the instance that a document can be generated.", | |
| "$ref": "#/definitions/SearchDocIndexingDTO" | |
| }, | |
| "searchStoredProcedure": { | |
| "description": "The stored procedure associated to the search.", | |
| "$ref": "#/definitions/SearchStoredProcedureDTO" | |
| }, | |
| "searchType": { | |
| "type": "string", | |
| "description": "The type of the search.", | |
| "enum": [ | |
| "TEMPLATE", | |
| "CATEGORY", | |
| "CHECKLIST", | |
| "STORED_PROCEDURE", | |
| "HSM" | |
| ] | |
| }, | |
| "searchSortOrders": { | |
| "type": "array", | |
| "description": "The array of sorts associated to the search.", | |
| "items": { | |
| "$ref": "#/definitions/SearchSortOrderDTO" | |
| } | |
| }, | |
| "searchFormData": { | |
| "type": "array", | |
| "description": "The array of form data associated to the search.", | |
| "items": { | |
| "$ref": "#/definitions/SearchFormDataDTO" | |
| } | |
| }, | |
| "searchTreeFilters": { | |
| "type": "array", | |
| "description": "The array of tree filters configured to the search.", | |
| "items": { | |
| "$ref": "#/definitions/SearchTreeFilterDTO" | |
| } | |
| }, | |
| "treeFiltersConfigured": { | |
| "type": "boolean", | |
| "description": "The indication that a tree is configured for the search.", | |
| "default": false | |
| }, | |
| "documentsExist": { | |
| "type": "boolean", | |
| "description": "The indication that a document associated to the search exists.", | |
| "default": false | |
| }, | |
| "promptsConfigured": { | |
| "type": "boolean", | |
| "description": "The indication that search prompts are configured for the search.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The representation of a search." | |
| }, | |
| "ValidatorDTO": { | |
| "type": "object", | |
| "properties": { | |
| "configResourcePath": { | |
| "type": "string", | |
| "description": "An object representing the configuration resource path for the validator." | |
| }, | |
| "description": { | |
| "type": "string", | |
| "description": "An object representing the description for the validator." | |
| }, | |
| "displayName": { | |
| "type": "string", | |
| "description": "An object representing the display name th for the validator." | |
| }, | |
| "entryControlResourcePath": { | |
| "type": "string", | |
| "description": "An object representing the entry control resource path for the validator." | |
| }, | |
| "errorLevel": { | |
| "type": "string", | |
| "description": "An object representing the error level of the validator.", | |
| "enum": [ | |
| "ERROR", | |
| "WARNING" | |
| ] | |
| }, | |
| "id": { | |
| "type": "string", | |
| "description": "An object representing the ID of the validator." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "An object representing the name of the validator." | |
| }, | |
| "validatorType": { | |
| "type": "string", | |
| "description": "An object representing the type of validator." | |
| }, | |
| "properties": { | |
| "type": "array", | |
| "description": "An object representing the properties for the validator.", | |
| "items": { | |
| "$ref": "#/definitions/ValidatorPropertyDTO" | |
| } | |
| }, | |
| "parameterNames": { | |
| "type": "array", | |
| "description": "An object representing the parameter names used by the validator.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "metadataTypes": { | |
| "type": "array", | |
| "description": "An object representing the types of metadata used by the validator.", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "DATE", | |
| "INTEGER", | |
| "DECIMAL", | |
| "STRING_VARIABLE" | |
| ] | |
| } | |
| }, | |
| "incompatiblePluginTypes": { | |
| "type": "array", | |
| "description": "An object representing the incompatible plugin types for the validator.", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "description": "An object representing a validator." | |
| }, | |
| "DocfinityTaskDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "processID": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "jobName": { | |
| "type": "string" | |
| }, | |
| "jobId": { | |
| "type": "string" | |
| }, | |
| "desc": { | |
| "type": "string" | |
| }, | |
| "completed": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "required": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "helpDescription": { | |
| "type": "string" | |
| }, | |
| "condition": { | |
| "type": "string" | |
| }, | |
| "conditionPassed": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "redoable": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "taskProperties": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TaskPropertyDTO" | |
| } | |
| }, | |
| "runSwfName": { | |
| "type": "string" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "EntityReferenceDTO": { | |
| "type": "object", | |
| "properties": { | |
| "referenceType": { | |
| "type": "string", | |
| "enum": [ | |
| "CHART", | |
| "DASHBOARD", | |
| "DASHBOARD_DRILLDOWN", | |
| "DATASOURCE", | |
| "DATASTORE", | |
| "DOCUMENT_SECURITY", | |
| "DOCUMENT_TYPE", | |
| "DOCUMENT_TYPE_METADATA", | |
| "FORM", | |
| "FORM_CONTROL", | |
| "IMPORTER", | |
| "JOB_VIEW", | |
| "PROCESS_MODEL", | |
| "RETENTION_POLICY", | |
| "SEARCH", | |
| "VALIDATOR", | |
| "CALCULATED_PROPERTY", | |
| "PROMPT", | |
| "PARAMETER", | |
| "METADATA", | |
| "LINKED_COLUMN" | |
| ] | |
| }, | |
| "localizedReferenceType": { | |
| "type": "string" | |
| }, | |
| "referenceName": { | |
| "type": "string" | |
| }, | |
| "versionNumbers": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| } | |
| }, | |
| "ReportHeaderLinePropertyDTO": { | |
| "type": "object", | |
| "discriminator": "_class", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the property." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name associated with the property." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal associated with the property." | |
| }, | |
| "field": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The field associated with the property." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type associated with the property." | |
| }, | |
| "textCase": { | |
| "type": "string", | |
| "description": "The text case associated with the property." | |
| }, | |
| "trim": { | |
| "type": "boolean", | |
| "description": "Flag indicating the property value needs to be trimmed.", | |
| "default": false | |
| }, | |
| "defaultValue": { | |
| "type": "string", | |
| "description": "The default value of the property." | |
| }, | |
| "format": { | |
| "type": "string", | |
| "description": "The date format associated with the property." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Flag indicating the property is marked for deletion.", | |
| "default": false | |
| }, | |
| "lineNumber": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Numeric indicating header line number." | |
| } | |
| }, | |
| "description": "A report importer header line property." | |
| }, | |
| "RuleSetBatchGroupDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id associated with the ruleset batch group." | |
| }, | |
| "groupId": { | |
| "type": "string", | |
| "description": "The group id associated with the rule set batch group." | |
| }, | |
| "batchGroupName": { | |
| "type": "string", | |
| "description": "The group name associated with the ruleset batch group." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the group, read-only." | |
| }, | |
| "ruleSetId": { | |
| "type": "string", | |
| "description": "The id associated with the rule set." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Flag to indicate the rule set batch group has been deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The batch group associated with the rule set." | |
| }, | |
| "MetadataValueCustomParameterValue": { | |
| "type": "object", | |
| "required": [ | |
| "attributeType" | |
| ], | |
| "properties": { | |
| "promptName": { | |
| "type": "string" | |
| }, | |
| "attributeId": { | |
| "type": "string" | |
| }, | |
| "attributeName": { | |
| "type": "string" | |
| }, | |
| "attributeType": { | |
| "type": "string", | |
| "enum": [ | |
| "CATEGORY", | |
| "DOCUMENT_TYPE", | |
| "FULL_TEXT", | |
| "DIARY", | |
| "METADATA", | |
| "OTHER", | |
| "STORED_PROC_PARAM", | |
| "STORED_PROC_COLUMN", | |
| "DOCUMENT_ATTRIBUTES", | |
| "FILE_ATTRIBUTES", | |
| "DOCUMENT_VARIABLES", | |
| "FILE_TYPE", | |
| "HIDDEN", | |
| "HIDDEN_DATE", | |
| "HIDDEN_INTEGER", | |
| "HIDDEN_DECIMAL" | |
| ] | |
| }, | |
| "metadataType": { | |
| "type": "string", | |
| "enum": [ | |
| "DATE", | |
| "INTEGER", | |
| "DECIMAL", | |
| "STRING_VARIABLE" | |
| ] | |
| }, | |
| "dateValue": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "decimalValue": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "numericValue": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "strValue": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "JobFilterDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id associated with the job filter data." | |
| }, | |
| "value1": { | |
| "type": "string", | |
| "description": "The value1 property associated with the job filter data." | |
| }, | |
| "comparator": { | |
| "type": "string", | |
| "description": "The job filter comparator associated with the job filter data.", | |
| "enum": [ | |
| "EQUALS", | |
| "NOT_EQUALS", | |
| "LESS_THAN", | |
| "LESS_THAN_EQUAL_TO", | |
| "GREATER_THAN", | |
| "GREATER_THAN_EQUAL_TO", | |
| "LIKE", | |
| "NOT_LIKE", | |
| "AND", | |
| "OR" | |
| ] | |
| }, | |
| "value2": { | |
| "type": "string", | |
| "description": "The value2 parameter associated with the job filter data." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type associated with the job filter data.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "filterType": { | |
| "type": "string", | |
| "description": "The filter type associated with the job filter data.", | |
| "enum": [ | |
| "JOB_PROPERTY", | |
| "PROCESS_INSTANCE_VARIABLE", | |
| "PACKAGE_ITEM_PROPERTY", | |
| "PROMPT_RESULT" | |
| ] | |
| }, | |
| "filterValueType": { | |
| "type": "string", | |
| "description": "The filter value type associated with the job filter data.", | |
| "enum": [ | |
| "JOB_PROPERTY", | |
| "PACKAGE_ITEM_PROPERTY", | |
| "PROCESS_INSTANCE_VARIABLE", | |
| "STATIC_VALUE", | |
| "PROMPT_RESULT" | |
| ] | |
| }, | |
| "filterTypeProperty": { | |
| "type": "string", | |
| "description": "The filter property type associated with the job filter data." | |
| }, | |
| "filterValueTypeProperty": { | |
| "type": "string", | |
| "description": "The filter property value type associated with the job filter data." | |
| } | |
| }, | |
| "description": "The job filter configuration data" | |
| }, | |
| "SwitchDashboardPromptDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/DashboardPromptDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DashboardInput." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The input name, must be unique per dashboard." | |
| }, | |
| "value": { | |
| "type": "object" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of input.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "DASHBOARD_PROMPT" | |
| ] | |
| }, | |
| "dashboardId": { | |
| "type": "string", | |
| "description": "The ID of the dashboard that owns this input." | |
| }, | |
| "dashboardName": { | |
| "type": "string", | |
| "description": "The name of the dashboard that owns this input." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The ID of the datasource used by this input." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "The name of the datasource used by this input." | |
| }, | |
| "datasourceResults": { | |
| "type": "array", | |
| "description": "The results from executing the datasource.", | |
| "items": { | |
| "$ref": "#/definitions/DataValue" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "responsibilityMapping": { | |
| "type": "array", | |
| "description": "The responsibility mapping for executing dependent inputs.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "dashboardInputDatasourceInputs": { | |
| "type": "array", | |
| "description": "The inputs needed for the datasource for this input.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardInputDatasourceInputDTO" | |
| } | |
| }, | |
| "label": { | |
| "type": "string", | |
| "description": "The prompt label." | |
| }, | |
| "promptType": { | |
| "type": "string", | |
| "description": "The prompt type.", | |
| "enum": [ | |
| "SWITCH", | |
| "DATE", | |
| "TEXT", | |
| "DROP_DOWN_LIST" | |
| ] | |
| }, | |
| "defaultChecked": { | |
| "type": "boolean", | |
| "description": "Whether the switch is on by default.", | |
| "default": false | |
| }, | |
| "labelTrue": { | |
| "type": "string", | |
| "description": "The label for the true/on option." | |
| }, | |
| "labelFalse": { | |
| "type": "string", | |
| "description": "The label for the false/off option." | |
| } | |
| }, | |
| "description": "A switch prompt." | |
| } | |
| ] | |
| }, | |
| "WsdlServicesDTO": { | |
| "type": "object", | |
| "properties": { | |
| "services": { | |
| "type": "array", | |
| "xml": { | |
| "name": "service" | |
| }, | |
| "items": { | |
| "$ref": "#/definitions/ServiceDTO" | |
| } | |
| } | |
| } | |
| }, | |
| "KeyValuePair": { | |
| "type": "object", | |
| "properties": { | |
| "key": { | |
| "type": "string", | |
| "description": "The name or key of the property." | |
| }, | |
| "value": { | |
| "type": "object", | |
| "description": "The current value of the property in its raw data type." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type of the property.", | |
| "enum": [ | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING" | |
| ] | |
| }, | |
| "dataValue": { | |
| "type": "object" | |
| } | |
| }, | |
| "description": "A simple name-value pair used to pass data in a generic format." | |
| }, | |
| "FormLibraryDTO": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "numInstances": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| }, | |
| "DatasourceIntent": { | |
| "type": "object", | |
| "required": [ | |
| "datasource", | |
| "intent" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "datasource": { | |
| "$ref": "#/definitions/Datasource" | |
| }, | |
| "intent": { | |
| "type": "string", | |
| "enum": [ | |
| "COMPLEX_TABLE", | |
| "SIMPLE" | |
| ] | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "ProcessModelDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "xml": { | |
| "type": "string" | |
| }, | |
| "isLocked": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "lockOwner": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "dateModified": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "ACTIVE", | |
| "INACTIVE", | |
| "INACTIVE_STILL_RUNNING" | |
| ] | |
| }, | |
| "readOnly": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "processModelPackageItems": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ProcessModelPackageItemDTO" | |
| } | |
| }, | |
| "documentTypeProcessModels": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeProcessModelDTO" | |
| } | |
| } | |
| } | |
| }, | |
| "DevicePropertyDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "SearchDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "xml": { | |
| "name": "result" | |
| }, | |
| "description": "The results of the search.", | |
| "items": { | |
| "$ref": "#/definitions/SearchDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A pageable object representing the results of a search." | |
| }, | |
| "SortColumnDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id for the sort column." | |
| }, | |
| "columnVariable": { | |
| "type": "string", | |
| "description": "The column variable information for the sort column." | |
| }, | |
| "columnDisplayValue": { | |
| "type": "string", | |
| "description": "The column display value for the sort column." | |
| }, | |
| "ascending": { | |
| "type": "boolean", | |
| "description": "Ascending flag for the sort column.", | |
| "default": false | |
| }, | |
| "enforce": { | |
| "type": "boolean", | |
| "description": "Enforce flag for the sort column.", | |
| "default": false | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal for the sort column." | |
| } | |
| }, | |
| "description": "The sort column configuration data" | |
| }, | |
| "ParameterDTO": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "dataType": { | |
| "type": "string" | |
| }, | |
| "supportedInputDataType": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "ChartColumnDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the chart column." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The column name from the datasource result." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this column should be deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "A column returned by a datasource that is used in a chart." | |
| }, | |
| "SearchChecklistSubSearchDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The unique identifier of the checklist search subsearch." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name associated to this checklist search subsearch." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal associated to this checklist search subsearch." | |
| }, | |
| "required": { | |
| "type": "boolean", | |
| "description": "The flag indicating that results are required of this checklist search subsearch.", | |
| "default": false | |
| }, | |
| "searchChecklistParameters": { | |
| "type": "array", | |
| "description": "The list of parameters used by the checklist search subsearch.", | |
| "items": { | |
| "$ref": "#/definitions/SearchSubSearchParameterDTO" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "The flag indicating that this checklist search subsearch is to be deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The representation of the SearchChecklistSubSearch domain object. Note that this object works with the composition context of a Search dto. Sub searches are used within searches of type CHECKLIST. Each sub search can be seen as the logic portion of a search, determining which documents are returned. A checklist search is comprised of multiple sub searches, each of which is 'met' when it returns one or more documents that match its' parameters, or criteria." | |
| }, | |
| "DispositionConditionDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timeUnit": { | |
| "type": "string", | |
| "enum": [ | |
| "DAYS", | |
| "WEEKS", | |
| "MONTHS", | |
| "YEARS" | |
| ] | |
| }, | |
| "period": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "target": { | |
| "type": "string", | |
| "enum": [ | |
| "DATE_METADATA", | |
| "DOCUMENT_CREATED_DATE", | |
| "DOCUMENT_INDEXED_DATE", | |
| "DOCUMENT_LAST_VIEWED_DATE", | |
| "FILE_CREATED_DATE" | |
| ] | |
| }, | |
| "metadataId": { | |
| "type": "string" | |
| }, | |
| "metadataName": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "StoredProcedureParameterDTO": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the parameter used by the stored procedure." | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of the parameter used by the stored procedure.Possible values are IN, INOUT, OUT" | |
| }, | |
| "sqlType": { | |
| "type": "string", | |
| "description": "The sql types of the parameter used by the stored procedure. The possible values are The possible sql types are: <p> VARCHAR<br> DATE<br> BOOLEAN<br> LONGVARCHAR<br> CHAR<br> TIME<br> TIMESTAMP<br> DOUBLE<br> FLOAT<br> SMALLINT<br> INTEGER<br> DECIMAL<br> BIGINT<br> NUMERIC<br> TINYINT<br> ARRAY<br> BINARY<br> BIT<br> BLOB<br> CLOB<br> DATALINK<br> DISTINCT<br> JAVA_OBJECT<br> NULL<br> REAL<br> REF<br> STRUCT<br> VARBINARY<br> LONGVARBINARY<br> NUMBER<br> OTHER<p>" | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The corressponding datatype in DocFinity.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| } | |
| }, | |
| "description": "The definition of the paramters used by the stored procedure." | |
| }, | |
| "RuleSetProcessInstanceVariableDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the process instance configuration associated with the rule set." | |
| }, | |
| "variableName": { | |
| "type": "string", | |
| "description": "The variable name of the process instance variable associated with the rule set." | |
| }, | |
| "calculatedProperty": { | |
| "type": "string", | |
| "description": "The calculated property which is associated with the process instance variable configuration in the rule set." | |
| }, | |
| "valueType": { | |
| "type": "string", | |
| "description": "The type of value for the calculated property.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "VARIABLE", | |
| "MIXED" | |
| ] | |
| }, | |
| "defaultValue": { | |
| "type": "string", | |
| "description": "The default value." | |
| }, | |
| "ruleSetId": { | |
| "type": "string", | |
| "description": "The id of the rule set." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Flag to indicate the rule set process instance variable is to be deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The process instance configuration associated with the rule set." | |
| }, | |
| "MixedChartDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/ChartDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "INTERNAL", | |
| "STANDARD" | |
| ] | |
| }, | |
| "isLocked": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "lockOwner": { | |
| "type": "string" | |
| }, | |
| "lockOwnerFirstName": { | |
| "type": "string" | |
| }, | |
| "lockOwnerLastName": { | |
| "type": "string" | |
| }, | |
| "dateModified": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "properties": { | |
| "$ref": "#/definitions/ChartablePropertiesDTO" | |
| }, | |
| "datasourceId": { | |
| "type": "string" | |
| }, | |
| "datasourceName": { | |
| "type": "string" | |
| }, | |
| "datasourceParameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DatasourceArgumentDTO" | |
| } | |
| }, | |
| "refreshInterval": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "isValid": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "variables": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartVariableDTO" | |
| } | |
| }, | |
| "datasourceInputs": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartDatasourceInputDTO" | |
| } | |
| }, | |
| "dashboardCount": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "overrideErrorsOnSave": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "chartType": { | |
| "type": "string", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "labelColumn": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| }, | |
| "seriesColumn": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| }, | |
| "dataColumns": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| } | |
| } | |
| }, | |
| "description": "A mixed chart. Not currently implemented." | |
| } | |
| ] | |
| }, | |
| "CalculatedPropertyDatasourceParameterDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the calculated property datasource parameter." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the calculated property datasource parameter." | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "The value of the calculated property datasource parameter." | |
| }, | |
| "valueType": { | |
| "type": "string", | |
| "description": "The type of value, either static or variable.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "VARIABLE", | |
| "MIXED" | |
| ] | |
| }, | |
| "calculatedPropertyId": { | |
| "type": "string", | |
| "description": "The id of the calculated property the datasource parameter is associated with." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Flag to indicate this property has been deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "The representation of the calculated property datasource associated with the importer." | |
| }, | |
| "Category": { | |
| "type": "object", | |
| "required": [ | |
| "description", | |
| "name", | |
| "status" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "documentTypes": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DocumentType" | |
| } | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "INTERNAL", | |
| "STANDARD", | |
| "DELETED" | |
| ] | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "originalName": { | |
| "type": "string" | |
| }, | |
| "activeDocumentTypes": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/DocumentType" | |
| } | |
| }, | |
| "nameChanged": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "User": { | |
| "type": "object", | |
| "required": [ | |
| "emailAddress", | |
| "firstName", | |
| "lastName", | |
| "middleName", | |
| "userStatus", | |
| "userType", | |
| "username" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "userType": { | |
| "type": "string", | |
| "enum": [ | |
| "INTERNAL", | |
| "EXTERNAL", | |
| "SYSTEM" | |
| ] | |
| }, | |
| "username": { | |
| "type": "string" | |
| }, | |
| "firstName": { | |
| "type": "string" | |
| }, | |
| "middleName": { | |
| "type": "string" | |
| }, | |
| "lastName": { | |
| "type": "string" | |
| }, | |
| "emailAddress": { | |
| "type": "string" | |
| }, | |
| "phoneNumber": { | |
| "type": "string" | |
| }, | |
| "userStatus": { | |
| "type": "string", | |
| "enum": [ | |
| "ACTIVE", | |
| "INACTIVE", | |
| "DELETED" | |
| ] | |
| }, | |
| "memberships": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/GroupMember" | |
| } | |
| }, | |
| "formInstances": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FormInstance" | |
| } | |
| }, | |
| "userViewerSettings": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/UserViewerSetting" | |
| } | |
| }, | |
| "systemMessagePreference": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SystemMessageUserPreference" | |
| } | |
| }, | |
| "legalHoldCustodians": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/LegalHoldCustodian" | |
| } | |
| }, | |
| "retentionPolicyCustodians": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/RetentionPolicyCustodian" | |
| } | |
| }, | |
| "attempts": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": 0 | |
| }, | |
| "lastInvalidAttempt": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "roleActors": { | |
| "type": "array", | |
| "uniqueItems": true, | |
| "items": { | |
| "$ref": "#/definitions/Actor" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "oldUsername": { | |
| "type": "string" | |
| }, | |
| "oldUserStatus": { | |
| "type": "string", | |
| "enum": [ | |
| "ACTIVE", | |
| "INACTIVE", | |
| "DELETED" | |
| ] | |
| }, | |
| "associationLevel": { | |
| "type": "string", | |
| "enum": [ | |
| "ALL", | |
| "PARTIAL", | |
| "NONE" | |
| ] | |
| }, | |
| "groups": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Group" | |
| } | |
| }, | |
| "externallyManaged": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "authorities": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/GrantedAuthority" | |
| } | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "enabled": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "credentialsNonExpired": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "accountNonExpired": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "accountNonLocked": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "ValidatorDisplayDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The validator id associated with the view prompt." | |
| }, | |
| "displayName": { | |
| "type": "string", | |
| "description": "The display name associated with the view prompt." | |
| } | |
| }, | |
| "description": "The validator associated with the view prompt." | |
| }, | |
| "DatabaseTableDTO": { | |
| "type": "object", | |
| "properties": { | |
| "databaseConnectionId": { | |
| "type": "string", | |
| "description": "The database connection id." | |
| }, | |
| "schemaName": { | |
| "type": "string", | |
| "description": "The schema name in the database." | |
| }, | |
| "tableName": { | |
| "type": "string", | |
| "description": "The table name in the database." | |
| } | |
| }, | |
| "description": "The definition of the database schema and tables within that schema." | |
| }, | |
| "LineChartDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/ChartDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "INTERNAL", | |
| "STANDARD" | |
| ] | |
| }, | |
| "isLocked": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "lockOwner": { | |
| "type": "string" | |
| }, | |
| "lockOwnerFirstName": { | |
| "type": "string" | |
| }, | |
| "lockOwnerLastName": { | |
| "type": "string" | |
| }, | |
| "dateModified": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "properties": { | |
| "$ref": "#/definitions/ChartablePropertiesDTO" | |
| }, | |
| "datasourceId": { | |
| "type": "string" | |
| }, | |
| "datasourceName": { | |
| "type": "string" | |
| }, | |
| "datasourceParameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DatasourceArgumentDTO" | |
| } | |
| }, | |
| "refreshInterval": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "isValid": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "variables": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartVariableDTO" | |
| } | |
| }, | |
| "datasourceInputs": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartDatasourceInputDTO" | |
| } | |
| }, | |
| "dashboardCount": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "overrideErrorsOnSave": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "chartType": { | |
| "type": "string", | |
| "enum": [ | |
| "AREA", | |
| "BAR", | |
| "LINE", | |
| "MIXED", | |
| "PIE", | |
| "GAUGE", | |
| "TEXT", | |
| "TABLE" | |
| ] | |
| }, | |
| "labelColumn": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| }, | |
| "seriesColumn": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| }, | |
| "dataColumns": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ChartColumnDTO" | |
| } | |
| } | |
| }, | |
| "description": "A line chart." | |
| } | |
| ] | |
| }, | |
| "PermissionClassification": { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "permissions": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/Permission" | |
| } | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "DocumentDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "xml": { | |
| "name": "result" | |
| }, | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/DocumentDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "DatasourceDashboardInputDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/DashboardInputDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DashboardInput." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The input name, must be unique per dashboard." | |
| }, | |
| "value": { | |
| "type": "object" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of input.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "DASHBOARD_PROMPT" | |
| ] | |
| }, | |
| "dashboardId": { | |
| "type": "string", | |
| "description": "The ID of the dashboard that owns this input." | |
| }, | |
| "dashboardName": { | |
| "type": "string", | |
| "description": "The name of the dashboard that owns this input." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The ID of the datasource used by this input." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "The name of the datasource used by this input." | |
| }, | |
| "datasourceResults": { | |
| "type": "array", | |
| "description": "The results from executing the datasource.", | |
| "items": { | |
| "$ref": "#/definitions/DataValue" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "responsibilityMapping": { | |
| "type": "array", | |
| "description": "The responsibility mapping for executing dependent inputs.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "dashboardInputDatasourceInputs": { | |
| "type": "array", | |
| "description": "The inputs needed for the datasource for this input.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardInputDatasourceInputDTO" | |
| } | |
| } | |
| }, | |
| "description": "A hidden datasource input." | |
| } | |
| ] | |
| }, | |
| "BatchNameConfigurationDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "The ID of this configuration property." | |
| }, | |
| "included": { | |
| "type": "boolean", | |
| "description": "Whether this configuration part is included in batch names.", | |
| "default": false | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of this configuration part." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The order in which this configuration part appears in the batch name, if included." | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "A custom value used as the portion of the batch name (applies to static text only)." | |
| } | |
| }, | |
| "description": "Represents the configuration for a single part of batch names." | |
| }, | |
| "RetentionPolicyDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "xml": { | |
| "name": "result" | |
| }, | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/RetentionPolicyDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged collection of search results for some entity." | |
| }, | |
| "GroupedDashboardDTO": { | |
| "type": "object", | |
| "properties": { | |
| "items": { | |
| "type": "array", | |
| "description": "The collection of items.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardDTO" | |
| } | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "The group name." | |
| } | |
| }, | |
| "description": "A generic object that holds a collection of grouped items to be returned via JSON. Generally used when retrieving items in conjunction with a Kendo DataSource grouped by a String name." | |
| }, | |
| "ChartDatasourceInputDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of this item." | |
| }, | |
| "datasourceInputId": { | |
| "type": "string", | |
| "description": "The ID of the DatasourceInput." | |
| }, | |
| "datasourceInputName": { | |
| "type": "string", | |
| "description": "The name of the input to the datasource." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "The name of the datasource used by the chart." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The ID of the datasource used by the chart." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type of the input to the datasource.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of the input given to the datasource.", | |
| "enum": [ | |
| "STATIC", | |
| "VARIABLE" | |
| ] | |
| }, | |
| "value": { | |
| "type": "string", | |
| "description": "The static value to pass to the datasource." | |
| }, | |
| "variableName": { | |
| "type": "string", | |
| "description": "The name of the variable to pass to the datasource." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this input should be deleted.", | |
| "default": false | |
| } | |
| }, | |
| "description": "A required input to the datasource used by a chart." | |
| }, | |
| "FormControlValidatorDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "formControlStepId": { | |
| "type": "string" | |
| }, | |
| "formControlStepName": { | |
| "type": "string" | |
| }, | |
| "validatorId": { | |
| "type": "string" | |
| }, | |
| "validatorName": { | |
| "type": "string" | |
| }, | |
| "validator": { | |
| "$ref": "#/definitions/ValidatorDTO" | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| }, | |
| "WsdlUrlDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the webservice." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name of the webservice." | |
| }, | |
| "url": { | |
| "type": "string", | |
| "description": "The url of the webservice." | |
| }, | |
| "username": { | |
| "type": "string", | |
| "description": "The username of the webservice." | |
| }, | |
| "password": { | |
| "type": "string", | |
| "description": "The password of the webservice." | |
| } | |
| }, | |
| "description": "A representation of the wsdl url object that can be applied to get requests." | |
| }, | |
| "ExporterServerDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the exporter server" | |
| }, | |
| "serverName": { | |
| "type": "string", | |
| "description": "The servername of the exporter server" | |
| }, | |
| "port": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The port of the exporter server" | |
| }, | |
| "isSecureHttp": { | |
| "type": "boolean", | |
| "description": "Flag indicating exporter server url is secure", | |
| "default": false | |
| }, | |
| "url": { | |
| "type": "string", | |
| "description": "The url of the exporter server" | |
| } | |
| }, | |
| "description": "Configuration details for an exporter server." | |
| }, | |
| "DocumentTypeGroupDTOSearchResult": { | |
| "type": "object", | |
| "properties": { | |
| "results": { | |
| "type": "array", | |
| "xml": { | |
| "name": "result" | |
| }, | |
| "description": "The current page of results.", | |
| "items": { | |
| "$ref": "#/definitions/DocumentTypeGroupDTO" | |
| } | |
| }, | |
| "maxResults": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The maximum number of results to return." | |
| }, | |
| "startIndex": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The starting index." | |
| }, | |
| "totalAvailable": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of available results." | |
| }, | |
| "moreDataAvailable": { | |
| "type": "boolean", | |
| "description": "Whether more data is available but not visible given the current paging criteria.", | |
| "default": false | |
| }, | |
| "pageNum": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The current page number." | |
| }, | |
| "totalPages": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The total number of pages." | |
| } | |
| }, | |
| "description": "A paged result for document type group assignments." | |
| }, | |
| "SearchStoredProcedureParameter": { | |
| "type": "object", | |
| "required": [ | |
| "mode", | |
| "name", | |
| "searchStoredProcedure", | |
| "type" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "searchStoredProcedure": { | |
| "$ref": "#/definitions/SearchStoredProcedure" | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "minimum": 0 | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "mode": { | |
| "type": "string", | |
| "enum": [ | |
| "IN", | |
| "OUT", | |
| "INOUT", | |
| "RESULT", | |
| "RETURN", | |
| "UNKNOWN" | |
| ] | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "INTEGER", | |
| "NUMBER", | |
| "SMALLINT", | |
| "BIGINT", | |
| "TINYINT", | |
| "BOOLEAN", | |
| "BIT", | |
| "DATE", | |
| "TIME", | |
| "TIMESTAMP", | |
| "DOUBLE", | |
| "FLOAT", | |
| "DECIMAL", | |
| "NUMERIC", | |
| "REAL", | |
| "VARCHAR", | |
| "LONGVARCHAR", | |
| "CHAR", | |
| "BLOB", | |
| "CLOB", | |
| "NCLOB", | |
| "NVARCHAR", | |
| "NCHAR", | |
| "LONGNVARCHAR", | |
| "SQLXML", | |
| "STRING", | |
| "ARRAY", | |
| "BINARY", | |
| "DATALINK", | |
| "DISTINCT", | |
| "JAVA_OBJECT", | |
| "NULL", | |
| "REF", | |
| "STRUCT", | |
| "VARBINARY", | |
| "LONGVARBINARY", | |
| "ROWID", | |
| "UNKNOWN" | |
| ] | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| "validationFields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "FaxIntegrationPluginDTO": { | |
| "type": "object", | |
| "required": [ | |
| "configurationSpecs", | |
| "type" | |
| ], | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "description": "The name/type of the Fax plugin." | |
| }, | |
| "configurationSpecs": { | |
| "type": "array", | |
| "description": "The required configuration fields for the fax plugin.", | |
| "items": { | |
| "$ref": "#/definitions/DeviceConfigurationSpecDTO" | |
| } | |
| } | |
| }, | |
| "description": "A plugin DTO that defines the configuration options for a type of Fax service." | |
| }, | |
| "FormStepDTO": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "Gets the id attribute of the FormStepDTO object." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "Gets the name attribute of the FormStepDTO object." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Gets the ordinal attribute of the FormStepDTO object." | |
| }, | |
| "formId": { | |
| "type": "string", | |
| "description": "Gets the formId attribute of the FormStepDTO object." | |
| }, | |
| "deleted": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| }, | |
| "description": "DTO object for a Form Step." | |
| }, | |
| "StaticDashboardInputDTO": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/DashboardInputDTO" | |
| }, | |
| { | |
| "type": "object", | |
| "required": [ | |
| "name" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The ID of the DashboardInput." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The input name, must be unique per dashboard." | |
| }, | |
| "value": { | |
| "type": "object" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "description": "The type of input.", | |
| "enum": [ | |
| "DATASOURCE", | |
| "STATIC", | |
| "MACRO", | |
| "DASHBOARD_PROMPT" | |
| ] | |
| }, | |
| "dashboardId": { | |
| "type": "string", | |
| "description": "The ID of the dashboard that owns this input." | |
| }, | |
| "dashboardName": { | |
| "type": "string", | |
| "description": "The name of the dashboard that owns this input." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type.", | |
| "enum": [ | |
| "STRING", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "BOOLEAN", | |
| "STRING_ARRAY", | |
| "DATE_ARRAY", | |
| "DECIMAL_ARRAY", | |
| "INTEGER_ARRAY", | |
| "BOOLEAN_ARRAY" | |
| ] | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal." | |
| }, | |
| "datasourceId": { | |
| "type": "string", | |
| "description": "The ID of the datasource used by this input." | |
| }, | |
| "datasourceName": { | |
| "type": "string", | |
| "description": "The name of the datasource used by this input." | |
| }, | |
| "datasourceResults": { | |
| "type": "array", | |
| "description": "The results from executing the datasource.", | |
| "items": { | |
| "$ref": "#/definitions/DataValue" | |
| } | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Whether this item should be deleted.", | |
| "default": false | |
| }, | |
| "responsibilityMapping": { | |
| "type": "array", | |
| "description": "The responsibility mapping for executing dependent inputs.", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "dashboardInputDatasourceInputs": { | |
| "type": "array", | |
| "description": "The inputs needed for the datasource for this input.", | |
| "items": { | |
| "$ref": "#/definitions/DashboardInputDatasourceInputDTO" | |
| } | |
| }, | |
| "staticType": { | |
| "type": "string", | |
| "description": "The type of static input.", | |
| "enum": [ | |
| "BOOLEAN", | |
| "DATE", | |
| "DECIMAL", | |
| "INTEGER", | |
| "STRING" | |
| ] | |
| } | |
| }, | |
| "description": "A static hidden input to a dashboard." | |
| } | |
| ] | |
| }, | |
| "ClipboardEmailActionDTO": { | |
| "type": "object", | |
| "properties": { | |
| "to": { | |
| "type": "string", | |
| "description": "The to address field." | |
| }, | |
| "cc": { | |
| "type": "string", | |
| "description": "The CC field." | |
| }, | |
| "bcc": { | |
| "type": "string", | |
| "description": "The BCC field." | |
| }, | |
| "from": { | |
| "type": "string", | |
| "description": "The from field." | |
| }, | |
| "subject": { | |
| "type": "string", | |
| "description": "The subject field." | |
| }, | |
| "body": { | |
| "type": "string", | |
| "description": "The email body." | |
| }, | |
| "documentIds": { | |
| "type": "array", | |
| "description": "One or more document IDs that were attached to the email.", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "description": "An object that represents an email item that contains one or more clipboard documents." | |
| }, | |
| "PropertyDTO": { | |
| "type": "object", | |
| "discriminator": "_class", | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "The id of the property." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "description": "The name associated with the property." | |
| }, | |
| "ordinal": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The ordinal associated with the property." | |
| }, | |
| "field": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The field associated with the property." | |
| }, | |
| "dataType": { | |
| "type": "string", | |
| "description": "The data type associated with the property." | |
| }, | |
| "textCase": { | |
| "type": "string", | |
| "description": "The text case associated with the property." | |
| }, | |
| "trim": { | |
| "type": "boolean", | |
| "description": "Flag indicating the property value needs to be trimmed.", | |
| "default": false | |
| }, | |
| "defaultValue": { | |
| "type": "string", | |
| "description": "The default value of the property." | |
| }, | |
| "format": { | |
| "type": "string", | |
| "description": "The date format associated with the property." | |
| }, | |
| "markedForDelete": { | |
| "type": "boolean", | |
| "description": "Flag indicating the property is marked for deletion.", | |
| "default": false | |
| } | |
| }, | |
| "description": "A property used in an importer." | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment