Pattern Language Network - XWiki simpleAPI
simpleAPI
The "simpleAPI" is based on REST model with only GET method enabled at this stage. The API works with Planet Wiki site only. For a more technical API please see "generic XML" API. The following parameters are allowed| Name | Value(s) | Mandatory | Description |
|---|---|---|---|
| "xpage=" | rdf or plain | YES - lower case * | Creates output file header |
| "format=aFormat" | PLML**, CSV, XML, RSS. | Default is RSS; | |
| "subject=" | Patterns or Cases | Default is Patterns; Search for Patterns or Case Studies | |
| "text=someText" | Search for "someText" in the whole pattern (or case studies) document; | ||
| "problem=someText" | Search for "someText" in the problem section of every pattern document; | ||
| "context=someText" | Search for "someText" in the context section of every pattern document; | ||
| "solution=someText" | Search for "someText" in the solution section of every pattern document; | ||
| "rationale=someText" | Search for "someText" in the the rationale section of every pattern document; | ||
| "listonly=true" | Returns a list of patter names (or case studies) held in the database *** ; |
http://patternlanguagenetwork.myxwiki.org/xwiki/bin/view/api/simple Example:
- outputs patterns in RSS format, where "coherent" string is found in any part of a pattern.
- outputs patterns in PLML format, where Solution contains "participants" OR Problem contains "coherent" string.
- Value plain required for CSV output format, for all other formats use rdf.
- *Other output formats in the future (Microformat) .
- **PLML - http://www.hcipatterns.org/PLML+1.0.html .
- *** "listOnly=true" has precedence over other parameters (except xpage) therefore if submitted with "listOnly", all other parameters will be ignored.
- CSV and XML return all information available on Patterns or Case Studies.
- CSV uses a pipe "|" as a common delimiter.
