Revision 985
Added by berkley over 22 years ago
| metacatapi.html | ||
|---|---|---|
| 204 | 204 |
</td> |
| 205 | 205 |
<td>Test the protocol handlers installed for metacat:// URLs.</td> |
| 206 | 206 |
</tr> |
| 207 |
<tr> |
|
| 208 |
<td>export</td> |
|
| 209 |
<td> |
|
| 210 |
<li>docid - the docid of the package you wish to export</li> |
|
| 211 |
</td> |
|
| 212 |
<td> |
|
| 213 |
Exports a data package in a zip file. |
|
| 214 |
</td> |
|
| 215 |
</tr> |
|
| 207 | 216 |
</table> |
| 208 | 217 |
|
| 209 |
<!-- |
|
| 210 |
<TABLE border=1 width=700> |
|
| 211 |
<TR> |
|
| 212 |
<TH WIDTH="50%">Metacat Server Interface functions</TH> |
|
| 213 |
<TH WIDTH="50%">Parameter list</TH> |
|
| 214 |
<TR> |
|
| 215 |
<TD><small>Structured query search through Metacat DB </TD> |
|
| 216 |
<TD><small>action=squery <br> |
|
| 217 |
query <br> |
|
| 218 |
returndoc <br> |
|
| 219 |
username <br> |
|
| 220 |
groupname </TD> |
|
| 221 |
<TR> |
|
| 222 |
<TD><small>Structured query search. Query parts provided in the parameter |
|
| 223 |
list </TD> |
|
| 224 |
<TD><small>action=query <br> |
|
| 225 |
meta_file_id <br> |
|
| 226 |
querytitle <br> |
|
| 227 |
doctype <br> |
|
| 228 |
returnfield <br> |
|
| 229 |
operator <br> |
|
| 230 |
casesensitive <br> |
|
| 231 |
searchmode <br> |
|
| 232 |
anyfield </TD> |
|
| 233 |
<TR> |
|
| 234 |
<TD><small> Read XML document from Metacat DB, transform into qformat |
|
| 235 |
and return it </TD> |
|
| 236 |
<TD><small> action=read <br> |
|
| 237 |
docid <br> |
|
| 238 |
qformat </TD> |
|
| 239 |
<TR> |
|
| 240 |
<TD><small> Read XML document <br> |
|
| 241 |
- from Metacat DB if url=Metacat://... <br> |
|
| 242 |
- from Internet if url=http:// <br> |
|
| 243 |
Transform into qformat and return it </TD> |
|
| 244 |
<TD><small> action=read <br> |
|
| 245 |
docid <br> |
|
| 246 |
qformat </TD> |
|
| 247 |
<TR> |
|
| 248 |
<TD><small> Read abstract data of a document and return it </TD> |
|
| 249 |
<TD><small> action=getabstract <br> |
|
| 250 |
abstractpath <br> |
|
| 251 |
docid </TD> |
|
| 252 |
<TR> |
|
| 253 |
<TD><small> Write XML document into Metacat DB </TD> |
|
| 254 |
<TD><small> action=insert <br> |
|
| 255 |
docid <br> |
|
| 256 |
doctext <br> |
|
| 257 |
username <br> |
|
| 258 |
groupname </TD> |
|
| 259 |
<TR> |
|
| 260 |
<TD><small> Modify existing in Metacat Db XML document with new content |
|
| 261 |
provided </TD> |
|
| 262 |
<TD><small> action=update <br> |
|
| 263 |
docid <br> |
|
| 264 |
doctext <br> |
|
| 265 |
username <br> |
|
| 266 |
groupname </TD> |
|
| 267 |
<TR> |
|
| 268 |
<TD><small> Delete existing in Metacat Db XML document </TD> |
|
| 269 |
<TD><small> action=delete <br> |
|
| 270 |
docid <br> |
|
| 271 |
username <br> |
|
| 272 |
groupname </TD> |
|
| 273 |
<TR> |
|
| 274 |
<TD><small> Validate XML document </TD> |
|
| 275 |
<TD><small> action=validate <br> |
|
| 276 |
docid <br> |
|
| 277 |
valtext <br> |
|
| 278 |
username <br> |
|
| 279 |
groupname </TD> |
|
| 280 |
<TR> |
|
| 281 |
<TD><small> Read XML document from Metacat Db and related documents if |
|
| 282 |
they exist and return them in zip file </TD> |
|
| 283 |
<TD><small> action=getdatadoc <br> |
|
| 284 |
docid <br> |
|
| 285 |
relation </TD> |
|
| 286 |
<TR> |
|
| 287 |
<TD><small> Read all different document types currently available in |
|
| 288 |
Metacat Db </TD> |
|
| 289 |
<TD><small> action=getdoctypes </TD> |
|
| 290 |
<TR> |
|
| 291 |
<TD><small> Read Data Guide for specified doctype </TD> |
|
| 292 |
<TD><small> action=getdataguide <br> |
|
| 293 |
doctype </TD> |
|
| 294 |
<TR> |
|
| 295 |
<TD><small> Login to Metacat Server </TD> |
|
| 296 |
<TD><small> action=login <br> |
|
| 297 |
username <br> |
|
| 298 |
password </TD> |
|
| 299 |
<TR> |
|
| 300 |
<TD><small> Logout from Metacat Server </TD> |
|
| 301 |
<TD><small> action=logout </TD> |
|
| 302 |
</TABLE> |
|
| 303 |
|
|
| 304 |
<P><b>HTTP parameters for Metacat Server </b> |
|
| 305 |
<TABLE border=1> |
|
| 306 |
<TR> |
|
| 307 |
<TH>Name</TH> |
|
| 308 |
<TH>Value</TH> |
|
| 309 |
<TR> |
|
| 310 |
<TD VALIGN=TOP> action</TD> |
|
| 311 |
<TD> squery <br> |
|
| 312 |
query <br> |
|
| 313 |
getdocument <br> |
|
| 314 |
getrelateddocument <br> |
|
| 315 |
getabstract <br> |
|
| 316 |
insert <br> |
|
| 317 |
update <br> |
|
| 318 |
delete <br> |
|
| 319 |
validate <br> |
|
| 320 |
getdatadoc <br> |
|
| 321 |
getdoctypes <br> |
|
| 322 |
getdataguide <br> |
|
| 323 |
login <br> |
|
| 324 |
logout </TD> |
|
| 325 |
<TR> |
|
| 326 |
<TD> query</TD> |
|
| 327 |
<TD> <i>XML text of query that conforms to pathquery.dtd</i> </TD> |
|
| 328 |
<TR> |
|
| 329 |
<TD> returndoc</TD> |
|
| 330 |
<TD> <i>array of doctypes to backtrack against</i> </TD> |
|
| 331 |
<TR> |
|
| 332 |
<TD> doctype</TD> |
|
| 333 |
<TD> <i>document type list</i> </TD> |
|
| 334 |
<TR> |
|
| 335 |
<TD> docid</TD> |
|
| 336 |
<TD> <i>docid of document</i></TD> |
|
| 337 |
<TR> |
|
| 338 |
<TD> doctext</TD> |
|
| 339 |
<TD> <i>XML text of document to be load into db</i> </TD> |
|
| 340 |
<TR> |
|
| 341 |
<TD> valtext</TD> |
|
| 342 |
<TD> <i>XML text of document to be validated</i> </TD> |
|
| 343 |
<TR> |
|
| 344 |
<TD> abstractpath</TD> |
|
| 345 |
<TD> <i>XML path to the abstract node to be read</i> </TD> |
|
| 346 |
<TR> |
|
| 347 |
<TD> url</TD> |
|
| 348 |
<TD> <i>URL to document. It can be of type Metacat or http</i> </TD> |
|
| 349 |
<TR> |
|
| 350 |
<TD> relation</TD> |
|
| 351 |
<TD> <i>List of URLs to documents. They can be of type Metacat or |
|
| 352 |
http</i> </TD> |
|
| 353 |
<TR> |
|
| 354 |
<TD> qformat</TD> |
|
| 355 |
<TD> xml <br> html </TD> |
|
| 356 |
<TR> |
|
| 357 |
<TD> username</TD> |
|
| 358 |
<TD> <i>username for authentication and connection to the server</i></TD> |
|
| 359 |
<TR> |
|
| 360 |
<TD> password</TD> |
|
| 361 |
<TD> <i>user's password for authentication</i> </TD> |
|
| 362 |
</TABLE> |
|
| 363 |
--> |
|
| 364 | 218 |
<br> |
| 365 | 219 |
<b><a href="./replication.html">MetacatReplication</a> Parameters</b> |
| 366 | 220 |
<table border="1"> |
Also available in: Unified diff
fixed some things for release 1.1