Create a new data table and registers it with the Mifos X Core application table.
+Field Descriptions |
+
| Mandatory - datatableName | +
| The name of the Data Table. | +
| Mandatory - apptableName | +
+ Application table name. Must be one of the following:
+
|
+
| Mandatory - columns | +
| An array of columns in the new Data Table. | +
Field Descriptions - columns |
+
| Mandatory - name | +
| Name of the created column. Can contain only alphanumeric characters, underscores and spaces, but cannot start with a number. Cannot start or end with an underscore or space. | +
| Mandatory - type | +
+ Column type. Must be one of the following:
+
|
+
| Mandatory [type = Dropdown] - code | +
| Used in Code Value fields. Column name becomes: code_cd_name. Mandatory if using type Dropdown, otherwise an error is returned. | +
| Optional - mandatory | +
| Determines whether this column must have a value in every entry. Optional, defaults to false. | +
| Mandatory [type = String] - length | +
| Length of the text field. Mandatory if type String is used, otherwise an error is returned. | +
@@ -11640,6 +11717,153 @@ GET https://DomainName/api/v1/datatables/{datatable}
Update Data Table
Modifies fields of a data table. If the apptableName parameter is passed,
data table is deregistered and registered with the new application table.
+
+
+ Field Descriptions
+
+
+ Optional - apptableName
+
+
+
+ Application table name. Only necessary if changing the application table this Data Table is registered to. Must be one of the following:
+
+ - m_client
+ - m_group
+ - m_loan
+ - m_office
+ - m_saving_account
+
+
+
+
+ Optional - dropColumns
+
+
+ An array of columns to be deleted from the Data Table.
+
+
+ Optional - addColumns
+
+
+ An array of columns to be added to the Data Table.
+
+
+ Optional - changeColumns
+
+
+ An array of columns to be changed in the Data Table.
+
+
+
+
+ Field Descriptions - dropColumns
+
+
+ Mandatory - name
+
+
+ Requires a full name of the deleted column to be provided.
+
+
+
+
+ Field Descriptions - addColumns
+
+
+ Mandatory - name
+
+
+ Name of the created column. Can contain only alphanumeric characters, underscores and spaces, but cannot start with a number. Cannot start or end with an underscore or space.
+
+
+ Mandatory - type
+
+
+
+ Column type. Must be one of the following:
+
+ - Date
+ - Decimal
+ - Dropdown
+ - Number
+ - String
+ - Text
+
+
+
+
+ Mandatory [type = Dropdown] - code
+
+
+ Used in Code Value fields. Column name becomes: code_cd_name. Mandatory if using type Dropdown, otherwise an error is returned.
+
+
+ Optional - mandatory
+
+
+ Determines whether this column must have a value in every entry. Optional, defaults to false.
+
+
+ Mandatory [type = String] - length
+
+
+ Length of the text field. Mandatory if type String is used, otherwise an error is returned.
+
+
+ Optional - after
+
+
+ Only used when re-ordering Data Table columns. Requires a full column name to be provided.
+
+
+
+
+ Field Descriptions - changeColumns
+
+
+ Mandatory - name
+
+
+ Name of the created column. Can contain only alphanumeric characters, underscores and spaces, but cannot start with a number. Cannot start or end with an underscore or space.
+
+
+ Optional - newName
+
+
+ New name of the created column. Can contain only alphanumeric characters, underscores and spaces, but cannot start with a number. Cannot start or end with an underscore or space.
+
+
+ Mandatory [type = Dropdown] - code
+
+
+ Used in Code Value fields. Column name becomes: code_cd_name. Mandatory if using type Dropdown, otherwise an error is returned.
+
+
+ Optional [type = Dropdown] - newCode
+
+
+ Used in Code Value fields. Column name becomes: code_cd_name. Optional if using type Dropdown, otherwise an error is returned.
+
+
+ Optional - mandatory
+
+
+ Determines whether this column must have a value in every entry. Optional, defaults to false.
+
+
+ Mandatory [type = String] - length
+
+
+ Length of the text field. Mandatory if type String is used, otherwise an error is returned.
+
+
+ Optional - after
+
+
+ Only used when re-ordering Data Table columns. Requires a full column name to be provided.
+
+
@@ -11652,26 +11876,31 @@ Content-Type: application/json
Request Body:
{
"apptableName": "m_client",
- "columns": [
+ "dropColumns": [
{
- "name": "Gender",
+ "name": "Gender_cd_Question"
+ }
+ ],
+ "addColumns": [
+ {
+ "name": "Question",
"type": "Dropdown",
- "code": "Gender"
- },
- {
- "name": "Some Decimal",
- "type": "Decimal",
+ "code": "Gender",
"mandatory": true
},
{
- "name": "Birth Date",
- "type": "Date"
- },
+ "name": "Some Number",
+ "type": "Number",
+ "after": "Some Field"
+ }
+ ],
+ "changeColumns": [
{
- "name": "Question 2",
- "type": "String",
- "length": 100,
- "mandatory": false
+ "name": "Question",
+ "newName": "Question 2",
+ "mandatory": true,
+ "code": "Gender",
+ "newCode": "Gender2"
}
]
}
@@ -11689,7 +11918,7 @@ Request Body:
Delete Data Table
- Deletes a data table and unregisters it from the Mifos X Core
+
Deletes a data table and deregisters it from the Mifos X Core
application table.
diff --git a/api-docs/apidocs.css b/api-docs/apidocs.css
index 4397e3b2c..31ad69dfd 100644
--- a/api-docs/apidocs.css
+++ b/api-docs/apidocs.css
@@ -724,3 +724,16 @@ strong { font-weight: bold; }
.stripe-version {
float: left;
}
+
+ul.field {
+ margin: 5px 10px;
+}
+
+ul.field li {
+ list-style: square inside none;
+ font-style: italic;
+}
+
+tt {
+ font-size: 9.5pt;
+}
\ No newline at end of file