cowr_dict/src/main/webapp/doc/api.txt

68 lines
1.4 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

index (
pageSize optional default 20,
pageNum optional default 1,
json optional,
proj optional,
sort optional
) {
special json: {
key: $ex //exists
key: $nex //not exists
key: $revalue //模糊查询,例:$re^te te开头的value
},
proj json: {
key1: 1,
key2:0
//必须全是1或者全是0id除外
},
sort: {
key1: 'desc',
key2: 'asc'
}
return dict list json
}
show (id required) {
return dict json
}
save (json required) {
return saved dict json with id
}
update (id required, json required) {
json {
$set: {k,v...},
$unset: [k1,k2...],
$rename: {k,newK...}
}
return {result : true or false}
}
delete (id required) {
return {result: true or false}
}
@Deprecated
dict (key-value pairs) {
return dict list json
}
dictList (int pageNum default 0, int pageSize default 20) {
return dict list json
}
addDict (String name required, key-value pairs) {
return dict json
}
updateDict (String id required, String action optional, String[] keys optional) {
if (actions === 'unset') {
删除指定id的dict的指定key
return {result: true or false}
} else {
覆盖指定id的dict的指定key的对应value
return {result: true or false}
}
}
deleteDict (String id required) {
return return {result: true or false}
}