http://www.xmlpipe.org/xpe/ims/resource/upload

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
baseDir String false Default to 'resources'
cacheSize int false Default to '1024'
defaultSearch String false Default search param and value if no search parameters are supplied
dict String false Default to 'id,username,path,filename,mime,created:t,lastUpdated:t,size:l,access:b,oid'
facetFields String false list of fields that will be used for faceted search
facetHierarchy String false list of fields that form the faceted hierarchy, should not exceed 3
fields String false Default to 'id,username,filename,oid'
filters String false Default to ''
fulltext String false list of fields that require full text search Default to ''
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
hierarchy String false Default to ''
imagesDir String false the dir to store images Default to 'images'
initCapacity int false Default to '1024'
limit int false Default limit Default to '10'
mask String false List of fields to be shown
maxJoinSize int false Default to '32'
maxRequestSize int false Maximum request size Default to '65536'
maxSearchValueSize int false The maximum search field value size, default to 1024 Default to '1024'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
ownerOnly boolean false Default to 'false'
primaryKey String false Default to 'id'
queryFilter String false list params allowed separated by ','. Empty value will filter out all params. Wildcard '*' will allow all params. Default to '*'
recAccess String false Access policy for records Default to 'rwrwr-'
recordSize int false Default to '65536'
requireSession boolean false Default to 'false'
resolve String false resolve a foreign key into a json object
resourceDir String false Default to 'resources'
reverse boolean false If set to true, reverse the listing order Default to 'false'
securityPolicy int false Default to '0'
seqKey boolean false Default to 'true'
size int false The maximum size of each record Default to '1048576'
sorted String false list of fields that require sorted indexes, fields appear here should not appear in fields Default to ''
start int false The start index of search result Default to '-1'
startingId int false Default to '0'
store String false Default to 'ims_resources.db'
storeType String false Default to 'binary'
top String false top field, the field must be numeric
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/ims/resource/update

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
dict String false dictionary for binary store, required for binary store
facetFields String false list of fields that will be used for faceted search
facetHierarchy String false list of fields that form the faceted hierarchy, should not exceed 3
fields String true list fields that require inverted indexes
filters String false Default to ''
fulltext String false list of fields that require full text search Default to ''
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
hierarchy String false Default to ''
mask String false List of fields to be shown
maxJoinSize int false Default to '32'
maxRequestSize int false Maximum request size Default to '65536'
maxSearchValueSize int false The maximum search field value size, default to 1024 Default to '1024'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
primaryKey String true The primary key of the db, records with the same key will be overwritten
recAccess String false Access policy for records Default to 'rwrwr-'
recordSize int false Default to '65536'
resolve String false resolve a foreign key into a json object
seqKey boolean false If set to true, will use sequntail key indexer Default to 'false'
size int false The maximum size of each record Default to '1048576'
sorted String false list of fields that require sorted indexes, fields appear here should not appear in fields Default to ''
startingId int false Default to '0'
store String true The name of the store
storeType String false Default to 'binary'
top String false top field, the field must be numeric
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/ims/resource/get

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
baseDir String false Default to 'resources'
cacheSize int false Default to '1024'
defaultSearch String false Default search param and value if no search parameters are supplied
dict String false Default to 'id,username,path,filename,mime,created:t,lastUpdated:t,size:l,access:b,oid'
facetFields String false list of fields that will be used for faceted search
facetHierarchy String false list of fields that form the faceted hierarchy, should not exceed 3
fields String false Default to 'id,username,filename,oid'
filters String false Default to ''
fulltext String false list of fields that require full text search Default to ''
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
hierarchy String false Default to ''
imagesDir String false the dir to store images Default to 'images'
initCapacity int false Default to '1024'
limit int false Default limit Default to '10'
mask String false List of fields to be shown
maxJoinSize int false Default to '32'
maxRequestSize int false Maximum request size Default to '65536'
maxSearchValueSize int false The maximum search field value size, default to 1024 Default to '1024'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
ownerOnly boolean false Default to 'false'
primaryKey String false Default to 'id'
queryFilter String false list params allowed separated by ','. Empty value will filter out all params. Wildcard '*' will allow all params. Default to '*'
recAccess String false Access policy for records Default to 'rwrwr-'
recordSize int false Default to '65536'
requireSession boolean false Default to 'false'
resolve String false resolve a foreign key into a json object
resourceDir String false Default to 'resources'
reverse boolean false If set to true, reverse the listing order Default to 'false'
securityPolicy int false Default to '0'
seqKey boolean false Default to 'true'
size int false The maximum size of each record Default to '1048576'
sorted String false list of fields that require sorted indexes, fields appear here should not appear in fields Default to ''
start int false The start index of search result Default to '-1'
startingId int false Default to '0'
store String false Default to 'ims_resources.db'
storeType String false Default to 'binary'
top String false top field, the field must be numeric
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/ims/resource/view

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
baseDir String false Default to 'resources'
cacheSize int false Default to '1024'
defaultSearch String false Default search param and value if no search parameters are supplied
dict String false Default to 'id,username,path,filename,mime,created:t,lastUpdated:t,size:l,access:b,oid'
facetFields String false list of fields that will be used for faceted search
facetHierarchy String false list of fields that form the faceted hierarchy, should not exceed 3
fields String false Default to 'id,username,filename,oid'
filters String false Default to ''
fulltext String false list of fields that require full text search Default to ''
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
hierarchy String false Default to ''
imagesDir String false the dir to store images Default to 'images'
initCapacity int false Default to '1024'
limit int false Default limit Default to '10'
mask String false List of fields to be shown
maxJoinSize int false Default to '32'
maxRequestSize int false Maximum request size Default to '65536'
maxSearchValueSize int false The maximum search field value size, default to 1024 Default to '1024'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
ownerOnly boolean false Default to 'false'
primaryKey String false Default to 'id'
queryFilter String false list params allowed separated by ','. Empty value will filter out all params. Wildcard '*' will allow all params. Default to '*'
recAccess String false Access policy for records Default to 'rwrwr-'
recordSize int false Default to '65536'
requireSession boolean false Default to 'false'
resolve String false resolve a foreign key into a json object
resourceDir String false Default to 'resources'
reverse boolean false If set to true, reverse the listing order Default to 'false'
securityPolicy int false Default to '0'
seqKey boolean false Default to 'true'
size int false The maximum size of each record Default to '1048576'
sorted String false list of fields that require sorted indexes, fields appear here should not appear in fields Default to ''
start int false The start index of search result Default to '-1'
startingId int false Default to '0'
store String false Default to 'ims_resources.db'
storeType String false Default to 'binary'
top String false top field, the field must be numeric
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/ims/resource/search

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
cacheSize int false Default to '1024'
defaultSearch String false Default search param and value if no search parameters are supplied
dict String false dictionary for binary store, required for binary store
facetFields String false list of fields that will be used for faceted search
facetHierarchy String false list of fields that form the faceted hierarchy, should not exceed 3
fields String true list fields that require inverted indexes
filters String false Default to ''
fulltext String false list of fields that require full text search Default to ''
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
hierarchy String false Default to ''
initCapacity int false Default to '1024'
limit int false Default limit Default to '10'
mask String false List of fields to be shown
maxJoinSize int false Default to '32'
maxSearchValueSize int false The maximum search field value size, default to 1024 Default to '1024'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
ownerOnly boolean false Default to 'false'
queryFilter String false list params allowed separated by ','. Empty value will filter out all params. Wildcard '*' will allow all params. Default to '*'
recAccess String false Access policy for records Default to 'rwrwr-'
recordSize int false Default to '65536'
resolve String false resolve a foreign key into a json object
reverse boolean false If set to true, reverse the listing order Default to 'false'
size int false The maximum size of each record Default to '1048576'
sorted String false list of fields that require sorted indexes, fields appear here should not appear in fields Default to ''
start int false The start index of search result Default to '-1'
store String true The name of the store
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
top String false top field, the field must be numeric
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/ims/resource/del

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
baseDir String false Default to 'resources'
cacheSize int false Default to '1024'
defaultSearch String false Default search param and value if no search parameters are supplied
dict String false Default to 'id,username,path,filename,mime,created:t,lastUpdated:t,size:l,access:b,oid'
facetFields String false list of fields that will be used for faceted search
facetHierarchy String false list of fields that form the faceted hierarchy, should not exceed 3
fields String false Default to 'id,username,filename,oid'
filters String false Default to ''
fulltext String false list of fields that require full text search Default to ''
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
hierarchy String false Default to ''
imagesDir String false the dir to store images Default to 'images'
initCapacity int false Default to '1024'
limit int false Default limit Default to '10'
mask String false List of fields to be shown
maxJoinSize int false Default to '32'
maxRequestSize int false Maximum request size Default to '65536'
maxSearchValueSize int false The maximum search field value size, default to 1024 Default to '1024'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
ownerOnly boolean false Default to 'false'
primaryKey String false Default to 'id'
queryFilter String false list params allowed separated by ','. Empty value will filter out all params. Wildcard '*' will allow all params. Default to '*'
recAccess String false Access policy for records Default to 'rwrwr-'
recordSize int false Default to '65536'
requireSession boolean false Default to 'false'
resolve String false resolve a foreign key into a json object
resourceDir String false Default to 'resources'
reverse boolean false If set to true, reverse the listing order Default to 'false'
securityPolicy int false Default to '0'
seqKey boolean false Default to 'true'
size int false The maximum size of each record Default to '1048576'
sorted String false list of fields that require sorted indexes, fields appear here should not appear in fields Default to ''
start int false The start index of search result Default to '-1'
startingId int false Default to '0'
store String false Default to 'ims_resources.db'
storeType String false Default to 'binary'
top String false top field, the field must be numeric
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/ims/upload

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
baseDir String false Default to 'resources'
cacheSize int false Default to '1024'
defaultSearch String false Default search param and value if no search parameters are supplied
dict String false Default to 'id,username,path,filename,mime,created:t,lastUpdated:t,size:l,access:b,oid'
facetFields String false list of fields that will be used for faceted search
facetHierarchy String false list of fields that form the faceted hierarchy, should not exceed 3
fields String false Default to 'id,username,filename,oid'
filters String false Default to ''
fulltext String false list of fields that require full text search Default to ''
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
hierarchy String false Default to ''
imagesDir String false the dir to store images Default to 'images'
initCapacity int false Default to '1024'
limit int false Default limit Default to '10'
mask String false List of fields to be shown
maxJoinSize int false Default to '32'
maxRequestSize int false Maximum request size Default to '65536'
maxSearchValueSize int false The maximum search field value size, default to 1024 Default to '1024'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
ownerOnly boolean false Default to 'false'
primaryKey String false Default to 'id'
queryFilter String false list params allowed separated by ','. Empty value will filter out all params. Wildcard '*' will allow all params. Default to '*'
recAccess String false Access policy for records Default to 'rwrwr-'
recordSize int false Default to '65536'
requireSession boolean false Default to 'false'
resolve String false resolve a foreign key into a json object
resourceDir String false Default to 'resources'
reverse boolean false If set to true, reverse the listing order Default to 'false'
securityPolicy int false Default to '0'
seqKey boolean false Default to 'true'
size int false The maximum size of each record Default to '1048576'
sorted String false list of fields that require sorted indexes, fields appear here should not appear in fields Default to ''
start int false The start index of search result Default to '-1'
startingId int false Default to '0'
store String false Default to 'ims_resources.db'
storeType String false Default to 'binary'
top String false top field, the field must be numeric
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/ims/update

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
cacheSize int false Default to '1024'
defaultSearch String false Default search param and value if no search parameters are supplied
dict String false Default to 'id,mime,desc,size:i'
facetFields String false list of fields that will be used for faceted search
facetHierarchy String false list of fields that form the faceted hierarchy, should not exceed 3
fields String false Default to 'id'
filters String false Default to ''
fulltext String false list of fields that require full text search Default to ''
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
hierarchy String false Default to ''
imagesDir String false the dir to store images Default to 'images'
initCapacity int false Default to '1024'
limit int false Default limit Default to '10'
mask String false List of fields to be shown
maxJoinSize int false Default to '32'
maxSearchValueSize int false The maximum search field value size, default to 1024 Default to '1024'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
ownerOnly boolean false Default to 'false'
primaryKey String false Default to 'id'
queryFilter String false list params allowed separated by ','. Empty value will filter out all params. Wildcard '*' will allow all params. Default to '*'
recAccess String false Access policy for records Default to 'rwrwr-'
recordSize int false Default to '65536'
resolve String false resolve a foreign key into a json object
reverse boolean false If set to true, reverse the listing order Default to 'false'
seqKey boolean false Default to 'true'
size int false The maximum size of each record Default to '1048576'
sorted String false list of fields that require sorted indexes, fields appear here should not appear in fields Default to ''
start int false The start index of search result Default to '-1'
startingId int false Default to '0'
store String false Default to 'ims.db'
storeType String false Default to 'binary'
top String false top field, the field must be numeric
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/ims/search

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
cacheSize int false Default to '1024'
defaultSearch String false Default search param and value if no search parameters are supplied
dict String false dictionary for binary store, required for binary store
facetFields String false list of fields that will be used for faceted search
facetHierarchy String false list of fields that form the faceted hierarchy, should not exceed 3
fields String true list fields that require inverted indexes
filters String false Default to ''
fulltext String false list of fields that require full text search Default to ''
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
hierarchy String false Default to ''
initCapacity int false Default to '1024'
limit int false Default limit Default to '10'
mask String false List of fields to be shown
maxJoinSize int false Default to '32'
maxSearchValueSize int false The maximum search field value size, default to 1024 Default to '1024'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
ownerOnly boolean false Default to 'false'
queryFilter String false list params allowed separated by ','. Empty value will filter out all params. Wildcard '*' will allow all params. Default to '*'
recAccess String false Access policy for records Default to 'rwrwr-'
recordSize int false Default to '65536'
resolve String false resolve a foreign key into a json object
reverse boolean false If set to true, reverse the listing order Default to 'false'
size int false The maximum size of each record Default to '1048576'
sorted String false list of fields that require sorted indexes, fields appear here should not appear in fields Default to ''
start int false The start index of search result Default to '-1'
store String true The name of the store
storeType String false choose between 'json' or 'binary', default to 'json' Default to 'json'
top String false top field, the field must be numeric
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/ims/get

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
cacheSize int false Default to '1024'
defaultSearch String false Default search param and value if no search parameters are supplied
dict String false Default to 'id,mime,desc,size:i'
facetFields String false list of fields that will be used for faceted search
facetHierarchy String false list of fields that form the faceted hierarchy, should not exceed 3
fields String false Default to 'id'
filters String false Default to ''
fulltext String false list of fields that require full text search Default to ''
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
hierarchy String false Default to ''
imagesDir String false the dir to store images Default to 'images'
initCapacity int false Default to '1024'
limit int false Default limit Default to '10'
mask String false List of fields to be shown
maxJoinSize int false Default to '32'
maxSearchValueSize int false The maximum search field value size, default to 1024 Default to '1024'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
ownerOnly boolean false Default to 'false'
primaryKey String false Default to 'id'
queryFilter String false list params allowed separated by ','. Empty value will filter out all params. Wildcard '*' will allow all params. Default to '*'
recAccess String false Access policy for records Default to 'rwrwr-'
recordSize int false Default to '65536'
resolve String false resolve a foreign key into a json object
reverse boolean false If set to true, reverse the listing order Default to 'false'
seqKey boolean false Default to 'true'
size int false The maximum size of each record Default to '1048576'
sorted String false list of fields that require sorted indexes, fields appear here should not appear in fields Default to ''
start int false The start index of search result Default to '-1'
startingId int false Default to '0'
store String false Default to 'ims.db'
storeType String false Default to 'binary'
top String false top field, the field must be numeric
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/ims/del

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
dict String false dictionary for binary store, required for binary store
facetFields String false list of fields that will be used for faceted search
facetHierarchy String false list of fields that form the faceted hierarchy, should not exceed 3
fields String true list fields that require inverted indexes
filters String false Default to ''
fulltext String false list of fields that require full text search Default to ''
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
hierarchy String false Default to ''
mask String false List of fields to be shown
maxJoinSize int false Default to '32'
maxSearchValueSize int false The maximum search field value size, default to 1024 Default to '1024'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
primaryKey String true The primary key of the db, records with the same key will be overwritten
recAccess String false Access policy for records Default to 'rwrwr-'
recordSize int false Default to '65536'
resolve String false resolve a foreign key into a json object
seqKey boolean false If set to true, will use sequntail key indexer Default to 'false'
size int false The maximum size of each record Default to '1048576'
sorted String false list of fields that require sorted indexes, fields appear here should not appear in fields Default to ''
startingId int false Default to '0'
store String true The name of the store
storeType String false Default to 'binary'
top String false top field, the field must be numeric
userStore String false Define this if access control is required

http://www.xmlpipe.org/xpe/ims/resize

Parameter Type Required Help

http://www.xmlpipe.org/xpe/ims/resized

Parameter Type Required Help
access String false Access policy Default to 'rwrwr-'
cacheSize int false Default to '1024'
defaultSearch String false Default search param and value if no search parameters are supplied
dict String false Default to 'id,mime,desc,size:i'
facetFields String false list of fields that will be used for faceted search
facetHierarchy String false list of fields that form the faceted hierarchy, should not exceed 3
fields String false Default to 'id'
filters String false Default to ''
fulltext String false list of fields that require full text search Default to ''
group String false Default to 'all'
groupField String false Is this field is present in dict, it will be automatically set Default to 'groupId'
hierarchy String false Default to ''
imagesDir String false the dir to store images Default to 'images'
initCapacity int false Default to '1024'
limit int false Default limit Default to '10'
mask String false List of fields to be shown
maxJoinSize int false Default to '32'
maxSearchValueSize int false The maximum search field value size, default to 1024 Default to '1024'
ownerField String false Is this field is present in dict, it will be automatically set Default to 'ownerId'
ownerOnly boolean false Default to 'false'
primaryKey String false Default to 'id'
queryFilter String false list params allowed separated by ','. Empty value will filter out all params. Wildcard '*' will allow all params. Default to '*'
recAccess String false Access policy for records Default to 'rwrwr-'
recordSize int false Default to '65536'
resolve String false resolve a foreign key into a json object
reverse boolean false If set to true, reverse the listing order Default to 'false'
seqKey boolean false Default to 'true'
size int false The maximum size of each record Default to '1048576'
sorted String false list of fields that require sorted indexes, fields appear here should not appear in fields Default to ''
start int false The start index of search result Default to '-1'
startingId int false Default to '0'
store String false Default to 'ims.db'
storeType String false Default to 'binary'
top String false top field, the field must be numeric
userStore String false Define this if access control is required