disk.folder.getfields

disk.folder.getfields

Returns description of file fields.

• TYPE – field type;
• USE_IN_FILTER – a possibility to use a field in the data selection filtering;
• USE_IN_SHOW – specifies whether this field is available when obtaining a response.

Response example:

"result": {
     "ID": {
"TYPE": "integer",
"USE_IN_FILTER": true,
"USE_IN_SHOW": true
},
"NAME": {
"TYPE": "string",
"USE_IN_FILTER": true,
"USE_IN_SHOW": true
},
"TYPE": {
"TYPE": "enum",
"USE_IN_FILTER": true,
"USE_IN_SHOW": true
},
"CODE": {
"TYPE": "string",
"USE_IN_FILTER": true,
"USE_IN_SHOW": true
},
"STORAGE_ID": {
"TYPE": "integer",
"USE_IN_FILTER": true,
"USE_IN_SHOW": true
},
"REAL_OBJECT_ID": {
"TYPE": "integer",
"USE_IN_FILTER": false,
"USE_IN_SHOW": true
},
"PARENT_ID": {
"TYPE": "integer",
"USE_IN_FILTER": true,
"USE_IN_SHOW": true
},
"CREATE_TIME": {
"TYPE": "datetime",
"USE_IN_FILTER": true,
"USE_IN_SHOW": true
},
"UPDATE_TIME": {
"TYPE": "datetime",
"USE_IN_FILTER": true,
"USE_IN_SHOW": true
},
"DELETE_TIME": {
"TYPE": "datetime",
"USE_IN_FILTER": true,
"USE_IN_SHOW": true
},
"CREATED_BY": {
"TYPE": "integer",
"USE_IN_FILTER": false,
"USE_IN_SHOW": true
},
"UPDATED_BY": {
"TYPE": "integer",
"USE_IN_FILTER": false,
"USE_IN_SHOW": true
},
"DELETED_BY": {
"TYPE": "integer",
"USE_IN_FILTER": false,
"USE_IN_SHOW": true
},
"DELETED_TYPE": {
"TYPE": "enum",
"USE_IN_FILTER": true,
"USE_IN_SHOW": true
}
}

Parameters

This method has no parameters.

Example

BX24.callMethod(
		"disk.folder.getfields",
		{},
		function (result)
		{
			if (result.error())
				console.error(result.error());
			else
				console.dir(result.data());
		}
);